Below you will find basic setup and deployment instructions for the rapidsms_raspberrypi project. To begin you should have the following applications installed on your local development system:
- Python >= 2.6 (2.7 recommended) - `pip >= 1.1 <http://www.pip-installer.org/>`_ - `virtualenv >= 1.7 <http://www.virtualenv.org/>`_ - `virtualenvwrapper >= 3.0 <http://pypi.python.org/pypi/virtualenvwrapper>`_ - git >= 1.7
The deployment uses SSH with agent forwarding so you'll need to enable agent
forwarding if it is not already by adding
ForwardAgent yes to your SSH config.
To setup your local environment you should create a virtualenv and install the necessary requirements:
mkvirtualenv --distribute rapidsms_raspberrypi $VIRTUAL_ENV/bin/pip install -r $PWD/requirements/dev.txt
Then create a local settings file and set your
DJANGO_SETTINGS_MODULE to use it:
cp rapidsms_raspberrypi/settings/local.example.py rapidsms_raspberrypi/settings/local.py echo "export DJANGO_SETTINGS_MODULE=rapidsms_raspberrypi.settings.local" >> $VIRTUAL_ENV/bin/postactivate echo "unset DJANGO_SETTINGS_MODULE" >> $VIRTUAL_ENV/bin/postdeactivate
Exit the virtualenv and reactivate it to activate the settings just changed:
deactivate workon rapidsms_raspberrypi
Create the SQLite database and run the initial syncdb/migrate:
python manage.py syncdb python manage.py migrate
You should now be able to run the development server:
python manage.py runserver
Before your project can be deployed to a server, the code needs to be accessible in a git repository.
Add your project code to a git repo, hosted somewhere your server can clone it from.
fabfile.pynear the top and insert your repo's URL. E.g., change this:
env.repo = u'' # FIXME: Add repo URL
env.repo = firstname.lastname@example.org:account/reponame.git'
The first step in creating a new server is to create users on the remote server. You will need root user access with passwordless sudo. How you specify this user will vary based on the hosting provider. EC2 and Vagrant use a private key file. Rackspace and Linode use a user/password combination.
- For each developer, put a file in the
containing their public ssh key, and named exactly the same as the user to create on the server, which should be the same as the userid on the local development system. (E.g. for user "dickens", the filename must be "dickens", not "dickens.pub" or "user_dickens".)
- For each developer, put a file in the
Run this command to create users on the server:
fab -H <fresh-server-ip> -u <root-user> create_users This will create a project user and users for all the developers.
- Lock down SSH connections: disable password login and move
the default port from 22 to
fab -H <fresh-server-ip> configure_ssh
- Add the IP to the appropriate environment
function and provision it for its role. You can provision a new server with the
setup_serverfab command. It takes a list of roles for this server ('app', 'db', 'lb') or you can say 'all':
fab staging setup_server:all
You can test the provisioning/deployment using Vagrant.
Using the Vagrantfile you can start up the VM. This requires the
With the VM up and running, you can create the necessary users.
Put the developers' keys in
conf/users as before, then
use these commands to create the users. The location of the key file
may vary on your system. Running
locate keys/vagrant might
help find it:
fab -H 18.104.22.168 -u vagrant -i /usr/lib/ruby/gems/1.8/gems/vagrant-1.0.2/keys/vagrant create_users fab vagrant setup_server:all fab vagrant deploy
It is not necessary to reconfigure the SSH settings on the vagrant box.
The vagrant box forwards port 80 in the VM to port 8080 on the host box. You can view the site by visiting localhost:8080 in your browser.
You may also want to add:
to your hosts (/etc/hosts) file.
You can stop the VM with
vagrant halt and
destroy the box completely to retest the provisioning with
For more information please review the Vagrant documentation.
For future deployments, you can deploy changes to a particular environment with
deploy command. This takes an optional branch name to deploy. If the branch
is not given, it will use the default branch defined for this environment in
fab staging deploy fab staging deploy:new-feature
New requirements or South migrations are detected by parsing the VCS changes and will be installed/run automatically.