Deploying Scout

This document describes how to (re)deploy Scout.

Compile front-end assets

Gulp is used to compile SCSS and Vue.js components. To build and minify everything for production, run:

$ gulp build --production

If you are doing this locally and not on the production server you should copy the compiles files from the build/ directory (not under version control).

$ scp -r path/to/scout/build/ [server-alias]:/path/to/scout/

Updating the server

Scout can be installed as a Python package which is needed to get access to the command line interface; scouttools. The upgrade process involves a simple pull from the cloned Scout repo.

$ cd /path/to/scout
$ git pull
$ pip uninstall --yes scout && pip install .

It's advisable to run Scout using process supervision. The tools we have chosen is "supervisord". Once you have updated the source code you just need to restart the server process:

$ supervisorctl restart scout

Disclaimers

This guide assumes the simplest upgrade which doesn't involve any rebuilds of the database etc.