Deploying GovReady-Q to Ubuntu LinuxΒΆ

This document provides some basic guidance on setting up GovReady-Q on an Ubuntu 16.04 server with Nginx. These commands should be run from the root directory of the GovReady-Q code repository.

Update system packages and install packages helpful for GovReay-Q:

apt-get update && apt-get upgrade -y

apt-get install -y \
    unzip \
    python3 python-virtualenv python3-pip \
    python3-yaml \
    nginx uwsgi-plugin-python3 supervisor \
    memcached \
    graphviz \

Configure nginx to use nginx.conf in this directory:

# Turn off nginx's default website.
rm -f /etc/nginx/sites-enabled/default

# Put in our nginx site config.
ln -sf `pwd`/deployment/ubuntu/nginx.conf /etc/nginx/sites-enabled/

service nginx restart

The nginx conf file assumes a certificate chain and private key are present at /etc/ssl/local/ssl_certificate.crt/key.

Install dependencies:

pip3 install -r requirements.txt

Configure GovReady-Q by creating a file in local/environment.json with the following content:

  "debug": false,
  "admins": [["Name", ""], ...],
  "host": "q.<yourdomain>.com",
  "organization-parent-domain": "<yourdomain>.com",
  "organization-seen-anonymously": false,
  "https": true,
  "secret-key": "something random here",
  "static": "/home/user/public_html"

You can use Django Secret Key Generator to make a secret-key value.

Prepare the database:

python3 migrate
python3 createsuperuser

Prepare static files:

mkdir -p /home/user/public_html/static
python3 collectstatic --noinput

Set up supervisor to run the uwsgi daemon:

ln -sf `pwd`/deployment/ubuntu/supervisor.conf /etc/supervisor/conf.d/
service supervisor restart