26 Jan 2016
Deploy Jekyll sites anywhere using jekyll-hook
What is jekyll-hook?
jekyll-hook is a Node.js program which runs on a server. It listens for new commits on a GitHub repository using webhooks. When there is a commit, jekyll-hook pulls the latest source code, builds the site with Jekyll, then deploys the built site to a directory.
I’m using Ubuntu 14.04 so adjust the instructions for your operating system.
Install Git, Node.js, Ruby and Jekyll:
Clone the jekyll-hook repo from GitHub:
Install the dependencies:
Copy the sample configuration to
config.json in a text editor.
With this script you can configure jekyll-hook to listen to a particular server, run special build scripts for a particular Git branch or send an email every time there’s a build. The default
config.json get us most of the way there, we just need to ensure changes can be pulled in from our account.
accounts to your GitHub account or organisation.
Here’s my complete
As you can see from the configuration, jekyll-hook is going to run
./scripts/build.sh when it detects a change. The default build script pulls the latest commits to the local repository and runs
jekyll build. We don’t need to change anything in this file.
After the build finishes, jekyll-hook, runs
./scripts/publish.sh. This script moves the built site to your web server directory.
By default jekyll-hook deploys the site to
$repo is one of the variables jekyll-hook makes available to use in the path. You can also use
site to your desired location.
Here’s my complete
Jekyll-hook is set up to listen for changes from GitHub. When there is a change it will build the site and deploy it to a folder.
Now we need GitHub to send jekyll-hook a webhook when there’s a commit to the repository.
Open your repository on GitHub. Then go to Settings -> Webhooks & services.
Click Add webhook. Set the Payload URL to point at your jekyll-hook server
:branch is the branch you want to publish. The rest of the defaults are fine, press Add webhook.
Deploying the site
Run jekyll-hook. It listens for changes on port 8080:
If you’re running this on EC2 remember you’ll need to open port 8080 in your security group.
Make a change in the repository and you’ll see logs appear in your jekyll-hook program. If nothing happens have a look at your webhook logs on GitHub.
Check the deployment directory to see a built version of your Jekyll site. Now you just need to configure your webserver to serve the site.