I’ve been deploying using git for my static and node sites for several months and wanted to offer some tips on how you can do the same. This is very similar to heroku’s deployment model but using your own server in place of theirs.
- Remote server for hosting your site
- SSH access on remote server
- Git installed locally and remotely
- (optional) npm installed remotely
- (optional) grunt installed remotely
For the remote server, you’ll need two different directories to store your files. One is where your site will be hosted, the other will be used for the git repository. I’m using
/var/git respectively, but you can choose differently based on your setup.
Create remote repository
For the remote server, you’ll need to start with a bare git repository. This is where you will push your content to from your local machine.
cd /var/git mkdir site.git && cd site.git git init --bare
Whatever you’re using to build locally, you’ll also need to be sure those dependencies are installed on your remote server. I’m using npm and grunt to build everything - but this could be ruby, jekyll or anything used to compile your site.
Since I’m using grunt, we’ll need to be sure that grunt-cli is installed globally.
npm install -g grunt-cli
Create post receive hook
We’ll be using a post receive hook to run tasks after commits are received, such as building the site. Since your git directory probably isn’t where you’re serving up your files, you can use
--work-tree to set the working directory for your committed files.
#!/bin/sh # Use a build path as a temp staging directory before copying over # to the "live" web directory BUILD_PATH=$(cd "$(dirname "$0")/.."; pwd)/build WEB_PATH=/var/www/example.com # Checkout latest version of files and cleanup untracked files git --work-tree=$BUILD_PATH checkout -f git --work-tree=$BUILD_PATH clean -fd cd $BUILD_PATH; npm install --production # Use grunt to run a build task, but this could be anything you # want to use to generate your static site and/or run your node project grunt build # Clean web directory and copy static files to web directory (cd $WEB_PATH;rm -rf *) (cp -r $BUILD_PATH/build/. $WEB_PATH)
Be sure you make the post-receive hook executable.
chmod +x hooks/post-receive
Set up Push to Deploy
Now that everything is configured remotely, you’ll need to set up your local git to push to your remote server.
git remote add deploy ssh://firstname.lastname@example.org/var/git/site.git
Now, you can push files to your remote server with one simple command:
... git add . git commit -m "Updating files" git push deploy
If everything worked successfully, you should be able to view your site and see updated changes.
Add SSH key
Don’t like typing your username and password every time you deploy? You can use a public SSH key to authenticate every time you do your push to deploy. If you haven’t already generated your SSH keys, you can follow this guide through step 2.
From there, you can simply copy your public key to your server.
cat ~/.ssh/id_rsa.pub | ssh email@example.com "cat >> ~/.ssh/authorized_keys"
What if you could automate your deployments? You can continue on reading on how you can enhance the push to deploy by making your deployments completely automated with Travis CI.