varia/xppl
14
0
Fork 0
Code Issues 6 Pull Requests Releases Activity

Add maintenance notes.

Browse Source
This commit is contained in:
Luke Murphy 2018-11-18 19:34:23 +01:00
parent 481ee200e2
commit 71a8c889b6
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -46,3 +46,36 @@ Refer to the [tox.ini](tox.ini) for configuration options.
# Deploy It # Deploy It
See [ansible/README.md](ansible/README.md) for this. 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