Browse Source

Mettre à jour 'README.md'

master
Dryusdan 4 months ago
parent
commit
95e75a926a
1 changed files with 14 additions and 1 deletions
  1. 14
    1
      README.md

+ 14
- 1
README.md View File

@@ -1,5 +1,5 @@
1 1
 # ansible-plume
2
-
2
+## Explenation 
3 3
 A Ansible playbook to install and upgrade [Plume](https://github.com/Plume-org/Plume).
4 4
 This role install Plume without reverse proxy, backup, or PostgreSQL and it needs to be used with PostgreSQL.
5 5
 
@@ -7,7 +7,20 @@ The [vars.yml](https://git.drycat.fr/Dryusdan/ansible-plume/src/branch/master/va
7 7
 Theses variables are used in `.env` file.
8 8
 There are listed on [the Plume's doc](https://docs.joinplu.me/environment/).
9 9
 
10
+## How to use it ?
11
+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/ ).
12
+After you need to clone this repo in your roles folder.
13
+
14
+YOu need tip this command : 
15
+```
16
+ansible-playbook -i hosts plume.yml
17
+```
18
+
19
+And that all, Plume is installed (or updated).
20
+
21
+If you want a good Ansible Playbook for PostgreSQL, I recommand this : https://github.com/geerlingguy/ansible-role-postgresql
10 22
 
23
+## List of variables 
11 24
 
12 25
 | Varibles | Explanation |
13 26
 | -------- | -------- |

Loading…
Cancel
Save