Skip to content

Latest commit

 

History

History
186 lines (112 loc) · 6.66 KB

README.md

File metadata and controls

186 lines (112 loc) · 6.66 KB

These instructions are for Ubuntu 14.04 LTS. They should work on other Linux environments with minor tweaks.

Set up the server environment

  1. Install linux packages:

     ~ $ sudo apt-get install postgresql postgresql-contrib postgresql-server-dev-9.3 git python-dev python-setuptools
 ~ $ sudo apt-get install libjpeg-dev libpng-dev libfreetype6-dev
 ~ $ sudo apt-get install libxml2-dev libxslt-dev imagemagick tesseract-ocr

  2. Fix image libraries

Ubuntu has these in an 'unusual' location for debian, so the following links ensure that things like Pillow find them.

    ~ $ sudo ln -s /usr/lib/x86_64-linux-gnu/libjpeg.so /usr/lib
    ~ $ sudo ln -s /usr/lib/x86_64-linux-gnu/libfreetype.so /usr/lib
    ~ $ sudo ln -s /usr/lib/x86_64-linux-gnu/libz.so /usr/lib
  1. Install pip

NOTE: PIP is used to conveniently install Python modules needed for the project. If 'which pip' returns a path to pip, it is already installed. If it is not installed, follow these instructions:

get 'distribute_setup.py':

    ~ $ wget http://python-distribute.org/distribute_setup.py
    ~ $ sudo python distribute_setup.py

verify easy install:

    ~ $ which easy_install
    /usr/local/bin/easy_install

install pip:

    ~ $ sudo easy_install pip

verify pip:

    ~ $ which pip
    /usr/local/bin/pip

  1. Install virtualenwrapper Install virtualenvwrapper with sudo.

  2. Create a new virtual environment and work within it

     ~ $ mkvirtualenv dsnac

You can name the virtualenv whatever you like, just be sure to adapt the remaining instructions appropriately.

NOTE If the mkvirtualenv returns a "command not found" error, follow these steps:

  • check that 'virtualenvwrapper.sh' is in /usr/local/bin

  • assuming that it is, use the source command to pass the contents of 'virtualenvwrapper.sh'to the Tcl interpreter: source /usr/local/bin/virtualenvwrapper.sh

  • verify that this works by re-running the virtualenv command:

    mkvirtualenv dsnac

  • exit virtualenv and echo the source command into the local user's .bashrc:

    deactivate echo 'source /usr/local/bin/virtualenvwrapper.sh' >> .bashrc

  • verify contents of .bashrc

    tail .bashrc

  1. Clone the repository and install the requirements

      (dsnac)~ $ git [email protected]:teamtm/turf-metrics-site.git production
  (dsnac)~ $ cd production
  (dsnac)~/production $ pip install -r requirements.txt

This installs Django, Mezzanine and the other required Python modules.

  1. Set up the virtual environment

These commands assume the settings and virtualenv - edit them as necessary.

     (dsnac)~/production $ add2virtualenv .
     (dsnac)~/production $ setvirtualenvproject
     (dsnac)~/production $ echo "export DJANGO_SETTINGS_MODULE=core.settings.dev" >> ~/.virtualenvs/dsnac/bin/postactivate
     (dsnac)~/production $ deactivate
     ~/production $ workon dsnac

Set up postgresql

Postgres can be fiddly to set up. Google is your friend.

  1. Switch to postgres and add yourself as a super user:

     ~ $ sudo -iu postgres
 ~ $ psql -c 'CREATE USER <username> WITH SUPERUSER;'

  2. Add the dsnac database and user.

      ~ $ psql -c "CREATE USER dsnac WITH PASSWORD 'password';"

This is most likely going to be achieved by using a dump of an existing database:

To make the database dump use pg_dump on an existing server with a valid dsnac database thus:

    ~ $ pg_dump -o -Fc dsnac >>> dsnac.pg_dump

Then restore it on the target system thus:

    ~ $ pg_restore -d postgres -C dsnac.pg_dump

Then ensure that the user has full access:

    ~ $ psql -c "GRANT ALL PRIVILEGES ON dsnac TO dsnac;"

If creating a database from scratch:

     (dsnac)~ $ psql -c "CREATE DATABASE dsnac WITH OWNER dsnac;"
     (dsnac)~ $ django createdb

The dsnac user must use md5 rather than peer access for postgres. You may need to edit /etc/postgresql/9.3/main/pg_hba.conf and add a line for dsnac with md5 access specified.

Dealing with locale issues

Postgres is very fussy about database locales. If the database you attempt to restore was created in a different locale, you may find that it will fail with an "Invalid locale name: <locale_name>". If this happens, add the locale and restart the postgres service:

~ $ sudo locale-gen en_AU.UTF-8
Generating locales...
  en_AU.UTF-8... done
Generation complete.
~ $ sudo service postgresql restart
 * Restarting PostgreSQL 9.3 database server     [ OK ]

Install Nginx and upstart job

This is for public facing servers only.

     ~ $ sudo apt-get install nginx
     ~ $ sudo ln -s /home/dsnac/production/deploy/production/nginx /etc/nginx/sites-available/dsnac_production
     ~ $ sudo ln -s /etc/nginx/sites-available/dsnac_production /etc/nginx/sites-enabled/dsnac_production
     ~ $ sudo service nginx restart
     ~ $ sudo cp /home/dsnac/production/deploy/production/upstart.conf /etc/init/dsnac_production.conf
     ~ $ sudo service dsnac_production start

Updating a Deployed service

A deployed service is very similar to any other working copy with two additions:

  1. gunicorn is running to launch processes in response to user requests. It is set up and runs using upstart. The configuration files are in the deploy folder.
  2. Nginx is running to dispatch requests to the gunicorn process.

The deployment update steps may not all be needed depending upon what has changed. The git pull output will identify what needs to be done.

Login as the appropriate user and switch to the appropriate virtual environment

~ $ ssh sikhnationalarchives.com  # access the server from your local system
~ $ sudo -iu dsnac  # switch to the service user
dsnac:~ $ workon production  # switch to the appropriate virtual environment

Use 'git status' if necessary to check the current state of the repo.

Pull an appropriate branch version from the repository.

(production)dsnac:~/production $ git pull # update the repo

Execute any required Django management commands

git pull will list the changes and you can use these to limit the commands but it does no harm to repeat all of them

(production)dsnac:~/production $ django migrate  # only needed if there are migrations
...
(production)dsnac:~/production $ django collectstatic  # only needed if static files have changed
...

Restart the Django service

(production)dsnac:~/production $ logout
~ $ sudo service dsnac_production restart  # restart the django service if code has changed

Reload Nginx

~ $ sudo service nginx reload  # restart nginx if its configuration has changed