Ansible
/
plume
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Mettre à jour 'README.md'

This commit is contained in:
Dryusdan 2019-03-13 21:36:07 +01:00
parent 7cb1725c93
commit 5145e31259
1 changed files with 30 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -1,3 +1,32 @@
# ansible-plume
A Ansible playbook to install and upgrade plume
A Ansible playbook to install and upgrade [Plume](https://github.com/Plume-org/Plume).
This role install Plume without reverse proxy, backup, or PostgreSQL and it needs to be used with PostgreSQL.
The [vars.yml](https://git.drycat.fr/Dryusdan/ansible-plume/src/branch/master/vars.yml) is an example of each variables.
Theses variables are used in `.env` file.
There are listed on [the Plume's doc](https://docs.joinplu.me/environment/).
| Varibles | Explanation |
| -------- | -------- |
| base_url | The domain name, or IP and port on which Plume is listening. It is used in all federation-related code. |
| domain | The domain of instance |
| licence | The default licence of each article |
| display_name | The name of admin |
| admin_name | The username of admin (for login) |
| admin_email | The email of admin |
| db_user | The postgresql user |
| db_password | The password of postgresql |
| db_name | The name of database |
| db_host | The postgresql host |
| db_port | The port of postgresql |
| rocket_address | The adress on which Plume should listen |
| rocket_port | The port on which Plume should listen (7878 by default) |
| rocket_secret_key | Key used to sign private cookies and for CSRF protection. If it is not set, it will be regenerated everytime you restart Plume, meaning that all your users will get disconnected. You can generate one with `openssl rand -base64 32`. |
| mail_server | The SMTP server to connect to. |
| mail_user | The username of the user that sends emails. |
| mail_password | It's password. |
| mail_helo_name | The name sent during EHLO/HELO. |