Intermediate
- Knowledge of working on remote repositories (github / bitbucket etc) and on cloud server (Rackspace cloud / Amazon EC2 etc).
- Apache
- PHP
- you have a local git repo
- with an online remote repository (github / bitbucket etc)
- and a cloud server (Rackspace cloud / Amazon EC2 etc)
- your (PHP) scripts are served from /var/www/html/
- your webpages are executed by apache
- apache's home directory is /var/www/
(This describes a pretty standard apache setup on Redhat / Ubuntu / CentOS / Amazon AMI etc) you should be able to do the same with Java, Perl, RoR, JSP etc. however you'll need to recreate the (rather simple) PHP script.
git
, rsync
, and tar
binaries are required on the server that's running the script (server machine).
Also, the system user that's running PHP needs to have the right ssh keys to access the remote repository (If it's a private repo) and have the required permissions to update the files on the server machine.
Here we add the deployment script and push it to the origin, the deployment script runs git commands to PULL from the origin thus updating your server
git add deploy.php
git commit -m 'Added the git deployment script'
git push -u origin master
Here we install and setup git on the server, we also create an SSH key so the server can talk to the origin without using passwords etc
After you've installed git, make sure it's a relatively new version - old scripts quickly become problematic as github / bitbucket / whatever will have the latests and greatest, if you don't have a recent version you'll need to figure out how to upgrade it :-)
git --version
# Add a nice repo
rpm -Uvh http://repo.webtatic.com/yum/centos/5/latest.rpm
# Install git
yum install --enablerepo=webtatic git-all
sudo yum install git-core
git config --global user.name "Server"
git config --global user.email "[email protected]"
sudo mkdir /var/www/.ssh
sudo chown -R apache:apache /var/www/.ssh/
sudo -Hu apache ssh-keygen -t rsa # choose "no passphrase"
sudo cat /var/www/.ssh/id_rsa.pub
Here we add the SSH key to the origin to allow your server to talk without passwords. In the case of GitHub we also setup a post-receive hook which will automatically call the deploy URL thus triggering a PULL request from the server to the origin
- Go to
https://github.com/USERNAME/REPOSITORY/settings/keys
and add your server SSH key (only needed for private repositories) - Go to
https://github.com/USERNAME/REPOSITORY/admin/hooks
- Select the WebHook URLs service hook
- Enter the URL to your deployment script e.g.
http://example.com/deploy.php?sat=YourSecretAccessTokenFromDeployFile
- Click Update Settings
- Go to
https://bitbucket.org/USERNAME/REPOSITORY/admin/deploy-keys
and add your server SSH key (only needed for private repositories) - Go to
https://bitbucket.org/USERNAME/REPOSITORY/admin/services
- Add POST service
- Enter the URL to your deployment script e.g.
http://example.com/deploy.php?sat=YourSecretAccessTokenFromDeployFile
- Click Save
- Configure the SSH keys
- Add a executable
.git/hooks/post_receive
script that calls the script e.g.
#!/bin/sh
echo "Triggering the code deployment ..."
wget -q -O /dev/null http://example.com/deploy.php?sat=YourSecretAccessTokenFromDeployFile
Here we clone the origin repo into a chmodded /var/www/html folder
sudo chown -R apache:apache /var/www/html
sudo -Hu apache git clone [email protected]:you/server.git /var/www/html
Now you're ready to go :-)
- Navigate the the deployment script to trigger a pull and see the output:
- http://server.com/deploy.php
- this is useful for debugging too ;-)
- When you push to GitHub your site will automatically ping the above url (and pull your code)
- When you push to Bitbucket you will need to manually ping the above url
- It would be trivial to setup another repo on your server for different branches (develop, release-candidate etc) - repeat most of the steps but checkout a branch after pulling the repo down
Here are more guides from me