Installing Chappy on Linux

This guide assumes you're on Ubuntu x64 but the process should be the same for most other distributons.

1. Download Chappy for Linux x64.

You can also use curl https://github.com/danbovey/Chappy/raw/master/build/chappy-linux-amd64

2. Rename the file from chappy-linux-amd64 to chappy.

$ mv chappy-linux-amd64 chappy

3. Make it executable.

$ chmod +x chappy

4. Move it to a directory in your $PATH.

You can view what directories are in your path by typing $PATH. Usually, /usr/local/bin is available.

$ sudo mv chappy /usr/local/bin/chappy

5. Test it works by calling:

$ chappy

6. Follow the steps on the README to create your projects file and deploy script and set up a webhook on github.com.

7. Run Chappy forever by creating a systemctl service

Create a new service file within /etc/systemd/system called chappy.service

$ sudo nano /etc/systemd/system/chappy.service

[Unit]
Description=Chappy

[Service]
ExecStart=/usr/local/bin/chappy start --projectsfilepath=<LOCATION OF PROJECTS.JSON>
User=<USER>
Group=<GROUP>
Environment=PATH=/bin:/usr/bin:/usr/local/bin

[Install]
WantedBy=multi-user.target

Make sure to replace <LOCATION...> with the location of your projects file and <USER> and <GROUP> with your user details. Refresh the systemctl daemon, enable and start the service.

$ sudo systemctl daemon-reload
$ sudo systemctl enable chappy.service
$ sudo systemctl start chappy.service

sudo systemctl status chappy.service should output a successful message saying listening on the port and IP you chose.

8. Test the webhook and start committing!