Skip to content

Technical Documentation

Professor Colin Turner edited this page Sep 4, 2018 · 1 revision

WAM Technical Documentation

This is intended to be a home page for some technical documentation on WAM. This is very much a work in progress.

Installation

WAM is Free and Open Source Software written with Python 3 and the Django Web Application Framework.

Installing those is beyond the scope of this documentation, but you could do worse but to install a nice server with Debian and using its excellent package management to install Django.

WAM itself can be retrieved from it's GitHub repository (where you are readying this guide). Again, if you, or your IT staff don't know how, you can consider contacting me for consultancy, or ask for the rates to run WAM as a hosted service.

Cron Configuration

For WAM to be most effective, there are command line tasks that should be run daily, or more or less frequently as you decide. A sample, commented file for depositing in cron.d is available here.

Updating WAM

If you are updating WAM you can pull down new code with git pull or pulling down a specific version. You will likely need to check for migrations. Migrations are how Django manages database schema changes between versions. You will need to locale the manage.py script in your installation and run something like:

python3 manage.py migrate

Make sure you have a strategy for backing up your database (and the rest of your server). This is again outside the scope of this guide.