Tutorial

Installation

  • gem install site_hook

Support is only given when using the latest version unless you are explicitly trying to help develop site_hook, for helping develop site_hook, please go >here<

Setup

Create Needed Files & Directories

  • Backup any previous site_hook configs
  • Run site_hook config gen
    • This will create the following files and directories.
      • ~/.jph/
      • ~/.jph/config
      • ~/.jph/logs

Usage

Notes on Usage

  • You must at least have a ‘Gemfile’ as the jekyll command used requires it
  • Clone your site to where you want it built from
  • IMPORTANT: Run bundle install --path vendor/bundle otherwise you may get dependency errors

Generating a Project Block

To generate a project block, (using the latest version of site_hook).

  • site_hook config gen-project

This command will ask you questions and spit out an indent block to put into your ~/.jph/config file.

This command also gives you a hook password/token/secret.

  • If you don’t like the string that was generated, then you can change it once you’ve copied the rest to your config.

Start

If a configuration file has been created and/or generated(then edited correctly)… using ‘server listen’ should initiate the webhook and have it start

Multiplexer Usage

NOTE: I would suggest running the ‘listen’ command in a screen or tmux session. This is due to the output of logs and due to the fact that the gem is not a daemon.

  • tmux new -s site_hook
  • screen -mS site_hook

Starting Syntax

  • site_hook server listen
  • bundle exec site_hook server listen

Depending on how you installed site_hook.