Pour tout problème contactez-nous par mail : support@froggit.fr | La FAQ :grey_question: | Rejoignez-nous sur le Chat :speech_balloon:

Skip to content
Snippets Groups Projects
Commit 9525c667 authored by Arthur BOUDREAULT's avatar Arthur BOUDREAULT
Browse files

refactor: Updated readme for better comprehension

parent 16533e01
No related branches found
No related tags found
No related merge requests found
Pipeline #2855 passed with warnings
...@@ -8,7 +8,8 @@ ...@@ -8,7 +8,8 @@
[![GitHub Release Date](https://img.shields.io/github/release-date/LydraFr/ansible-yunohost)](https://github.com/LydraFr/ansible-yunohost) [![GitHub Release Date](https://img.shields.io/github/release-date/LydraFr/ansible-yunohost)](https://github.com/LydraFr/ansible-yunohost)
[![GitHub Repo stars](https://img.shields.io/github/stars/LydraFr/ansible-yunohost?style=social)](https://github.com/LydraFr/ansible-yunohost) [![GitHub Repo stars](https://img.shields.io/github/stars/LydraFr/ansible-yunohost?style=social)](https://github.com/LydraFr/ansible-yunohost)
# ansible-yunohost # Rôle Ansible : Yunohost
[🇬🇧 English version](README.md) [🇬🇧 English version](README.md)
Deployez [Yunohost](https://yunohost.org/#/) avec Ansible ! Deployez [Yunohost](https://yunohost.org/#/) avec Ansible !
...@@ -30,7 +31,7 @@ ynh_install_script_url: https://install.yunohost.org ...@@ -30,7 +31,7 @@ ynh_install_script_url: https://install.yunohost.org
ynh_admin_password: MYINSECUREPWD_PLZ_OVERRIDE_THIS ynh_admin_password: MYINSECUREPWD_PLZ_OVERRIDE_THIS
``` ```
-`ynh_install_script_url` est le script d'installation des packages Yunohost, par défaut c'est le script officiel. Yunohost ne s'installe que sur Debian 10. -`ynh_install_script_url` est le script d'installation des packages Yunohost, par défaut c'est le script officiel. Yunohost ne s'installe que sur Debian 10.
- `ynh_admin_password` est le mot de passe permettant d'accéder à l’interface d’administration du serveur. - `ynh_admin_password` est le mot de passe permettant d'accéder à l’interface d’administration du serveur.
### Gestion des domaines ### Gestion des domaines
...@@ -38,52 +39,61 @@ ynh_admin_password: MYINSECUREPWD_PLZ_OVERRIDE_THIS ...@@ -38,52 +39,61 @@ ynh_admin_password: MYINSECUREPWD_PLZ_OVERRIDE_THIS
```yml ```yml
# Liste des domaines gérés par Yunohost. # Liste des domaines gérés par Yunohost.
ynh_main_domain: domain.tld ynh_main_domain: domain.tld
ynh_extra_domains: ynh_extra_domains:
- forum.domain.tld - forum.domain.tld
- wiki.domain.tld - wiki.domain.tld
ynh_ignore_dyndns_server: False ynh_ignore_dyndns_server: False
``` ```
- `ynh_main_domain` correspond au domaine principal qui permettra l’accès au serveur ainsi qu’au portail d’authentification des utilisateurs. On peut se contenter d'un nom de domaine qui nous appartient ou en utiliser un en .nohost.me / .noho.st / .ynh.fr (plus d'infos [ici](https://yunohost.org/fr/install/hardware:vps_debian)). - `ynh_main_domain` correspond au domaine principal qui permet l’accès au serveur ainsi qu’au portail d’authentification des utilisateurs. On peut se contenter d'un nom de domaine qui nous appartient ou en utiliser un en .nohost.me / .noho.st / .ynh.fr (plus d'infos [ici](https://yunohost.org/fr/install/hardware:vps_debian)).
- `ynh_extra_domains` sont ses sous-domaines optionnels et permettent d'installer une application par sous-domaine (plus d'infos [ici](https://yunohost.org/fr/dns_subdomains)). - `ynh_extra_domains` sont des sous-domaines optionnels. Ils permettent d'installer une application par sous-domaine (plus d'infos [ici](https://yunohost.org/fr/dns_subdomains)).
- `ynh_ignore_dyndns_server` permet d'enregistrer les domaines avec un service de DNS dynamique (plus d'infos [ici](https://yunohost.org/fr/dns_dynamicip)). - `ynh_ignore_dyndns_server` permet d'enregistrer les domaines avec un service de DNS dynamique (plus d'infos [ici](https://yunohost.org/fr/dns_dynamicip)).
### Gestion des utilisateurs ### Gestion des utilisateurs
```yml ```yml
# Liste des utilisateurs Yunohost. # Liste des utilisateurs Yunohost.
ynh_users: ynh_users:
- name: user1 - name: user1
pass: MYINSECUREPWD_PLZ_OVERRIDE_THIS pass: MYINSECUREPWD_PLZ_OVERRIDE_THIS
firstname: Jane firstname: Jane
lastname: Doe lastname: Doe
mail_domain: domain.tld mail_domain: domain.tld
``` ```
Les utilisateurs sont créés à partir de la variable `ynh_users`. Chaque champ est obligatoire. Certaines applications Yunohost nécessitent qu'un utilisateur soit administrateur de l'application. Il aura ensuite le droit de gérer l'application depuis l'interface l'administration du serveur. Vous pouvez en apprendre plus sur la gestion des utilisateurs Yunohost [ici](https://yunohost.org/fr/administrate/overview/users). - `ynh_users` est la liste des utilisateurs à créer. Chaque champ est obligatoire. Certaines applications Yunohost nécessitent qu'un utilisateur soit administrateur de l'application. Il aura ensuite le droit de gérer l'application depuis l'interface l'administration du serveur. Vous pouvez en apprendre plus sur la gestion des utilisateurs Yunohost [ici](https://yunohost.org/fr/administrate/overview/users).
### Gestion des applications ### Gestion des applications
```yml ```yml
# Liste des applications Yunohost. # Liste des applications Yunohost.
ynh_apps: ynh_apps:
- label: WikiJS - label: WikiJS
link: wikijs link: wikijs
args: args:
domain: wiki.domain.tld domain: wiki.domain.tld
path: / path: /
admin: user1 admin: user1
is_public: no is_public: no
- label: Discourse - label: Discourse
link: discourse link: discourse
args: args:
domain: forum.domain.tld domain: forum.domain.tld
path: / path: /
admin: user1 admin: user1
is_public: yes is_public: yes
``` ```
Les applications sont installées à partir de la variable `ynh_apps`. La variable `label` permet de donner un nom personnalisé à l'application sur l'interface utilisateur. `link` correspond au nom de l'application Yunohost qu'on souhaite installer. Concernant les arguments, `path` et `domain` sont indispensables. Pour les autres arguments, il faut se référer au `manifest.json` disponible dans le dépôt de l'application Yunohost qu'on installe. - `ynh_apps` est la liste des applications à installer.
- `label` permet de donner un nom personnalisé à l'application sur l'interface utilisateur.
- `link` correspond au nom de l'application Yunohost qu'on veut installer.
Concernant les arguments :
- `domain` est indispensable. Il faut choisir un des domaines de son instance Yunohost.
- `path` est indispensable. Il faut choisir une URL pour accéder à son application comme `domain.tld/my_app`. Utilisez juste `/` si l'application doit s'installer sur un sous-domaine.
- `is_public` est un argument qu'on retrouve souvent. Paramétré sur `yes`, l'application sera accessible à tout le monde, même sans authentification sur le portail SSO Yunohost. Paramétré sur `no`, l'application ne sera accessible qu'après authentification.
Pour les autres arguments, il faut se référer au `manifest.json` disponible dans le dépôt de l'application Yunohost qu'on installe. Vous pouvez en apprendre plus sur cette partie [ici](https://yunohost.org/fr/packaging_apps_manifest).
## Dépendances ## Dépendances
......
...@@ -8,7 +8,8 @@ ...@@ -8,7 +8,8 @@
[![GitHub Release Date](https://img.shields.io/github/release-date/LydraFr/ansible-yunohost)](https://github.com/LydraFr/ansible-yunohost) [![GitHub Release Date](https://img.shields.io/github/release-date/LydraFr/ansible-yunohost)](https://github.com/LydraFr/ansible-yunohost)
[![GitHub Repo stars](https://img.shields.io/github/stars/LydraFr/ansible-yunohost?style=social)](https://github.com/LydraFr/ansible-yunohost) [![GitHub Repo stars](https://img.shields.io/github/stars/LydraFr/ansible-yunohost?style=social)](https://github.com/LydraFr/ansible-yunohost)
# ansible-yunohost # Ansible Role: Yunohost
[🇫🇷 French version](README-FR.md) [🇫🇷 French version](README-FR.md)
Deploy [Yunohost](https://yunohost.org/#/) with Ansible! Deploy [Yunohost](https://yunohost.org/#/) with Ansible!
...@@ -21,6 +22,8 @@ None. ...@@ -21,6 +22,8 @@ None.
Default variables are available in `default/main.yml` however it is necessary to override them according to your needs for Yunohost domains, users and apps. Default variables are available in `default/main.yml` however it is necessary to override them according to your needs for Yunohost domains, users and apps.
### Yunohost Installation
```yml ```yml
# Debian 10 script only. # Debian 10 script only.
ynh_install_script_url: https://install.yunohost.org ynh_install_script_url: https://install.yunohost.org
...@@ -28,53 +31,68 @@ ynh_install_script_url: https://install.yunohost.org ...@@ -28,53 +31,68 @@ ynh_install_script_url: https://install.yunohost.org
ynh_admin_password: MYINSECUREPWD_PLZ_OVERRIDE_THIS ynh_admin_password: MYINSECUREPWD_PLZ_OVERRIDE_THIS
``` ```
`ynh_install_script_url` downloads official Yunohost script for installing Yunohost packages. Yunohost is only available on Debian 10. - `ynh_install_script_url` downloads official Yunohost script for installing Yunohost packages. Yunohost is only available on Debian 10.
`ynh_admin_password` is the password used to access to the server's administration interface. - `ynh_admin_password` is the password used to access to the server's administration interface.
### Domain management
```yml ```yml
# The list of Yunohost domains. # The list of Yunohost domains.
ynh_main_domain: domain.tld ynh_main_domain: domain.tld
ynh_extra_domains: ynh_extra_domains:
- forum.domain.tld - forum.domain.tld
- wiki.domain.tld - wiki.domain.tld
ynh_ignore_dyndns_server: False ynh_ignore_dyndns_server: False
``` ```
`ynh_main_domain` is the main domain used by the server's users to access the authentication portal. If you already own a domain name, you probably want to use it here. You can also use a domain in .nohost.me / .noho.st / .ynh.fr (more info [here](https://yunohost.org/en/install/hardware:vps_debian)). - `ynh_main_domain` is the main domain used by the server's users to access the authentication portal. If you already own a domain name, you probably want to use it here. You can also use a domain in .nohost.me / .noho.st / .ynh.fr (more info [here](https://yunohost.org/en/install/hardware:vps_debian)).
`ynh_extra_domains` are optional and allow you to install one app per subdomain (more info [here](https://yunohost.org/en/administrate/specific_use_cases/domains/dns_subdomains)). - `ynh_extra_domains` are optional and allow you to install one app per subdomain (more info [here](https://yunohost.org/en/administrate/specific_use_cases/domains/dns_subdomains)).
`ynh_ignore_dyndns_server` allow to register domains with a Dynamic DNS service (more info [here](https://yunohost.org/en/dns_dynamicip)). - `ynh_ignore_dyndns_server` allow to register domains with a Dynamic DNS service (more info [here](https://yunohost.org/en/dns_dynamicip)).
### User management
```yml ```yml
# The list of Yunohost users. # The list of Yunohost users.
ynh_users: ynh_users:
- name: user1 - name: user1
pass: MYINSECUREPWD_PLZ_OVERRIDE_THIS pass: MYINSECUREPWD_PLZ_OVERRIDE_THIS
firstname: Jane firstname: Jane
lastname: Doe lastname: Doe
mail_domain: domain.tld mail_domain: domain.tld
``` ```
Yunohost users are created from `ynh_users` variable. Each field is mandatory. Some Yunohost applications require that a user be the app administrator. He will then have the right to manage the application from the server administration interface. You can learn more about Yunohost user management [here](https://yunohost.org/en/users). - `ynh_users` is the list of users to create. Each field is mandatory. Some Yunohost applications require that a user be the app administrator. He will then have the right to manage the application from the server administration interface. You can learn more about Yunohost user management [here](https://yunohost.org/en/users).
### App management
```yml ```yml
# The list of Yunohost apps. # The list of Yunohost apps.
ynh_apps: ynh_apps:
- label: WikiJS - label: WikiJS
link: wikijs link: wikijs
args: args:
domain: wiki.domain.tld domain: wiki.domain.tld
path: / path: /
admin: user1 admin: user1
is_public: no is_public: no
- label: Discourse - label: Discourse
link: discourse link: discourse
args: args:
domain: forum.domain.tld domain: forum.domain.tld
path: / path: /
admin: user1 admin: user1
is_public: yes is_public: yes
``` ```
Applications are installed from the `ynh_apps` variable. The `label` variable is used to give a custom name to the application on the user interface. `link` is the name of the Yunohost application we want to install. Regarding the arguments, `path` and `domain` are essential. For the other arguments, you have to refer to the `manifest.json` available in the repository of the Yunohost application you are installing. - `ynh_apps` is the list of applications to install.
- `label` allows you to give a custom name to the application on the user interface.
- `link` is the name of the Yunohost application to install.
About the arguments:
- `domain` is essential. You have to choose one of the domains of your Yunohost instance.
- `path` is required. You have to choose a URL to access your application like `domain.tld/my_app`. Just use `/` if the application is to be installed on a subdomain.
- `is_public` argument is a common one. Set to `yes`, the application will be accessible to everyone, even without authentication to the Yunohost SSO portal. Set to `no`, the application will be accessible only after authentication.
For the other arguments, you have to refer to the `manifest.json` available in the repository of the Yunohost application you install. You can learn more about this part [here](https://yunohost.org/fr/packaging_apps_manifest).
## Dependencies ## Dependencies
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment