From 71a8c889b644b80802fdb66807656a371bc89270 Mon Sep 17 00:00:00 2001 From: Luke Murphy Date: Sun, 18 Nov 2018 19:34:23 +0100 Subject: [PATCH] Add maintenance notes. --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index 8888ff5..346f5a6 100644 --- a/README.md +++ b/README.md @@ -46,3 +46,36 @@ Refer to the [tox.ini](tox.ini) for configuration options. # Deploy It See [ansible/README.md](ansible/README.md) for this. + +# Maintain It + +The XPPL is made up of a few parts: + + * The [Flask] application and it's dependencies. + * The [RQLite] database. + * The [Syncthing] integration for uploads. + * The Nginx reverse proxy. + * The Let's Encrypt web certificates. + +If you know [Ansible] (it's just YAML), you can just [read the entire configuration]. + +On the varia.zone machine, you can check the running services with: + +```bash +$ sudo supervisorctl status all # check all services +$ sudo supervisorctl stop xppl:* # stop all XPPL services +$ sudo supervisorctl start xppl:* # start all XPPL services +``` + +The `/var/xppl/xppl/uploads` folder is managed by the Varia [Syncthing UI]. + +The RQLite database is located at `/var/xppl/rqlite/node.1`. No cluster is configured. + +No backups are configured right now. + +[Flask]: http://flask.pocoo.org/ +[RQLite]: https://github.com/rqlite/rqlite +[Syncthing]: https://docs.syncthing.net/ +[Syncthing UI]: https://vvvvvvaria.org/st/ +[read the entire configuration]: ansible/plays/main.yml +[Ansible]: https://www.ansible.com/overview/how-ansible-works