Using Git's Post-receive Hooks to Deploy Code
I’ve recently started self-hosting some sites on some cheap, cool hosting provided by Digital Ocean. On one of their VPSs, I’ve set up some bare git repositories and made some git hooks to automate deployment of sites to that server.
This information isn’t limited to only working on Digital Ocean, but my walk-through is based on that environment - using their LAMP stack image based on Ubuntu 12.04 using an SSH key (makes life so much easier :))
This setup uses Apache and some virtual hosts to handle each site. The default setup in Ubuntu for apache involves 2 folders -
/etc/apache2/sites-available (where you can put a virtual host directive) and
/etc/apache2/sites-enabled (where you symlink files from the sites-available folder in order to enable them). Using the
sites-enabled combo allows you to disable sites without removing them. This functionality isn’t required here since we’re going to use git to version control and getting old versions out of config is easy.
Set up git repository for the virtual hosts
/var/repos for all of my repos. You’re welcome to use any other path you see fit.
1 2 3
This creates a bare repository (doesn’t include a working folder) ready for use.
While you’re in there, modify the post-receive hook (my favourite editor is vim =
Put the following code in there
1 2 3 4 5 6 7 8 9 10 11
Then you’ll have to give it execute permission
- Check out the files in the repo to
- Disable all the existing sites that are linked
- Enable all the sites that are present in
- Tell Apache to reload its configuration
Now, on your development machine, you’ll need to set this up as a remote and start pushing virtual host configurations to it.
You’re now ready to start adding virtual host directives into that repo. When you push to
origin, it’ll restart Apache with the updated config.
Here’s a sample - this is modified from the default:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
Set up git repo for each site
So, we can see that virtual hosts are added to Apache whenever you add a new config, but those virtual host configurations are pointing to locations that don’t yet exist. Let’s fix that now, back to your remote server.
1 2 3 4
And to have this git repo deploy whenever it is pushed to,
Don’t forget to make it executable:
It’s ready to go! To check it out locally, you can:
or you could add it as a remote for an existing repository
Push to that remote whenever you’re ready for your changes to go live.