A Ansible playbook to install and upgrade plume
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Dryusdan 95e75a926a Mettre à jour 'README.md' 1 miesiąc temu
roles/plume Add plume role 1 miesiąc temu
.gitignore Initial commit 1 miesiąc temu
LICENSE Initial commit 1 miesiąc temu
README.md Mettre à jour 'README.md' 1 miesiąc temu
vars.yml correct CC 1 miesiąc temu

README.md

ansible-plume

Explenation

A Ansible playbook to install and upgrade Plume. This role install Plume without reverse proxy, backup, or PostgreSQL and it needs to be used with PostgreSQL.

The vars.yml is an example of each variables. Theses variables are used in .env file. There are listed on the Plume’s doc.

How to use it ?

First, you need to install Ansible. You need also make Ansible inventory… (French article : https://noskillbrain.fr/2017/10/18/ansible/ and https://www.cyphercat.eu/deploiement-et-automatisation-avec-ansible-partie-1/ ). After you need to clone this repo in your roles folder.

YOu need tip this command :

ansible-playbook -i hosts plume.yml

And that all, Plume is installed (or updated).

If you want a good Ansible Playbook for PostgreSQL, I recommand this : https://github.com/geerlingguy/ansible-role-postgresql

List of variables

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.