diff --git a/README.md b/README.md index 6577d18..7e4fdea 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # ansible-plume - +## Explenation 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. @@ -7,7 +7,20 @@ The [vars.yml](https://git.drycat.fr/Dryusdan/ansible-plume/src/branch/master/va Theses variables are used in `.env` file. There are listed on [the Plume's doc](https://docs.joinplu.me/environment/). +## How to use it ? +First, you need to [install Ansible](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html). 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 | | -------- | -------- |