docs: automation

fixes: #1
This commit is contained in:
Iain Learmonth 2022-05-09 08:55:27 +01:00
parent 257a2eacea
commit af0b808cfd
4 changed files with 46 additions and 0 deletions

25
docs/admin/install.rst Normal file
View file

@ -0,0 +1,25 @@
Installation
============
The current installation method is to use a Python virtual envrionment.
Many of the dependencies needed by the portal can be installed from PyPI, although some
dependencies will need to be satisfied in other ways:
* A cron daemon - probably available in your system package manager
* Terraform binary - static binaries available from Hashicorp
* PostgreSQL server - probably available in your system package manager
Create and activate a virtual environment with:
.. code-block:: shell
cd /installation/directory
python -m venv env
. env/bin/activate
You will need to install an entry into the portal user's crontab:
.. code-block:: crontab
*/1 * * * * (cd /path/to/portal ; /path/to/env/bin/python -m app.cli automate --all) &>/dev/null