refactor: transformed the role into a collection
This commit is contained in:
Arthur BOUDREAULT
parent
bed20025a2
commit
26351e9e11
29 changed files with 1092 additions and 355 deletions
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
#-----------------------------------------------------------------------------#
|
#-----------------------------------------------------------------------------#
|
||||||
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
||||||
# Copyright 2021-2021 Lydra https://www.lydra.fr/ #
|
# Copyright 2021-present Lydra https://www.lydra.fr/ #
|
||||||
# #
|
# #
|
||||||
# this program is free software: you can redistribute it and/or modify #
|
# this program is free software: you can redistribute it and/or modify #
|
||||||
# it under the terms of the GNU General Public License as published by #
|
# it under the terms of the GNU General Public License as published by #
|
||||||
|
|
|
||||||
178
README-FR.md
178
README-FR.md
|
|
@ -8,176 +8,48 @@
|
||||||
[](https://github.com/LydraFr/ansible-yunohost)
|
[](https://github.com/LydraFr/ansible-yunohost)
|
||||||
[](https://github.com/LydraFr/ansible-yunohost)
|
[](https://github.com/LydraFr/ansible-yunohost)
|
||||||
|
|
||||||
# Rôle Ansible : Yunohost
|
Collection Ansible - lydra.yunohost
|
||||||
|
|
||||||
[🇬🇧 English version](README.md)
|
[🇬🇧 English version](README.md)
|
||||||
|
|
||||||
Déployez [Yunohost](https://yunohost.org/#/) avec Ansible !
|
Cette collection vise à installer, configurer et sauvegarder [Yunohost](https://yunohost.org/#/).
|
||||||
|
Comme il s'agit d'une collection indépendante, elle peut être publiée selon sa propre cadence de publication. De plus, les rôles qu'elle contient sont mis à jour indépendamment.
|
||||||
|
|
||||||
## Prérequis
|
## Prérequis
|
||||||
|
|
||||||
Aucun.
|
------------
|
||||||
|
|
||||||
## Variables du rôle
|
Votre serveur doit être basé sur du Debian Buster et Yunohost ne doit pas déjà être installé.
|
||||||
|
|
||||||
Les variables par défaut sont disponibles dans `default/main.yml` cependant il est nécessaire de les surcharger selon vos besoins en termes de domaines, d'utilisateurs et d'applications sur Yunohost.
|
## Contenu de la collection
|
||||||
|
|
||||||
### Installation de Yunohost
|
### Rôles
|
||||||
|
|
||||||
```yml
|
- [`lydra.yunohost.ynh_setup`](roles/ynh_setup/README-FR.md) : Ce rôle prépare les serveurs à base de Debian-Buster à exécuter Yunohost. Il configure Yunohost avec ses paramètres initiaux et les domaines, utilisateurs et applications de votre choix.
|
||||||
# Script pour Debian 10 uniquement.
|
- [`lydra.yunohost.ynh_config`](roles/ynh_config/README-FR.md) : Ce rôle gère la configuration de différents services de Yunohost (relais SMTP, mises à jour automatiques).
|
||||||
ynh_install_script_url: https://install.yunohost.org
|
- [`lydra.yunohost.ynh_backup`](roles/ynh_backup/README-FR.md) : Ce rôle gère la configuration des sauvegardes.
|
||||||
|
|
||||||
ynh_admin_password: MYINSECUREPWD_PLZ_OVERRIDE_THIS
|
### lydra.yunohost Tags du rôle
|
||||||
```
|
|
||||||
|
|
||||||
- `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.
|
|
||||||
|
|
||||||
### Gestion des domaines
|
Ces tags sont applicables suivant les rôles.
|
||||||
|
|
||||||
```yml
|
|tags|commentaires|
|
||||||
# Liste des domaines gérés par Yunohost.
|
|----|-------|
|
||||||
ynh_main_domain: domain.tld
|
|yunohost|Tâches spécifiques à Yunohost.|
|
||||||
ynh_extra_domains:
|
|users|Tâches spécifiques aux utilisateurs de Yunohost.|
|
||||||
- forum.domain.tld
|
|domains|Tâches spécifiques aux domaines liés à Yunohost.|
|
||||||
- wiki.domain.tld
|
|apps|Tâches spécifiques aux applications de Yunohost.|
|
||||||
ynh_ignore_dyndns_server: False
|
|update|Tâches liées aux paramètres de mise à jour de Yunohost.|
|
||||||
```
|
|smtp|Tâches liées aux paramètres de relais smtp de Yunohost.|
|
||||||
|
|backup|Tâches liées aux sauvegardes de Yunohost.|
|
||||||
- `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)).
|
|pkg|Tâches d'installation de paquets.|
|
||||||
- `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)).
|
|
||||||
|
|
||||||
### Configuration d'un relais SMTP
|
|
||||||
|
|
||||||
```yml
|
|
||||||
# paramètres personnalisés du relais SMTP
|
|
||||||
ynh_smtp_relay:
|
|
||||||
host: smtp.domain.tld
|
|
||||||
port: 25
|
|
||||||
user: user1
|
|
||||||
password: Pa$$w0rd
|
|
||||||
```
|
|
||||||
Yunohost possède son propre serveur SMTP natif mais il est aussi possible de configurer Yunohost pour qu'il utilise un relais SMTP à la place.
|
|
||||||
Pour faire cela, créez la variable `ynh_smtp_relay` et mettez vos propres valeurs. Vous pouvez en apprendre plus sur les relais SMTP [ici](https://yunohost.org/fr/administrate/specific_use_cases/email_relay).
|
|
||||||
|
|
||||||
### Gestion des utilisateurs
|
|
||||||
|
|
||||||
```yml
|
|
||||||
# Liste des utilisateurs Yunohost.
|
|
||||||
ynh_users:
|
|
||||||
- name: user1
|
|
||||||
pass: MYINSECUREPWD_PLZ_OVERRIDE_THIS
|
|
||||||
firstname: Jane
|
|
||||||
lastname: Doe
|
|
||||||
mail_domain: domain.tld
|
|
||||||
```
|
|
||||||
|
|
||||||
- `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
|
|
||||||
|
|
||||||
```yml
|
|
||||||
# Liste des applications Yunohost.
|
|
||||||
ynh_apps:
|
|
||||||
- label: WikiJS
|
|
||||||
link: wikijs
|
|
||||||
args:
|
|
||||||
domain: wiki.domain.tld
|
|
||||||
path: /
|
|
||||||
admin: user1
|
|
||||||
is_public: no
|
|
||||||
- label: Discourse
|
|
||||||
link: discourse
|
|
||||||
args:
|
|
||||||
domain: forum.domain.tld
|
|
||||||
path: /
|
|
||||||
admin: user1
|
|
||||||
is_public: yes
|
|
||||||
post_install:
|
|
||||||
- src: "templates/site_settings.yml.j2"
|
|
||||||
dest: "/var/www/discourse/config/site_settings.yml"
|
|
||||||
type: "config"
|
|
||||||
|
|
||||||
- src: "templates/configure_discourse.sh.j2"
|
|
||||||
dest: "/tmp/configure_discourse.sh"
|
|
||||||
type: "script"
|
|
||||||
owner: root
|
|
||||||
group: root
|
|
||||||
```
|
|
||||||
|
|
||||||
- `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 obligatoire. Il faut choisir un des domaines de son instance Yunohost.
|
|
||||||
- `path` est obligatoire. 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).
|
|
||||||
|
|
||||||
#### Concernant la post-installation
|
|
||||||
Il est possible de compléter l'installation des applications par l'ajout de templates jinja de configuration ou de scripts que vous aurez écrit de votre côté.
|
|
||||||
Pour activer cette fonctionnalité, définissez la variable `post_install` qui correspond à la liste des fichiers de post-installation de votre application.
|
|
||||||
Cette tâche utilisant le module template, vous pouvez tout à fait utiliser vos propres variables et les appeler dans vos fichiers de template. Pour en savoir sur ce module, cliquez [ici](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/template_module.html).
|
|
||||||
|
|
||||||
- `src` est obligatoire. Il s'agit du répertoire où le fichier de template se situe sur la machine qui execute Ansible.
|
|
||||||
- `dest` est obligatoire. Il s'agit du répertoire où le fichier de template va être stocké.
|
|
||||||
- `type` est obligatoire :
|
|
||||||
- Si vous précisez comme valeur `script` alors le fichier de template aura pour droits 740. Il sera exécuté après son transfert sur le serveur Yunohost (généralement dans `/tmp/`) puis il sera supprimé.
|
|
||||||
- Si vous précisez comme valeur `config` alors le fichier de template aura pour droits 660. Il sera transféré sur le serveur Yunohost (généralement dans `/var/www/AppName/`) et vous pourrez l'importer avec un script shell à côté par exemple.
|
|
||||||
|
|
||||||
Pour `owner` et `group`, par défaut le fichier va prendre comme utilisateur propriétaire le nom de l'application et comme groupe propriétaire www-data (groupe NGINX). Vous pouvez les changer en précisant des valeurs différentes.
|
|
||||||
|
|
||||||
### Concernant les mises à jour
|
|
||||||
|
|
||||||
```yml
|
|
||||||
# Autoupdate Yunohost and its apps
|
|
||||||
ynh_autoupdate:
|
|
||||||
scheduled: True
|
|
||||||
special_time: "daily" #Choices are [annually,daily,hourly,monthly,reboot,weekly,yearly]
|
|
||||||
apps: True
|
|
||||||
system: True
|
|
||||||
dest_script: "/usr/bin/"
|
|
||||||
```
|
|
||||||
|
|
||||||
Une tâche cron peut être mise en place pour automatiser la vérification des mises à jour système et applications suivant la périodicité de votre choix.
|
|
||||||
- `ynh_autoupdate.scheduled` : activez la tâche cron en mettant la valeur à `True`.
|
|
||||||
- `ynh_autoupdate.special_time`: est obligatoire. Elle permet de préciser quand vous souhaitez que cette tâche soit exécutée. Valeurs possibles : (`annually`,`daily`,`hourly`,`monthly`,`reboot`,`weekly`,`yearly`).
|
|
||||||
Pour en savoir plus sur les _special times_, cliquez [ici](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/cron_module.html).
|
|
||||||
- `ynh_autoupdate.apps` : est obligatoire. Activez la mise à jour automatique des applications Yunohost en mettant la valeur à `True`.
|
|
||||||
- `ynh_autoupdate.system` : est obligatoire. Activez la mise à jour automatique du système Yunohost en mettant la valeur à `True`.
|
|
||||||
- `ynh_autoupdate.dest_script` : c'est le chemin du répertoire où le script de mise à jour sera installé sur le serveur. La valeur par défaut est `/usr/local/bin`. Le script s'appelle `ynh_autoupdate.sh`.
|
|
||||||
|
|
||||||
Si des mises à jour sont disponibles, elles sont faites automatiquement. En cas de problème suite à la mise à jour d'une application, vous pouvez lire les logs qui sont disponibles ici `/var/log/yunohost/categories/operation`. Vous avez aussi la possibilité de revenir à la version précédente car Yunohost fait toujours une sauvegarde automatique d'une application lorsqu'elle est mise à jour.
|
|
||||||
|
|
||||||
Pour en savoir plus sur le fonctionnement des mises à jour dans Yunohost vous pouvez vous rendre [ici](https://yunohost.org/fr/update). Le changelog des versions de Yunohost est aussi disponible [ici](https://forum.yunohost.org/tag/ynh_release).
|
|
||||||
|
|
||||||
## Dépendances
|
|
||||||
|
|
||||||
Aucune.
|
|
||||||
|
|
||||||
## Exemple de Playbook
|
|
||||||
|
|
||||||
```yml
|
|
||||||
---
|
|
||||||
- name: Install Yunohost on Debian Server
|
|
||||||
hosts: all
|
|
||||||
become: True
|
|
||||||
pre_tasks:
|
|
||||||
- name: Update all packages and index
|
|
||||||
ansible.builtin.apt:
|
|
||||||
upgrade: dist
|
|
||||||
update_cache: yes
|
|
||||||
|
|
||||||
roles:
|
|
||||||
- lydra.yunohost
|
|
||||||
```
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
[](https://choosealicense.com/licenses/gpl-3.0/)
|
[](https://choosealicense.com/licenses/gpl-3.0/)
|
||||||
|
|
||||||
**ansible-yunohost** est maintenu par [Lydra](https://lydra.fr/) et publié sous la licence GPL3.
|
**ansible-yunohost** est maintenu par [Lydra](https://lydra.fr/) et publié sous la licence GPL3.
|
||||||
|
|
|
||||||
179
README.md
179
README.md
|
|
@ -8,175 +8,48 @@
|
||||||
[](https://github.com/LydraFr/ansible-yunohost)
|
[](https://github.com/LydraFr/ansible-yunohost)
|
||||||
[](https://github.com/LydraFr/ansible-yunohost)
|
[](https://github.com/LydraFr/ansible-yunohost)
|
||||||
|
|
||||||
# Ansible Role: Yunohost
|
# Ansible Collection - lydra.yunohost
|
||||||
|
|
||||||
[🇫🇷 French version](README-FR.md)
|
[🇫🇷 French version](README-FR.md)
|
||||||
|
|
||||||
Deploy [Yunohost](https://yunohost.org/#/) with Ansible!
|
This collection aims at installing, configuring and backing up [Yunohost](https://yunohost.org/#/).
|
||||||
|
As this is an independent collection, it can be released on its own release cadence. Moreover, the roles it contains are updated independently.
|
||||||
|
|
||||||
## Requirements
|
# Prerequisites
|
||||||
|
|
||||||
None.
|
------------
|
||||||
|
|
||||||
## Role Variables
|
Your server must be Debian-Buster based and Yunohost shouldn't be already installed.
|
||||||
|
|
||||||
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.
|
## Collection contents
|
||||||
|
|
||||||
### Yunohost Installation
|
### Roles
|
||||||
|
|
||||||
```yml
|
- [`lydra.yunohost.ynh_setup`](roles/ynh_setup/README.md): This role prepares servers with Debian-Buster-based to run Yunohost. It sets up Yunohost with its initial settings and domains, users and apps of your choice.
|
||||||
# Debian 10 script only.
|
- [`lydra.yunohost.ynh_config`](roles/ynh_config/README.md): This role configures various Yunohost services (SMTP relay, auto updates).
|
||||||
ynh_install_script_url: https://install.yunohost.org
|
- [`lydra.yunohost.ynh_backup`](roles/ynh_backup/README.md): This role manages the configuration of backups.
|
||||||
|
|
||||||
ynh_admin_password: MYINSECUREPWD_PLZ_OVERRIDE_THIS
|
## lydra.yunohost Role Tags
|
||||||
```
|
|
||||||
|
|
||||||
- `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.
|
|
||||||
|
|
||||||
### Domain management
|
These tags are applicable to roles.
|
||||||
|
|
||||||
```yml
|
|tags|comment|
|
||||||
# The list of Yunohost domains.
|
|----|-------|
|
||||||
ynh_main_domain: domain.tld
|
|yunohost|Tasks specific to Yunohost.|
|
||||||
ynh_extra_domains:
|
|users|Tasks specific to users in Yunohost.|
|
||||||
- forum.domain.tld
|
|domains|Tasks specific to domains linked to Yunohost.|
|
||||||
- wiki.domain.tld
|
|apps|Tasks specific to Yunohost apps.|
|
||||||
ynh_ignore_dyndns_server: False
|
|update|Tasks related to Yunohost update settings.|
|
||||||
```
|
|smtp|Tasks related to Yunohost smtp relay settings.|
|
||||||
|
|backup|Tasks related to Yunohost backups.|
|
||||||
- `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)).
|
|pkg|Tasks that install packages.|
|
||||||
- `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)).
|
|
||||||
|
|
||||||
### SMTP relay configuration
|
|
||||||
|
|
||||||
```yml
|
|
||||||
# SMTP custom settings
|
|
||||||
ynh_smtp_relay:
|
|
||||||
host: smtp.domain.tld
|
|
||||||
port: 25
|
|
||||||
user: user1
|
|
||||||
password: Pa$$w0rd
|
|
||||||
```
|
|
||||||
|
|
||||||
There is a built-in SMTP server on Yunohost but you can also set up Yunohost to use a SMTP relay instead.
|
|
||||||
In order to do so, create the `ynh_smtp_relay` variable and provide your own values. You can learn more about SMTP relay [here](https://yunohost.org/en/administrate/specific_use_cases/email_relay).
|
|
||||||
|
|
||||||
### User management
|
|
||||||
|
|
||||||
```yml
|
|
||||||
# The list of Yunohost users.
|
|
||||||
ynh_users:
|
|
||||||
- name: user1
|
|
||||||
pass: MYINSECUREPWD_PLZ_OVERRIDE_THIS
|
|
||||||
firstname: Jane
|
|
||||||
lastname: Doe
|
|
||||||
mail_domain: domain.tld
|
|
||||||
```
|
|
||||||
- `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
|
|
||||||
# The list of Yunohost apps.
|
|
||||||
ynh_apps:
|
|
||||||
- label: WikiJS
|
|
||||||
link: wikijs
|
|
||||||
args:
|
|
||||||
domain: wiki.domain.tld
|
|
||||||
path: /
|
|
||||||
admin: user1
|
|
||||||
is_public: no
|
|
||||||
- label: Discourse
|
|
||||||
link: discourse
|
|
||||||
args:
|
|
||||||
domain: forum.domain.tld
|
|
||||||
path: /
|
|
||||||
admin: user1
|
|
||||||
is_public: yes
|
|
||||||
post_install:
|
|
||||||
- src: "templates/site_settings.yml.j2"
|
|
||||||
dest: "/var/www/discourse/config/site_settings.yml"
|
|
||||||
type: "config"
|
|
||||||
|
|
||||||
- src: "templates/configure_discourse.sh.j2"
|
|
||||||
dest: "/tmp/configure_discourse.sh"
|
|
||||||
type: "script"
|
|
||||||
owner: root
|
|
||||||
group: root
|
|
||||||
```
|
|
||||||
|
|
||||||
- `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).
|
|
||||||
|
|
||||||
#### About the post-installation
|
|
||||||
It is possible to complete the installation of applications by adding jinja template configuration files or scripts written by yourself.
|
|
||||||
To enable this feature, define the `post_install` variable which corresponds to the list of post-installation files of your applications.
|
|
||||||
Because this task uses the template module, you can use your own variables and call them in your template files. To know more about this module, click [here](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/template_module.html).
|
|
||||||
|
|
||||||
- `src` is mandatory. This is the directory where the template file is located on the machine running Ansible.
|
|
||||||
- `dest` is mandatory. This is the directory where the template file will be stored.
|
|
||||||
- `type` is mandatory:
|
|
||||||
- If you specify `script` as the value, then the template file will have 740 rights. It will be executed after it is transferred to the Yunohost server (usually in `/tmp/`) and then deleted.
|
|
||||||
- If you specify `config` as the value, then the template file will have 660 rights. It will be transferred to the Yunohost server (usually in `/var/www/AppName/`) and after you could import it with a shell script on the side for example.
|
|
||||||
|
|
||||||
For `owner` and `group`, by default the file will take as owner the name of the application and as owner www-data(NGINX group). You can change them by specifying different values.
|
|
||||||
|
|
||||||
### About the updates
|
|
||||||
|
|
||||||
```yml
|
|
||||||
# Autoupdate Yunohost and its apps
|
|
||||||
ynh_autoupdate:
|
|
||||||
scheduled: True
|
|
||||||
special_time: "daily" #Choices are [annually,daily,hourly,monthly,reboot,weekly,yearly]
|
|
||||||
apps: True
|
|
||||||
system: True
|
|
||||||
dest_script: "/usr/bin/"
|
|
||||||
```
|
|
||||||
|
|
||||||
A cron job can been set up to automate the check for system and application updates on a schedule of your choice.
|
|
||||||
- `ynh_autoupdate.scheduled` : enables the cron job by setting the value to `True`.
|
|
||||||
- `ynh_autoupdate.special_time`: it is mandatory. It allows you to specify when you want this task to be executed. Possible values: (`annually`,`daily`,`hourly`,`monthly`,`reboot`,`weekly`,`yearly`). To learn more about special times, click [here](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/cron_module.html).
|
|
||||||
- `ynh_autoupdate.apps`: is mandatory. Enable automatic updating of Yunohost applications by setting the value to `True`.
|
|
||||||
- `ynh_autoupdate.system`: is mandatory. Enable automatic updating of the Yunohost system by setting the value to `True`.
|
|
||||||
- `ynh_autoupdate.dest_script`: it is the path to the directory where the update script will be installed on the server. The default value is `/usr/local/bin`. The script is named `ynh_autoupdate.sh`.
|
|
||||||
|
|
||||||
If available, updates are done automatically. In case of problems following an application update, you can read logs located in `/var/log/yunohost/categories/operation` . You also have the possibility to rollback to the previous version since Yunohost always makes an automatic backup of an application when it is updated.
|
|
||||||
|
|
||||||
To learn more about how updates work in Yunohost you can go [here](https://yunohost.org/fr/update). The changelog of Yunohost versions is also available [here](https://forum.yunohost.org/tag/ynh_release).
|
|
||||||
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
None.
|
|
||||||
|
|
||||||
## Example Playbook
|
|
||||||
|
|
||||||
```yml
|
|
||||||
---
|
|
||||||
- name: Install Yunohost on Debian Server
|
|
||||||
hosts: all
|
|
||||||
become: True
|
|
||||||
pre_tasks:
|
|
||||||
- name: Update all packages and index
|
|
||||||
ansible.builtin.apt:
|
|
||||||
upgrade: dist
|
|
||||||
update_cache: yes
|
|
||||||
|
|
||||||
roles:
|
|
||||||
- ansible-yunohost
|
|
||||||
```
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
[](https://choosealicense.com/licenses/gpl-3.0/)
|
[](https://choosealicense.com/licenses/gpl-3.0/)
|
||||||
|
|
||||||
**ansible-yunohost** is maintained by [Lydra](https://lydra.fr/) and released under the GPL3 license.
|
**ansible-yunohost** is maintained by [Lydra](https://lydra.fr/) and released under the GPL3 license.
|
||||||
|
|
|
||||||
65
galaxy.yml
Normal file
65
galaxy.yml
Normal file
|
|
@ -0,0 +1,65 @@
|
||||||
|
### REQUIRED
|
||||||
|
# The namespace of the collection. This can be a company/brand/organization or product namespace under which all
|
||||||
|
# content lives. May only contain alphanumeric lowercase characters and underscores. Namespaces cannot start with
|
||||||
|
# underscores or numbers and cannot contain consecutive underscores
|
||||||
|
namespace: lydra
|
||||||
|
|
||||||
|
# The name of the collection. Has the same character restrictions as 'namespace'
|
||||||
|
name: yunohost
|
||||||
|
|
||||||
|
# The version of the collection. Must be compatible with semantic versioning
|
||||||
|
version: 1.0.0
|
||||||
|
|
||||||
|
# The path to the Markdown (.md) readme file. This path is relative to the root of the collection
|
||||||
|
readme: README.md
|
||||||
|
|
||||||
|
# A list of the collection's content authors. Can be just the name or in the format 'Full Name <email> (url)
|
||||||
|
# @nicks:irc/im.site#channel'
|
||||||
|
authors:
|
||||||
|
- Lydra (<suppport@lydra.fr>)
|
||||||
|
|
||||||
|
|
||||||
|
### OPTIONAL but strongly recommended
|
||||||
|
# A short summary description of the collection
|
||||||
|
description: Yunohost related Roles and Modules
|
||||||
|
|
||||||
|
# Either a single license or a list of licenses for content inside of a collection. Ansible Galaxy currently only
|
||||||
|
# accepts L(SPDX,https://spdx.org/licenses/) licenses. This key is mutually exclusive with 'license_file'
|
||||||
|
license:
|
||||||
|
- GPL-3.0-or-later
|
||||||
|
|
||||||
|
# The path to the license file for the collection. This path is relative to the root of the collection. This key is
|
||||||
|
# mutually exclusive with 'license'
|
||||||
|
license_file: 'LICENSE'
|
||||||
|
|
||||||
|
# A list of tags you want to associate with the collection for indexing/searching. A tag name has the same character
|
||||||
|
# requirements as 'namespace' and 'name'
|
||||||
|
tags:
|
||||||
|
- yunohost
|
||||||
|
- cloud
|
||||||
|
- web
|
||||||
|
|
||||||
|
# Collections that this collection requires to be installed for it to be usable. The key of the dict is the
|
||||||
|
# collection label 'namespace.name'. The value is a version range
|
||||||
|
# L(specifiers,https://python-semanticversion.readthedocs.io/en/latest/#requirement-specification). Multiple version
|
||||||
|
# range specifiers can be set and are separated by ','
|
||||||
|
dependencies: {}
|
||||||
|
|
||||||
|
# The URL of the originating SCM repository
|
||||||
|
repository: https://github.com/LydraFr/ansible-yunohost
|
||||||
|
|
||||||
|
# The URL to any online docs
|
||||||
|
documentation: https://github.com/LydraFr/ansible-yunohost/blob/main/README.md
|
||||||
|
|
||||||
|
# The URL to the homepage of the collection/project
|
||||||
|
homepage: https://github.com/LydraFr/ansible-yunohost
|
||||||
|
|
||||||
|
# The URL to the collection issue tracker
|
||||||
|
issues: https://lab.frogg.it/lydra/yunohost/ansible-yunohost/-/issues
|
||||||
|
|
||||||
|
# A list of file glob-like patterns used to filter any files or directories that should not be included in the build
|
||||||
|
# artifact. A pattern is matched from the relative path of the file or directory of the collection directory. This
|
||||||
|
# uses 'fnmatch' to match the files or directories. Some directories and files like 'galaxy.yml', '*.pyc', '*.retry',
|
||||||
|
# and '.git' are always filtered
|
||||||
|
build_ignore: []
|
||||||
|
|
||||||
25
roles/ynh_apps/tasks/main.yml
Normal file
25
roles/ynh_apps/tasks/main.yml
Normal file
|
|
@ -0,0 +1,25 @@
|
||||||
|
---
|
||||||
|
#-----------------------------------------------------------------------------#
|
||||||
|
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
||||||
|
# Copyright 2021-present Lydra https://www.lydra.fr/ #
|
||||||
|
# #
|
||||||
|
# this program is free software: you can redistribute it and/or modify #
|
||||||
|
# it under the terms of the GNU General Public License as published by #
|
||||||
|
# the Free Software Foundation, either version 3 of the License, or #
|
||||||
|
# (at your option) any later version. #
|
||||||
|
# #
|
||||||
|
# this program is distributed in the hope that it will be useful, #
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of #
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
|
||||||
|
# GNU General Public License for more details. #
|
||||||
|
# #
|
||||||
|
# You should have received a copy of the GNU General Public License #
|
||||||
|
# along with this program. If not, see <http://www.gnu.org/licenses/>. #
|
||||||
|
# #
|
||||||
|
#-----------------------------------------------------------------------------#
|
||||||
|
|
||||||
|
- name: Install Yunohost apps
|
||||||
|
ansible.builtin.include_tasks: apps.yml
|
||||||
|
when: ynh_apps
|
||||||
|
tags:
|
||||||
|
- apps
|
||||||
74
roles/ynh_backup/README-FR.md
Normal file
74
roles/ynh_backup/README-FR.md
Normal file
|
|
@ -0,0 +1,74 @@
|
||||||
|
# Rôle Ansible : Yunohost Backup
|
||||||
|
|
||||||
|
[🇬🇧 English version](README.md)
|
||||||
|
|
||||||
|
Sauvegardez [Yunohost](https://yunohost.org/#/) avec Ansible !
|
||||||
|
|
||||||
|
## Prérequis
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
Yunohost doit déjà être installé sur votre serveur.
|
||||||
|
|
||||||
|
## Variables du rôle
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
Les variables par défaut sont disponibles dans `default/main.yml` cependant il est possible de les surcharger selon vos besoins en ...
|
||||||
|
|
||||||
|
### Gestion des sauvegardes
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
```yml
|
||||||
|
ynh_backup:
|
||||||
|
scheduled: True
|
||||||
|
directory: "/data/backup"
|
||||||
|
scheduled_hour: "*"
|
||||||
|
scheduled_minute: "*/30"
|
||||||
|
scheduled_weekday: "*"
|
||||||
|
scheduled_month: "*"
|
||||||
|
system: True
|
||||||
|
apps: True
|
||||||
|
src_script: "templates/ynh_backup.sh.j2"
|
||||||
|
dest_script: "/usr/bin"
|
||||||
|
```
|
||||||
|
|
||||||
|
La tâche backup va permettre de sauvegarder les applications Yunohost ainsi que leurs données grâce à la mise en place d'une tâche cron.
|
||||||
|
|
||||||
|
- `ynh_backup.scheduled` : active la fonctionnalité de sauvegarde des applications Yunohost, mettez la valeur à `True`.
|
||||||
|
- `ynh_backup.directory` : le dossier de sauvegarde par défaut est `/home/yunohost.backup/archives` cependant vous pouvez tout à fait choisir de sauvegarder les backups dans un autre dossier grâce à cette variable. Dans ce cas, de manière à pouvoir restaurer les backups depuis l'interface web, Yunohost créé automatiquement un lien symbolique de l'archive créée vers son dossier par défaut.
|
||||||
|
- `ynh_backup.scheduled_[hour|minute|weekday|month]`: modifie la planification de la tâche cron. Par défaut elle se déclenchera tous les jours de l'année à 1 heure du matin. Pour plus d'informations concernant les réglages horaires cron, cet outil peut être utile : <https://crontab.guru/>.
|
||||||
|
- `ynh_backup.system` : est obligatoire. Activez la sauvegarde du système Yunohost en mettant la valeur à `True`.
|
||||||
|
- `ynh_backup.apps` : est obligatoire. Activez la sauvegarde des applications Yunohost en mettant la valeur à `True`.
|
||||||
|
- `src_script`: il s'agit du chemin absolu où le fichier de template se situe sur la machine qui exécute Ansible. Par défaut, il sera stocké dans `templates/ynh_backup.sh.j2`.
|
||||||
|
- `dest_script`: il s'agit du répertoire où le fichier de template va être stocké. Par défaut, il sera stocké dans `/usr/local/bin/`. Le script s'appelle `ynh_backup.sh`.
|
||||||
|
|
||||||
|
## Dépendances
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
Aucune.
|
||||||
|
|
||||||
|
## Exemple de Playbook
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
```yml
|
||||||
|
---
|
||||||
|
- name: Configure Yunohost backups
|
||||||
|
hosts: all
|
||||||
|
become: True
|
||||||
|
collections:
|
||||||
|
- lydra.yunohost
|
||||||
|
roles:
|
||||||
|
- ynh_backup
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
[](https://choosealicense.com/licenses/gpl-3.0/)
|
||||||
|
|
||||||
|
**ansible-yunohost** est maintenu par [Lydra](https://lydra.fr/) et publié sous la licence GPL3.
|
||||||
74
roles/ynh_backup/README.md
Normal file
74
roles/ynh_backup/README.md
Normal file
|
|
@ -0,0 +1,74 @@
|
||||||
|
# Ansible Role: Yunohost
|
||||||
|
|
||||||
|
[🇫🇷 French version](README-FR.md)
|
||||||
|
|
||||||
|
Deploy [Yunohost](https://yunohost.org/#/) with Ansible!
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
Yunohost needs to be installed on your server.
|
||||||
|
|
||||||
|
## Role Variables
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
Default variables are available in `default/main.yml` however it is necessary to override them according to your needs for ...
|
||||||
|
|
||||||
|
### Backups management
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
```yml
|
||||||
|
ynh_backup:
|
||||||
|
scheduled: True
|
||||||
|
directory: "/data/backup"
|
||||||
|
scheduled_hour: "*"
|
||||||
|
scheduled_minute: "*/30"
|
||||||
|
scheduled_weekday: "*"
|
||||||
|
scheduled_month: "*"
|
||||||
|
system: True
|
||||||
|
apps: True
|
||||||
|
src_script: "templates/ynh_backup.sh.j2"
|
||||||
|
dest_script: "/usr/bin"
|
||||||
|
```
|
||||||
|
|
||||||
|
The backup task will allow to backup Yunohost applications and their data by setting up a cron job.
|
||||||
|
|
||||||
|
- `ynh_backup.scheduled`: to enable the Yunohost applications backup feature, set the value to `True`.
|
||||||
|
- `ynh_backup.directory`: the default backup folder is `/home/yunohost.backup/archives` however you can choose to save the backups in another folder with this variable. In this case, in order to be able to restore the backups from the web interface, Yunohost automatically creates a symbolic link from the created archive to its default folder.
|
||||||
|
- `ynh_backup.scheduled_[hour|minute|weekday|month]`: modifies the scheduling of the cron task. By default it will run every day of the year at 1am. For more information about cron time settings, this tool can be useful: <https://crontab.guru/>.
|
||||||
|
- `ynh_backup.system` : is mandatory. Enables automatic backup of the Yunohost system by setting the value to `True`.
|
||||||
|
- `ynh_backup.apps` : est obligatoire. Enables automatic backup of Yunohost applications by setting the value to `True`.
|
||||||
|
- `src_script`: this is the absolute path where the template file is located on the machine running Ansible. By default is will be stored in `templates/ynh_backup.sh.j2`.
|
||||||
|
- `dest_script`: this is the directory where the template file will be stored. By default is will be stored in `/usr/local/bin`. The script is named `ynh_backup.sh`.
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
None.
|
||||||
|
|
||||||
|
## Example Playbook
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
```yml
|
||||||
|
---
|
||||||
|
- name: Configure Yunohost backups
|
||||||
|
hosts: all
|
||||||
|
become: True
|
||||||
|
collections:
|
||||||
|
- lydra.yunohost
|
||||||
|
roles:
|
||||||
|
- ynh_backup
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
[](https://choosealicense.com/licenses/gpl-3.0/)
|
||||||
|
|
||||||
|
**ansible-yunohost** is maintained by [Lydra](https://lydra.fr/) and released under the GPL3 license.
|
||||||
32
roles/ynh_backup/defaults/main.yml
Normal file
32
roles/ynh_backup/defaults/main.yml
Normal file
|
|
@ -0,0 +1,32 @@
|
||||||
|
---
|
||||||
|
#-----------------------------------------------------------------------------#
|
||||||
|
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
||||||
|
# Copyright 2021-present Lydra https://www.lydra.fr/ #
|
||||||
|
# #
|
||||||
|
# this program is free software: you can redistribute it and/or modify #
|
||||||
|
# it under the terms of the GNU General Public License as published by #
|
||||||
|
# the Free Software Foundation, either version 3 of the License, or #
|
||||||
|
# (at your option) any later version. #
|
||||||
|
# #
|
||||||
|
# this program is distributed in the hope that it will be useful, #
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of #
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
|
||||||
|
# GNU General Public License for more details. #
|
||||||
|
# #
|
||||||
|
# You should have received a copy of the GNU General Public License #
|
||||||
|
# along with this program. If not, see <http://www.gnu.org/licenses/>. #
|
||||||
|
# #
|
||||||
|
#-----------------------------------------------------------------------------#
|
||||||
|
|
||||||
|
# Variables for backup
|
||||||
|
ynh_backup:
|
||||||
|
scheduled: False
|
||||||
|
# directory: "/data/backup"
|
||||||
|
# scheduled_hour: 3
|
||||||
|
# scheduled_minute: "0"
|
||||||
|
# scheduled_weekday: "*"
|
||||||
|
# scheduled_month: "*"
|
||||||
|
# system: True
|
||||||
|
# apps: True
|
||||||
|
# src_script: "templates/ynh_backup.sh.j2"
|
||||||
|
# dest_script: "/usr/local/bin/"
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
---
|
---
|
||||||
galaxy_info:
|
galaxy_info:
|
||||||
role_name: yunohost
|
role_name: ynh_backup
|
||||||
author: lydra
|
author: lydra
|
||||||
description: Deploy Yunohost with Ansible
|
description: Backup Yunohost with Ansible
|
||||||
license: GPL-v3
|
license: GPL-v3
|
||||||
min_ansible_version: 2.10
|
min_ansible_version: 2.10
|
||||||
github_branch: main
|
github_branch: main
|
||||||
52
roles/ynh_backup/tasks/backup.yml
Normal file
52
roles/ynh_backup/tasks/backup.yml
Normal file
|
|
@ -0,0 +1,52 @@
|
||||||
|
---
|
||||||
|
#-----------------------------------------------------------------------------#
|
||||||
|
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
||||||
|
# Copyright 2021-present Lydra https://www.lydra.fr/ #
|
||||||
|
# #
|
||||||
|
# this program is free software: you can redistribute it and/or modify #
|
||||||
|
# it under the terms of the GNU General Public License as published by #
|
||||||
|
# the Free Software Foundation, either version 3 of the License, or #
|
||||||
|
# (at your option) any later version. #
|
||||||
|
# #
|
||||||
|
# this program is distributed in the hope that it will be useful, #
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of #
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
|
||||||
|
# GNU General Public License for more details. #
|
||||||
|
# #
|
||||||
|
# You should have received a copy of the GNU General Public License #
|
||||||
|
# along with this program. If not, see <http://www.gnu.org/licenses/>. #
|
||||||
|
# #
|
||||||
|
#-----------------------------------------------------------------------------#
|
||||||
|
|
||||||
|
- name: Create backup folder
|
||||||
|
ansible.builtin.file:
|
||||||
|
path: "{{ ynh_backup.directory | default('/home/yunohost.backup/archives') }}"
|
||||||
|
state: directory
|
||||||
|
mode: '0750'
|
||||||
|
tags:
|
||||||
|
- backup
|
||||||
|
|
||||||
|
- name: Create backup script
|
||||||
|
ansible.builtin.template:
|
||||||
|
src: "{{ ynh_backup.src_script | default('templates/ynh_backup.sh.j2') }}"
|
||||||
|
dest: "{{ ynh_backup.dest_script | default('/usr/local/bin/') }}ynh_backup.sh"
|
||||||
|
owner: root
|
||||||
|
group: root
|
||||||
|
mode: '0740'
|
||||||
|
tags:
|
||||||
|
- backup
|
||||||
|
- cron
|
||||||
|
|
||||||
|
- name: Create cron task to perform YNH backup
|
||||||
|
ansible.builtin.cron:
|
||||||
|
name: "auto-backup to {{ ynh_backup.directory | default('/home/yunohost.backup/archives') }}"
|
||||||
|
month: "{{ ynh_backup.scheduled_month | default('*') }}"
|
||||||
|
weekday: "{{ ynh_backup.scheduled_weekday | default('*') }}"
|
||||||
|
hour: "{{ ynh_backup.scheduled_hour | default('1') }}"
|
||||||
|
minute: "{{ ynh_backup.scheduled_minute | default('0') }}"
|
||||||
|
user: root
|
||||||
|
job: "{{ ynh_backup.dest_script | default('/usr/local/bin/') }}ynh_backup.sh"
|
||||||
|
cron_file: ynh_backup_cron
|
||||||
|
tags:
|
||||||
|
- backup
|
||||||
|
- cron
|
||||||
25
roles/ynh_backup/tasks/main.yml
Normal file
25
roles/ynh_backup/tasks/main.yml
Normal file
|
|
@ -0,0 +1,25 @@
|
||||||
|
---
|
||||||
|
#-----------------------------------------------------------------------------#
|
||||||
|
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
||||||
|
# Copyright 2021-present Lydra https://www.lydra.fr/ #
|
||||||
|
# #
|
||||||
|
# this program is free software: you can redistribute it and/or modify #
|
||||||
|
# it under the terms of the GNU General Public License as published by #
|
||||||
|
# the Free Software Foundation, either version 3 of the License, or #
|
||||||
|
# (at your option) any later version. #
|
||||||
|
# #
|
||||||
|
# this program is distributed in the hope that it will be useful, #
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of #
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
|
||||||
|
# GNU General Public License for more details. #
|
||||||
|
# #
|
||||||
|
# You should have received a copy of the GNU General Public License #
|
||||||
|
# along with this program. If not, see <http://www.gnu.org/licenses/>. #
|
||||||
|
# #
|
||||||
|
#-----------------------------------------------------------------------------#
|
||||||
|
|
||||||
|
- name: Enable Yunohost apps backup
|
||||||
|
ansible.builtin.include_tasks: backup.yml
|
||||||
|
when: ynh_backup.scheduled
|
||||||
|
tags:
|
||||||
|
- backup
|
||||||
8
roles/ynh_backup/templates/ynh_backup.sh.j2
Normal file
8
roles/ynh_backup/templates/ynh_backup.sh.j2
Normal file
|
|
@ -0,0 +1,8 @@
|
||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
yunohost backup create {% if ynh_backup.system %}--system{% endif %}{% if ynh_backup.apps %} --apps{% endif %}{% if ynh_backup.directory %} --output-directory {{ ynh_backup.directory }}/backup_$(date +%Y%m%d_%H%M) {% endif %}
|
||||||
|
|
||||||
|
{% if ynh_backup.system is false and ynh_backup.apps is false %}
|
||||||
|
echo "Read the readme to know more about vars ynh_backup.system and ynh_backup.apps"
|
||||||
|
exit 1
|
||||||
|
{% endif %}
|
||||||
86
roles/ynh_config/README-FR.md
Normal file
86
roles/ynh_config/README-FR.md
Normal file
|
|
@ -0,0 +1,86 @@
|
||||||
|
# Rôle Ansible : Yunohost Configuration
|
||||||
|
|
||||||
|
[🇬🇧 English version](README.md)
|
||||||
|
|
||||||
|
Configurez [Yunohost](https://yunohost.org/#/) avec Ansible !
|
||||||
|
|
||||||
|
## Prérequis
|
||||||
|
|
||||||
|
Yunohost doit déjà être installé sur votre serveur.
|
||||||
|
|
||||||
|
## Variables du rôle
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
Les variables par défaut sont disponibles dans `default/main.yml` cependant il est possible de les surcharger selon vos besoins.
|
||||||
|
|
||||||
|
### Configuration d'un relais SMTP
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
```yml
|
||||||
|
# paramètres personnalisés du relais SMTP
|
||||||
|
ynh_smtp_relay:
|
||||||
|
host: smtp.domain.tld
|
||||||
|
port: 25
|
||||||
|
user: user1
|
||||||
|
password: Pa$$w0rd
|
||||||
|
```
|
||||||
|
|
||||||
|
Yunohost possède son propre serveur SMTP natif mais il est aussi possible de configurer Yunohost pour qu'il utilise un relais SMTP à la place.
|
||||||
|
Pour faire cela, créez la variable `ynh_smtp_relay` et mettez vos propres valeurs. Vous pouvez en apprendre plus sur les relais SMTP [ici](https://yunohost.org/fr/administrate/specific_use_cases/email_relay).
|
||||||
|
|
||||||
|
### Concernant les mises à jour
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
```yml
|
||||||
|
# Autoupdate Yunohost and its apps
|
||||||
|
ynh_autoupdate:
|
||||||
|
scheduled: True
|
||||||
|
special_time: "daily" #Choices are [annually,daily,hourly,monthly,reboot,weekly,yearly]
|
||||||
|
apps: True
|
||||||
|
system: True
|
||||||
|
dest_script: "/usr/bin/"
|
||||||
|
```
|
||||||
|
|
||||||
|
Une tâche cron peut être mise en place pour automatiser la vérification des mises à jour système et applications suivant la périodicité de votre choix.
|
||||||
|
|
||||||
|
- `ynh_autoupdate.scheduled` : activez la tâche cron en mettant la valeur à `True`.
|
||||||
|
- `ynh_autoupdate.special_time`: est obligatoire. Elle permet de préciser quand vous souhaitez que cette tâche soit exécutée. Valeurs possibles : (`annually`,`daily`,`hourly`,`monthly`,`reboot`,`weekly`,`yearly`). Pour en savoir plus sur les _special times_, cliquez [ici](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/cron_module.html).
|
||||||
|
- `ynh_autoupdate.apps` : est obligatoire. Activez la mise à jour automatique des applications Yunohost en mettant la valeur à `True`.
|
||||||
|
- `ynh_autoupdate.system` : est obligatoire. Activez la mise à jour automatique du système Yunohost en mettant la valeur à `True`.
|
||||||
|
- `ynh_autoupdate.dest_script` : c'est le chemin du répertoire où le script de mise à jour sera installé sur le serveur. La valeur par défaut est `/usr/local/bin`. Le script s'appelle `ynh_autoupdate.sh`.
|
||||||
|
|
||||||
|
Si des mises à jour sont disponibles, elles sont faites automatiquement. En cas de problème suite à la mise à jour d'une application, vous pouvez lire les logs qui sont disponibles ici `/var/log/yunohost/categories/operation`. Vous avez aussi la possibilité de revenir à la version précédente car Yunohost fait toujours une sauvegarde automatique d'une application lorsqu'elle est mise à jour.
|
||||||
|
|
||||||
|
Pour en savoir plus sur le fonctionnement des mises à jour dans Yunohost vous pouvez vous rendre [ici](https://yunohost.org/fr/update). Le changelog des versions de Yunohost est aussi disponible [ici](https://forum.yunohost.org/tag/ynh_release).
|
||||||
|
|
||||||
|
## Dépendances
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
Aucune.
|
||||||
|
|
||||||
|
## Exemple de Playbook
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
```yml
|
||||||
|
---
|
||||||
|
- name: Configure Yunohost on Debian Server
|
||||||
|
hosts: all
|
||||||
|
become: True
|
||||||
|
collections:
|
||||||
|
- lydra.yunohost
|
||||||
|
roles:
|
||||||
|
- ynh_config
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
[](https://choosealicense.com/licenses/gpl-3.0/)
|
||||||
|
|
||||||
|
**ansible-yunohost** est maintenu par [Lydra](https://lydra.fr/) et publié sous la licence GPL3.
|
||||||
88
roles/ynh_config/README.md
Normal file
88
roles/ynh_config/README.md
Normal file
|
|
@ -0,0 +1,88 @@
|
||||||
|
# Ansible Role: Yunohost
|
||||||
|
|
||||||
|
[🇫🇷 French version](README-FR.md)
|
||||||
|
|
||||||
|
Deploy [Yunohost](https://yunohost.org/#/) with Ansible!
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
None.
|
||||||
|
|
||||||
|
## Role Variables
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### SMTP relay configuration
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
```yml
|
||||||
|
# SMTP custom settings
|
||||||
|
ynh_smtp_relay:
|
||||||
|
host: smtp.domain.tld
|
||||||
|
port: 25
|
||||||
|
user: user1
|
||||||
|
password: Pa$$w0rd
|
||||||
|
```
|
||||||
|
|
||||||
|
There is a built-in SMTP server on Yunohost but you can also set up Yunohost to use a SMTP relay instead.
|
||||||
|
In order to do so, create the `ynh_smtp_relay` variable and provide your own values. You can learn more about SMTP relay [here](https://yunohost.org/en/administrate/specific_use_cases/email_relay).
|
||||||
|
|
||||||
|
### About the updates
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
```yml
|
||||||
|
# Autoupdate Yunohost and its apps
|
||||||
|
ynh_autoupdate:
|
||||||
|
scheduled: True
|
||||||
|
special_time: "daily" #Choices are [annually,daily,hourly,monthly,reboot,weekly,yearly]
|
||||||
|
apps: True
|
||||||
|
system: True
|
||||||
|
dest_script: "/usr/bin/"
|
||||||
|
```
|
||||||
|
|
||||||
|
A cron job can been set up to automate the check for system and application updates on a schedule of your choice.
|
||||||
|
|
||||||
|
- `ynh_autoupdate.scheduled` : enables the cron job by setting the value to `True`.
|
||||||
|
- `ynh_autoupdate.special_time`: it is mandatory. It allows you to specify when you want this task to be executed. Possible values: (`annually`,`daily`,`hourly`,`monthly`,`reboot`,`weekly`,`yearly`). To learn more about special times, click [here](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/cron_module.html).
|
||||||
|
- `ynh_autoupdate.apps`: is mandatory. Enables automatic updating of Yunohost applications by setting the value to `True`.
|
||||||
|
- `ynh_autoupdate.system`: is mandatory. Enables automatic updating of the Yunohost system by setting the value to `True`.
|
||||||
|
- `ynh_autoupdate.dest_script`: it is the path to the directory where the update script will be installed on the server. The default value is `/usr/local/bin`. The script is named `ynh_autoupdate.sh`.
|
||||||
|
|
||||||
|
If available, updates are done automatically. In case of problems following an application update, you can read logs located in `/var/log/yunohost/categories/operation` . You also have the possibility to rollback to the previous version since Yunohost always makes an automatic backup of an application when it is updated.
|
||||||
|
|
||||||
|
To learn more about how updates work in Yunohost you can go [here](https://yunohost.org/fr/update). The changelog of Yunohost versions is also available [here](https://forum.yunohost.org/tag/ynh_release).
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
None.
|
||||||
|
|
||||||
|
## Example Playbook
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
```yml
|
||||||
|
---
|
||||||
|
- name: Configure Yunohost on Debian Server
|
||||||
|
hosts: all
|
||||||
|
become: True
|
||||||
|
collections:
|
||||||
|
- lydra.yunohost
|
||||||
|
roles:
|
||||||
|
- ynh_config
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
[](https://choosealicense.com/licenses/gpl-3.0/)
|
||||||
|
|
||||||
|
**ansible-yunohost** is maintained by [Lydra](https://lydra.fr/) and released under the GPL3 license.
|
||||||
40
roles/ynh_config/defaults/main.yml
Normal file
40
roles/ynh_config/defaults/main.yml
Normal file
|
|
@ -0,0 +1,40 @@
|
||||||
|
---
|
||||||
|
#-----------------------------------------------------------------------------#
|
||||||
|
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
||||||
|
# Copyright 2021-present Lydra https://www.lydra.fr/ #
|
||||||
|
# #
|
||||||
|
# this program is free software: you can redistribute it and/or modify #
|
||||||
|
# it under the terms of the GNU General Public License as published by #
|
||||||
|
# the Free Software Foundation, either version 3 of the License, or #
|
||||||
|
# (at your option) any later version. #
|
||||||
|
# #
|
||||||
|
# this program is distributed in the hope that it will be useful, #
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of #
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
|
||||||
|
# GNU General Public License for more details. #
|
||||||
|
# #
|
||||||
|
# You should have received a copy of the GNU General Public License #
|
||||||
|
# along with this program. If not, see <http://www.gnu.org/licenses/>. #
|
||||||
|
# #
|
||||||
|
#-----------------------------------------------------------------------------#
|
||||||
|
|
||||||
|
# Do not touch this variable
|
||||||
|
# Just to have dict default value
|
||||||
|
ynh_smtp_relay:
|
||||||
|
value: null
|
||||||
|
|
||||||
|
# SMTP custom settings (Only override if you need a SMTP relay)
|
||||||
|
# Example:
|
||||||
|
# ynh_smtp_relay:
|
||||||
|
# host: smtp.domain.tld
|
||||||
|
# port: "25"
|
||||||
|
# user: user1
|
||||||
|
# password: Pa$$w0rd
|
||||||
|
|
||||||
|
# Autoupdate Yunohost and its apps
|
||||||
|
ynh_autoupdate:
|
||||||
|
scheduled: False
|
||||||
|
# special_time: "daily" #Choices are [annually,daily,hourly,monthly,reboot,weekly,yearly]
|
||||||
|
# apps: True
|
||||||
|
# system: True
|
||||||
|
# dest_script: "/usr/local/bin/"
|
||||||
18
roles/ynh_config/meta/main.yml
Normal file
18
roles/ynh_config/meta/main.yml
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
---
|
||||||
|
galaxy_info:
|
||||||
|
role_name: ynh_config
|
||||||
|
author: lydra
|
||||||
|
description: Configure Yunohost with Ansible
|
||||||
|
license: GPL-v3
|
||||||
|
min_ansible_version: 2.10
|
||||||
|
github_branch: main
|
||||||
|
platforms:
|
||||||
|
- name: Debian
|
||||||
|
versions:
|
||||||
|
- buster
|
||||||
|
galaxy_tags:
|
||||||
|
- yunohost
|
||||||
|
- cloud
|
||||||
|
- web
|
||||||
|
|
||||||
|
dependencies: []
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
#-----------------------------------------------------------------------------#
|
#-----------------------------------------------------------------------------#
|
||||||
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
||||||
# Copyright 2021-2021 Lydra https://www.lydra.fr/ #
|
# Copyright 2021-present Lydra https://www.lydra.fr/ #
|
||||||
# #
|
# #
|
||||||
# this program is free software: you can redistribute it and/or modify #
|
# this program is free software: you can redistribute it and/or modify #
|
||||||
# it under the terms of the GNU General Public License as published by #
|
# it under the terms of the GNU General Public License as published by #
|
||||||
|
|
@ -25,6 +25,10 @@
|
||||||
owner: root
|
owner: root
|
||||||
group: root
|
group: root
|
||||||
mode: '0740'
|
mode: '0740'
|
||||||
|
tags:
|
||||||
|
- yunohost
|
||||||
|
- update
|
||||||
|
- cron
|
||||||
|
|
||||||
- name: Creates cron task under /etc/cron.d to auto-update Yunohost
|
- name: Creates cron task under /etc/cron.d to auto-update Yunohost
|
||||||
ansible.builtin.cron:
|
ansible.builtin.cron:
|
||||||
|
|
@ -34,3 +38,7 @@
|
||||||
user: root
|
user: root
|
||||||
job: "{{ ynh_autoupdate.dest_script | default('/usr/local/bin/') }}ynh_autoupdate.sh"
|
job: "{{ ynh_autoupdate.dest_script | default('/usr/local/bin/') }}ynh_autoupdate.sh"
|
||||||
cron_file: ynh_autoupdate_cron
|
cron_file: ynh_autoupdate_cron
|
||||||
|
tags:
|
||||||
|
- yunohost
|
||||||
|
- update
|
||||||
|
- cron
|
||||||
34
roles/ynh_config/tasks/main.yml
Normal file
34
roles/ynh_config/tasks/main.yml
Normal file
|
|
@ -0,0 +1,34 @@
|
||||||
|
---
|
||||||
|
#-----------------------------------------------------------------------------#
|
||||||
|
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
||||||
|
# Copyright 2021-present Lydra https://www.lydra.fr/ #
|
||||||
|
# #
|
||||||
|
# this program is free software: you can redistribute it and/or modify #
|
||||||
|
# it under the terms of the GNU General Public License as published by #
|
||||||
|
# the Free Software Foundation, either version 3 of the License, or #
|
||||||
|
# (at your option) any later version. #
|
||||||
|
# #
|
||||||
|
# this program is distributed in the hope that it will be useful, #
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of #
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
|
||||||
|
# GNU General Public License for more details. #
|
||||||
|
# #
|
||||||
|
# You should have received a copy of the GNU General Public License #
|
||||||
|
# along with this program. If not, see <http://www.gnu.org/licenses/>. #
|
||||||
|
# #
|
||||||
|
#-----------------------------------------------------------------------------#
|
||||||
|
|
||||||
|
- name: Configure SMTP relay
|
||||||
|
ansible.builtin.include_tasks: smtp_relay.yml
|
||||||
|
loop: "{{ ynh_smtp_relay | dict2items }}"
|
||||||
|
when: item.value
|
||||||
|
tags:
|
||||||
|
- yunohost
|
||||||
|
- smtp
|
||||||
|
|
||||||
|
- name: Configures Yunohost autoupdate
|
||||||
|
ansible.builtin.include_tasks: autoupdate.yml
|
||||||
|
when: ynh_autoupdate.scheduled
|
||||||
|
tags:
|
||||||
|
- yunohost
|
||||||
|
- update
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
#-----------------------------------------------------------------------------#
|
#-----------------------------------------------------------------------------#
|
||||||
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
||||||
# Copyright 2021-2021 Lydra https://www.lydra.fr/ #
|
# Copyright 2021-present Lydra https://www.lydra.fr/ #
|
||||||
# #
|
# #
|
||||||
# this program is free software: you can redistribute it and/or modify #
|
# this program is free software: you can redistribute it and/or modify #
|
||||||
# it under the terms of the GNU General Public License as published by #
|
# it under the terms of the GNU General Public License as published by #
|
||||||
|
|
@ -23,8 +23,14 @@
|
||||||
"yunohost settings get smtp.relay.{{ item.key }}"
|
"yunohost settings get smtp.relay.{{ item.key }}"
|
||||||
register: _ynh_smtp_current_values
|
register: _ynh_smtp_current_values
|
||||||
changed_when: False
|
changed_when: False
|
||||||
|
tags:
|
||||||
|
- yunohost
|
||||||
|
- smtp
|
||||||
|
|
||||||
- name: Set new SMTP settings
|
- name: Set new SMTP settings
|
||||||
ansible.builtin.command:
|
ansible.builtin.command:
|
||||||
"yunohost settings set smtp.relay.{{ item.key }} -v {{ item.value }}"
|
"yunohost settings set smtp.relay.{{ item.key }} -v {{ item.value }}"
|
||||||
when: _ynh_smtp_current_values.stdout != item.value
|
when: _ynh_smtp_current_values.stdout != item.value
|
||||||
|
tags:
|
||||||
|
- yunohost
|
||||||
|
- smtp
|
||||||
142
roles/ynh_setup/README-FR.md
Normal file
142
roles/ynh_setup/README-FR.md
Normal file
|
|
@ -0,0 +1,142 @@
|
||||||
|
# Rôle Ansible : Yunohost
|
||||||
|
|
||||||
|
[🇬🇧 English version](README.md)
|
||||||
|
|
||||||
|
Déployez [Yunohost](https://yunohost.org/#/) avec Ansible !
|
||||||
|
|
||||||
|
## Prérequis
|
||||||
|
|
||||||
|
Aucun.
|
||||||
|
|
||||||
|
## Variables du rôle
|
||||||
|
|
||||||
|
Les variables par défaut sont disponibles dans `default/main.yml` cependant il est nécessaire de les surcharger selon vos besoins en termes de domaines, d'utilisateurs et d'applications sur Yunohost.
|
||||||
|
|
||||||
|
### Installation de Yunohost
|
||||||
|
|
||||||
|
```yml
|
||||||
|
# Script pour Debian 10 uniquement.
|
||||||
|
ynh_install_script_url: https://install.yunohost.org
|
||||||
|
|
||||||
|
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_admin_password` est le mot de passe permettant d'accéder à l’interface d’administration du serveur.
|
||||||
|
|
||||||
|
### Gestion des domaines
|
||||||
|
|
||||||
|
```yml
|
||||||
|
# Liste des domaines gérés par Yunohost.
|
||||||
|
ynh_main_domain: domain.tld
|
||||||
|
ynh_extra_domains:
|
||||||
|
- forum.domain.tld
|
||||||
|
- wiki.domain.tld
|
||||||
|
ynh_ignore_dyndns_server: False
|
||||||
|
```
|
||||||
|
|
||||||
|
- `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 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)).
|
||||||
|
|
||||||
|
### Gestion des utilisateurs
|
||||||
|
|
||||||
|
```yml
|
||||||
|
# Liste des utilisateurs Yunohost.
|
||||||
|
ynh_users:
|
||||||
|
- name: user1
|
||||||
|
pass: MYINSECUREPWD_PLZ_OVERRIDE_THIS
|
||||||
|
firstname: Jane
|
||||||
|
lastname: Doe
|
||||||
|
mail_domain: domain.tld
|
||||||
|
```
|
||||||
|
|
||||||
|
- `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
|
||||||
|
|
||||||
|
```yml
|
||||||
|
# Liste des applications Yunohost.
|
||||||
|
ynh_apps:
|
||||||
|
- label: WikiJS
|
||||||
|
link: wikijs
|
||||||
|
args:
|
||||||
|
domain: wiki.domain.tld
|
||||||
|
path: /
|
||||||
|
admin: user1
|
||||||
|
is_public: no
|
||||||
|
- label: Discourse
|
||||||
|
link: discourse
|
||||||
|
args:
|
||||||
|
domain: forum.domain.tld
|
||||||
|
path: /
|
||||||
|
admin: user1
|
||||||
|
is_public: yes
|
||||||
|
post_install:
|
||||||
|
- src: "templates/site_settings.yml.j2"
|
||||||
|
dest: "/var/www/discourse/config/site_settings.yml"
|
||||||
|
type: "config"
|
||||||
|
|
||||||
|
- src: "templates/configure_discourse.sh.j2"
|
||||||
|
dest: "/tmp/configure_discourse.sh"
|
||||||
|
type: "script"
|
||||||
|
owner: root
|
||||||
|
group: root
|
||||||
|
```
|
||||||
|
|
||||||
|
- `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 obligatoire. Il faut choisir un des domaines de son instance Yunohost.
|
||||||
|
- `path` est obligatoire. 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).
|
||||||
|
|
||||||
|
#### Concernant la post-installation
|
||||||
|
|
||||||
|
Il est possible de compléter l'installation des applications par l'ajout de templates jinja de configuration ou de scripts que vous aurez écrit de votre côté.
|
||||||
|
Pour activer cette fonctionnalité, définissez la variable `post_install` qui correspond à la liste des fichiers de post-installation de votre application.
|
||||||
|
Cette tâche utilisant le module template, vous pouvez tout à fait utiliser vos propres variables et les appeler dans vos fichiers de template. Pour en savoir sur ce module, cliquez [ici](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/template_module.html).
|
||||||
|
|
||||||
|
- `src` est obligatoire. Il s'agit du répertoire où le fichier de template se situe sur la machine qui execute Ansible.
|
||||||
|
- `dest` est obligatoire. Il s'agit du répertoire où le fichier de template va être stocké.
|
||||||
|
- `type` est obligatoire :
|
||||||
|
- Si vous précisez comme valeur `script` alors le fichier de template aura pour droits 740. Il sera exécuté après son transfert sur le serveur Yunohost (généralement dans `/tmp/`) puis il sera supprimé.
|
||||||
|
- Si vous précisez comme valeur `config` alors le fichier de template aura pour droits 660. Il sera transféré sur le serveur Yunohost (généralement dans `/var/www/AppName/`) et vous pourrez l'importer avec un script shell à côté par exemple.
|
||||||
|
|
||||||
|
Pour `owner` et `group`, par défaut le fichier va prendre comme utilisateur propriétaire le nom de l'application et comme groupe propriétaire www-data (groupe NGINX). Vous pouvez les changer en précisant des valeurs différentes.
|
||||||
|
|
||||||
|
## Dépendances
|
||||||
|
|
||||||
|
Aucune.
|
||||||
|
|
||||||
|
## Exemple de Playbook
|
||||||
|
|
||||||
|
```yml
|
||||||
|
---
|
||||||
|
- name: Install Yunohost on Debian Server
|
||||||
|
hosts: all
|
||||||
|
become: True
|
||||||
|
collections:
|
||||||
|
- lydra.yunohost
|
||||||
|
pre_tasks:
|
||||||
|
- name: Update all packages and index
|
||||||
|
ansible.builtin.apt:
|
||||||
|
upgrade: dist
|
||||||
|
update_cache: yes
|
||||||
|
|
||||||
|
roles:
|
||||||
|
- ynh_setup
|
||||||
|
- ynh_config
|
||||||
|
- ynh_backup
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
[](https://choosealicense.com/licenses/gpl-3.0/)
|
||||||
|
|
||||||
|
**ansible-yunohost** est maintenu par [Lydra](https://lydra.fr/) et publié sous la licence GPL3.
|
||||||
142
roles/ynh_setup/README.md
Normal file
142
roles/ynh_setup/README.md
Normal file
|
|
@ -0,0 +1,142 @@
|
||||||
|
# Ansible Role: Yunohost
|
||||||
|
|
||||||
|
[🇫🇷 French version](README-FR.md)
|
||||||
|
|
||||||
|
Deploy [Yunohost](https://yunohost.org/#/) with Ansible!
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
None.
|
||||||
|
|
||||||
|
## Role Variables
|
||||||
|
|
||||||
|
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
|
||||||
|
# Debian 10 script only.
|
||||||
|
ynh_install_script_url: https://install.yunohost.org
|
||||||
|
|
||||||
|
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_admin_password` is the password used to access to the server's administration interface.
|
||||||
|
|
||||||
|
### Domain management
|
||||||
|
|
||||||
|
```yml
|
||||||
|
# The list of Yunohost domains.
|
||||||
|
ynh_main_domain: domain.tld
|
||||||
|
ynh_extra_domains:
|
||||||
|
- forum.domain.tld
|
||||||
|
- wiki.domain.tld
|
||||||
|
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_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)).
|
||||||
|
|
||||||
|
### User management
|
||||||
|
|
||||||
|
```yml
|
||||||
|
# The list of Yunohost users.
|
||||||
|
ynh_users:
|
||||||
|
- name: user1
|
||||||
|
pass: MYINSECUREPWD_PLZ_OVERRIDE_THIS
|
||||||
|
firstname: Jane
|
||||||
|
lastname: Doe
|
||||||
|
mail_domain: domain.tld
|
||||||
|
```
|
||||||
|
|
||||||
|
- `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
|
||||||
|
# The list of Yunohost apps.
|
||||||
|
ynh_apps:
|
||||||
|
- label: WikiJS
|
||||||
|
link: wikijs
|
||||||
|
args:
|
||||||
|
domain: wiki.domain.tld
|
||||||
|
path: /
|
||||||
|
admin: user1
|
||||||
|
is_public: no
|
||||||
|
- label: Discourse
|
||||||
|
link: discourse
|
||||||
|
args:
|
||||||
|
domain: forum.domain.tld
|
||||||
|
path: /
|
||||||
|
admin: user1
|
||||||
|
is_public: yes
|
||||||
|
post_install:
|
||||||
|
- src: "templates/site_settings.yml.j2"
|
||||||
|
dest: "/var/www/discourse/config/site_settings.yml"
|
||||||
|
type: "config"
|
||||||
|
|
||||||
|
- src: "templates/configure_discourse.sh.j2"
|
||||||
|
dest: "/tmp/configure_discourse.sh"
|
||||||
|
type: "script"
|
||||||
|
owner: root
|
||||||
|
group: root
|
||||||
|
```
|
||||||
|
|
||||||
|
- `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).
|
||||||
|
|
||||||
|
#### About the post-installation
|
||||||
|
|
||||||
|
It is possible to complete the installation of applications by adding jinja template configuration files or scripts written by yourself.
|
||||||
|
To enable this feature, define the `post_install` variable which corresponds to the list of post-installation files of your applications.
|
||||||
|
Because this task uses the template module, you can use your own variables and call them in your template files. To know more about this module, click [here](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/template_module.html).
|
||||||
|
|
||||||
|
- `src` is mandatory. This is the directory where the template file is located on the machine running Ansible.
|
||||||
|
- `dest` is mandatory. This is the directory where the template file will be stored.
|
||||||
|
- `type` is mandatory:
|
||||||
|
- If you specify `script` as the value, then the template file will have 740 rights. It will be executed after it is transferred to the Yunohost server (usually in `/tmp/`) and then deleted.
|
||||||
|
- If you specify `config` as the value, then the template file will have 660 rights. It will be transferred to the Yunohost server (usually in `/var/www/AppName/`) and after you could import it with a shell script on the side for example.
|
||||||
|
|
||||||
|
For `owner` and `group`, by default the file will take as owner the name of the application and as owner www-data(NGINX group). You can change them by specifying different values.
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
|
None.
|
||||||
|
|
||||||
|
## Example Playbook
|
||||||
|
|
||||||
|
```yml
|
||||||
|
---
|
||||||
|
- name: Install Yunohost on Debian Server
|
||||||
|
hosts: all
|
||||||
|
become: True
|
||||||
|
collections:
|
||||||
|
- lydra.yunohost
|
||||||
|
pre_tasks:
|
||||||
|
- name: Update all packages and index
|
||||||
|
ansible.builtin.apt:
|
||||||
|
upgrade: dist
|
||||||
|
update_cache: yes
|
||||||
|
|
||||||
|
roles:
|
||||||
|
- ynh_setup
|
||||||
|
- ynh_config
|
||||||
|
- ynh_backup
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
[](https://choosealicense.com/licenses/gpl-3.0/)
|
||||||
|
|
||||||
|
**ansible-yunohost** is maintained by [Lydra](https://lydra.fr/) and released under the GPL3 license.
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
#-----------------------------------------------------------------------------#
|
#-----------------------------------------------------------------------------#
|
||||||
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
||||||
# Copyright 2021-2021 Lydra https://www.lydra.fr/ #
|
# Copyright 2021-present Lydra https://www.lydra.fr/ #
|
||||||
# #
|
# #
|
||||||
# this program is free software: you can redistribute it and/or modify #
|
# this program is free software: you can redistribute it and/or modify #
|
||||||
# it under the terms of the GNU General Public License as published by #
|
# it under the terms of the GNU General Public License as published by #
|
||||||
|
|
@ -36,20 +36,7 @@ ynh_users: null
|
||||||
# lastname: Doe
|
# lastname: Doe
|
||||||
# mail_domain: domain.tld
|
# mail_domain: domain.tld
|
||||||
|
|
||||||
# Do not touch this variable
|
# The list of Yunohost apps.
|
||||||
# Just to have dict default value
|
|
||||||
ynh_smtp_relay:
|
|
||||||
value: null
|
|
||||||
|
|
||||||
# SMTP custom settings (Only override if you need a SMTP relay)
|
|
||||||
# Example:
|
|
||||||
# ynh_smtp_relay:
|
|
||||||
# host: smtp.domain.tld
|
|
||||||
# port: "25"
|
|
||||||
# user: user1
|
|
||||||
# password: Pa$$w0rd
|
|
||||||
|
|
||||||
# The list of Yunohost apps.
|
|
||||||
ynh_apps: null
|
ynh_apps: null
|
||||||
# - label: Tiny Tiny RSS
|
# - label: Tiny Tiny RSS
|
||||||
# link: ttrss
|
# link: ttrss
|
||||||
|
|
@ -62,11 +49,3 @@ ynh_apps: null
|
||||||
# type: script
|
# type: script
|
||||||
# owner: ttrss # Only provide if different from app name
|
# owner: ttrss # Only provide if different from app name
|
||||||
# group: ttrss # Only provide if different from www-data
|
# group: ttrss # Only provide if different from www-data
|
||||||
|
|
||||||
# Autoupdate Yunohost and its apps
|
|
||||||
ynh_autoupdate:
|
|
||||||
scheduled: False
|
|
||||||
# special_time: "daily" #Choices are [annually,daily,hourly,monthly,reboot,weekly,yearly]
|
|
||||||
# apps: True
|
|
||||||
# system: True
|
|
||||||
# dest_script: "/usr/local/bin/"
|
|
||||||
18
roles/ynh_setup/meta/main.yml
Normal file
18
roles/ynh_setup/meta/main.yml
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
---
|
||||||
|
galaxy_info:
|
||||||
|
role_name: ynh_setup
|
||||||
|
author: lydra
|
||||||
|
description: Install Yunohost with Ansible
|
||||||
|
license: GPL-v3
|
||||||
|
min_ansible_version: 2.10
|
||||||
|
github_branch: main
|
||||||
|
platforms:
|
||||||
|
- name: Debian
|
||||||
|
versions:
|
||||||
|
- buster
|
||||||
|
galaxy_tags:
|
||||||
|
- yunohost
|
||||||
|
- cloud
|
||||||
|
- web
|
||||||
|
|
||||||
|
dependencies: []
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
#-----------------------------------------------------------------------------#
|
#-----------------------------------------------------------------------------#
|
||||||
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
||||||
# Copyright 2021-2021 Lydra https://www.lydra.fr/ #
|
# Copyright 2021-present Lydra https://www.lydra.fr/ #
|
||||||
# #
|
# #
|
||||||
# this program is free software: you can redistribute it and/or modify #
|
# this program is free software: you can redistribute it and/or modify #
|
||||||
# it under the terms of the GNU General Public License as published by #
|
# it under the terms of the GNU General Public License as published by #
|
||||||
|
|
@ -24,6 +24,8 @@
|
||||||
--label "{{ ynh_app.label }}" \
|
--label "{{ ynh_app.label }}" \
|
||||||
--args "{% for key, value in ynh_app.args.items() %}{{ key }}={{ value }}{% if not loop.last %}&{% endif %}{% endfor %}"
|
--args "{% for key, value in ynh_app.args.items() %}{{ key }}={{ value }}{% if not loop.last %}&{% endif %}{% endfor %}"
|
||||||
changed_when: False
|
changed_when: False
|
||||||
|
tags:
|
||||||
|
- apps
|
||||||
|
|
||||||
# Post-installation part
|
# Post-installation part
|
||||||
- name: Create post-install template
|
- name: Create post-install template
|
||||||
|
|
@ -35,6 +37,8 @@
|
||||||
mode: "{{ (item.type == 'script') | ternary('740', '660') }}"
|
mode: "{{ (item.type == 'script') | ternary('740', '660') }}"
|
||||||
loop: "{{ ynh_app.post_install|default([]) }}"
|
loop: "{{ ynh_app.post_install|default([]) }}"
|
||||||
when: ynh_app.post_install
|
when: ynh_app.post_install
|
||||||
|
tags:
|
||||||
|
- apps
|
||||||
|
|
||||||
- name: Launch post-install script
|
- name: Launch post-install script
|
||||||
ansible.builtin.command: "{{ ynh_app_post_install.dest }}"
|
ansible.builtin.command: "{{ ynh_app_post_install.dest }}"
|
||||||
|
|
@ -44,6 +48,8 @@
|
||||||
loop_control:
|
loop_control:
|
||||||
loop_var: ynh_app_post_install
|
loop_var: ynh_app_post_install
|
||||||
when: ynh_app_post_install.type == "script"
|
when: ynh_app_post_install.type == "script"
|
||||||
|
tags:
|
||||||
|
- apps
|
||||||
|
|
||||||
- name: Remove script after execution
|
- name: Remove script after execution
|
||||||
ansible.builtin.file:
|
ansible.builtin.file:
|
||||||
|
|
@ -53,3 +59,5 @@
|
||||||
loop_control:
|
loop_control:
|
||||||
loop_var: ynh_app_post_install
|
loop_var: ynh_app_post_install
|
||||||
when: ynh_app_post_install.type == "script"
|
when: ynh_app_post_install.type == "script"
|
||||||
|
tags:
|
||||||
|
- apps
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
#-----------------------------------------------------------------------------#
|
#-----------------------------------------------------------------------------#
|
||||||
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
||||||
# Copyright 2021-2021 Lydra https://www.lydra.fr/ #
|
# Copyright 2021-present Lydra https://www.lydra.fr/ #
|
||||||
# #
|
# #
|
||||||
# this program is free software: you can redistribute it and/or modify #
|
# this program is free software: you can redistribute it and/or modify #
|
||||||
# it under the terms of the GNU General Public License as published by #
|
# it under the terms of the GNU General Public License as published by #
|
||||||
|
|
@ -22,9 +22,13 @@
|
||||||
ansible.builtin.command: yunohost app map --output-as json
|
ansible.builtin.command: yunohost app map --output-as json
|
||||||
register: ynh_installed_apps_raw
|
register: ynh_installed_apps_raw
|
||||||
changed_when: False
|
changed_when: False
|
||||||
|
tags:
|
||||||
|
- apps
|
||||||
|
|
||||||
- name: Format json of apps
|
- name: Format json of apps
|
||||||
ansible.builtin.set_fact: ynh_installed_apps="{{ ynh_installed_apps_raw.stdout | from_json }}"
|
ansible.builtin.set_fact: ynh_installed_apps="{{ ynh_installed_apps_raw.stdout | from_json }}"
|
||||||
|
tags:
|
||||||
|
- apps
|
||||||
|
|
||||||
- name: Install yunohost apps and perform post-install
|
- name: Install yunohost apps and perform post-install
|
||||||
ansible.builtin.include_tasks: app.yml
|
ansible.builtin.include_tasks: app.yml
|
||||||
|
|
@ -32,3 +36,6 @@
|
||||||
loop_control:
|
loop_control:
|
||||||
loop_var: ynh_app
|
loop_var: ynh_app
|
||||||
when: ynh_app.label not in ynh_installed_apps.values()
|
when: ynh_app.label not in ynh_installed_apps.values()
|
||||||
|
tags:
|
||||||
|
- apps
|
||||||
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
#-----------------------------------------------------------------------------#
|
#-----------------------------------------------------------------------------#
|
||||||
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
||||||
# Copyright 2021-2021 Lydra https://www.lydra.fr/ #
|
# Copyright 2021-present Lydra https://www.lydra.fr/ #
|
||||||
# #
|
# #
|
||||||
# this program is free software: you can redistribute it and/or modify #
|
# this program is free software: you can redistribute it and/or modify #
|
||||||
# it under the terms of the GNU General Public License as published by #
|
# it under the terms of the GNU General Public License as published by #
|
||||||
|
|
@ -22,11 +22,20 @@
|
||||||
ansible.builtin.command: yunohost domain list --output-as json
|
ansible.builtin.command: yunohost domain list --output-as json
|
||||||
register: ynh_installed_domains_raw
|
register: ynh_installed_domains_raw
|
||||||
changed_when: False
|
changed_when: False
|
||||||
|
tags:
|
||||||
|
- yunohost
|
||||||
|
- domains
|
||||||
|
|
||||||
- name: Format json of domains
|
- name: Format json of domains
|
||||||
ansible.builtin.set_fact: ynh_installed_domains="{{ ynh_installed_domains_raw.stdout | from_json }}"
|
ansible.builtin.set_fact: ynh_installed_domains="{{ ynh_installed_domains_raw.stdout | from_json }}"
|
||||||
|
tags:
|
||||||
|
- yunohost
|
||||||
|
- domains
|
||||||
|
|
||||||
- name: Create domains
|
- name: Create domains
|
||||||
ansible.builtin.command: yunohost domain add {{ item }}
|
ansible.builtin.command: yunohost domain add {{ item }}
|
||||||
with_items: "{{ ynh_extra_domains }}"
|
with_items: "{{ ynh_extra_domains }}"
|
||||||
when: item not in ynh_installed_domains.domains
|
when: item not in ynh_installed_domains.domains
|
||||||
|
tags:
|
||||||
|
- yunohost
|
||||||
|
- domains
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
#-----------------------------------------------------------------------------#
|
#-----------------------------------------------------------------------------#
|
||||||
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
||||||
# Copyright 2021-2021 Lydra https://www.lydra.fr/ #
|
# Copyright 2021-present Lydra https://www.lydra.fr/ #
|
||||||
# #
|
# #
|
||||||
# this program is free software: you can redistribute it and/or modify #
|
# this program is free software: you can redistribute it and/or modify #
|
||||||
# it under the terms of the GNU General Public License as published by #
|
# it under the terms of the GNU General Public License as published by #
|
||||||
|
|
@ -24,10 +24,49 @@
|
||||||
- git
|
- git
|
||||||
- dialog
|
- dialog
|
||||||
state: present
|
state: present
|
||||||
|
tags:
|
||||||
|
- pkg
|
||||||
|
- linux
|
||||||
|
- yunohost
|
||||||
|
|
||||||
|
- name: Create apps and config directories
|
||||||
|
ansible.builtin.file:
|
||||||
|
path: "{{ item }}"
|
||||||
|
state: directory
|
||||||
|
mode: 0770
|
||||||
|
loop:
|
||||||
|
- "{{ ynh_symlink.appdata_dir }}"
|
||||||
|
- "{{ ynh_symlink.conf_dir }}"
|
||||||
|
tags:
|
||||||
|
- linux
|
||||||
|
- yunohost
|
||||||
|
when: ynh_symlink.enabled
|
||||||
|
|
||||||
|
- name: Create symbolic link for Yunohost apps data directory
|
||||||
|
ansible.builtin.file:
|
||||||
|
src: /var/www/
|
||||||
|
dest: "{{ ynh_symlink.appdata_dir }}/www_symlink"
|
||||||
|
state: link
|
||||||
|
tags:
|
||||||
|
- linux
|
||||||
|
- yunohost
|
||||||
|
when: ynh_symlink.enabled
|
||||||
|
|
||||||
|
- name: Create symbolic link for Yunohost configuration directory
|
||||||
|
ansible.builtin.file:
|
||||||
|
src: /etc/yunohost/
|
||||||
|
dest: "{{ ynh_symlink.conf_dir }}/yunohost_symlink"
|
||||||
|
state: link
|
||||||
|
tags:
|
||||||
|
- linux
|
||||||
|
- yunohost
|
||||||
|
when: ynh_symlink.enabled
|
||||||
|
|
||||||
- name: Test if Yunohost is already installed
|
- name: Test if Yunohost is already installed
|
||||||
ansible.builtin.stat: path=/etc/yunohost/installed
|
ansible.builtin.stat: path=/etc/yunohost/installed
|
||||||
register: ynh_file_install
|
register: ynh_file_install
|
||||||
|
tags:
|
||||||
|
- yunohost
|
||||||
|
|
||||||
- name: Download Yunohost install script
|
- name: Download Yunohost install script
|
||||||
ansible.builtin.get_url:
|
ansible.builtin.get_url:
|
||||||
|
|
@ -35,10 +74,14 @@
|
||||||
dest: /tmp/install_yunohost.sh
|
dest: /tmp/install_yunohost.sh
|
||||||
mode: 700
|
mode: 700
|
||||||
when: not ynh_file_install.stat.exists
|
when: not ynh_file_install.stat.exists
|
||||||
|
tags:
|
||||||
|
- yunohost
|
||||||
|
|
||||||
- name: Launch Yunohost install script
|
- name: Launch Yunohost install script
|
||||||
ansible.builtin.command: /tmp/install_yunohost.sh -a
|
ansible.builtin.command: /tmp/install_yunohost.sh -a
|
||||||
when: not ynh_file_install.stat.exists
|
when: not ynh_file_install.stat.exists
|
||||||
|
tags:
|
||||||
|
- yunohost
|
||||||
|
|
||||||
- name: Launch Yunohost postinstall
|
- name: Launch Yunohost postinstall
|
||||||
ansible.builtin.command:
|
ansible.builtin.command:
|
||||||
|
|
@ -47,32 +90,32 @@
|
||||||
--password "{{ ynh_admin_password }}" \
|
--password "{{ ynh_admin_password }}" \
|
||||||
{% if ynh_ignore_dyndns_server %} --ignore-dyndns {% endif %}
|
{% if ynh_ignore_dyndns_server %} --ignore-dyndns {% endif %}
|
||||||
when: not ynh_file_install.stat.exists
|
when: not ynh_file_install.stat.exists
|
||||||
|
tags:
|
||||||
|
- yunohost
|
||||||
|
- domains
|
||||||
|
|
||||||
- name: Create extra domains
|
- name: Create extra domains
|
||||||
ansible.builtin.include_tasks: domains.yml
|
ansible.builtin.include_tasks: domains.yml
|
||||||
when: ynh_extra_domains
|
when: ynh_extra_domains
|
||||||
|
tags:
|
||||||
|
- yunohost
|
||||||
|
- domains
|
||||||
|
|
||||||
- name: Run first Yunohost diagnosis
|
- name: Run first Yunohost diagnosis
|
||||||
ansible.builtin.command: yunohost diagnosis run
|
ansible.builtin.command: yunohost diagnosis run
|
||||||
when: not ynh_file_install.stat.exists
|
when: not ynh_file_install.stat.exists
|
||||||
|
tags:
|
||||||
|
- yunohost
|
||||||
|
|
||||||
- name: Install domain certificates
|
- name: Install domain certificates
|
||||||
ansible.builtin.command: yunohost domain cert-install
|
ansible.builtin.command: yunohost domain cert-install
|
||||||
changed_when: False
|
changed_when: False
|
||||||
|
tags:
|
||||||
- name: Configure SMTP relay
|
- yunohost
|
||||||
ansible.builtin.include_tasks: smtp_relay.yml
|
|
||||||
loop: "{{ ynh_smtp_relay | dict2items }}"
|
|
||||||
when: item.value
|
|
||||||
|
|
||||||
- name: Add Yunohost users
|
- name: Add Yunohost users
|
||||||
ansible.builtin.include_tasks: users.yml
|
ansible.builtin.include_tasks: users.yml
|
||||||
when: ynh_users
|
when: ynh_users
|
||||||
|
tags:
|
||||||
- name: Install Yunohost apps
|
- yunohost
|
||||||
ansible.builtin.include_tasks: apps.yml
|
- users
|
||||||
when: ynh_apps
|
|
||||||
|
|
||||||
- name: Configures Yunohost autoupdate
|
|
||||||
ansible.builtin.include_tasks: autoupdate.yml
|
|
||||||
when: ynh_autoupdate.scheduled
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
#-----------------------------------------------------------------------------#
|
#-----------------------------------------------------------------------------#
|
||||||
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
# ansible-yunohost allows to deploy Yunohost using Ansible #
|
||||||
# Copyright 2021-2021 Lydra https://www.lydra.fr/ #
|
# Copyright 2021-present Lydra https://www.lydra.fr/ #
|
||||||
# #
|
# #
|
||||||
# this program is free software: you can redistribute it and/or modify #
|
# this program is free software: you can redistribute it and/or modify #
|
||||||
# it under the terms of the GNU General Public License as published by #
|
# it under the terms of the GNU General Public License as published by #
|
||||||
|
|
@ -22,9 +22,15 @@
|
||||||
ansible.builtin.command: yunohost user list --output-as json
|
ansible.builtin.command: yunohost user list --output-as json
|
||||||
register: ynh_registered_users_raw
|
register: ynh_registered_users_raw
|
||||||
changed_when: False
|
changed_when: False
|
||||||
|
tags:
|
||||||
|
- yunohost
|
||||||
|
- users
|
||||||
|
|
||||||
- name: Format json of users
|
- name: Format json of users
|
||||||
ansible.builtin.set_fact: ynh_registered_users="{{ ynh_registered_users_raw.stdout | from_json }}"
|
ansible.builtin.set_fact: ynh_registered_users="{{ ynh_registered_users_raw.stdout | from_json }}"
|
||||||
|
tags:
|
||||||
|
- yunohost
|
||||||
|
- users
|
||||||
|
|
||||||
- name: Create missing Yunohost users
|
- name: Create missing Yunohost users
|
||||||
ansible.builtin.command:
|
ansible.builtin.command:
|
||||||
|
|
@ -35,3 +41,6 @@
|
||||||
-p "{{ item.pass }}"
|
-p "{{ item.pass }}"
|
||||||
loop: "{{ ynh_users }}"
|
loop: "{{ ynh_users }}"
|
||||||
when: item.name not in ynh_registered_users.users.keys()
|
when: item.name not in ynh_registered_users.users.keys()
|
||||||
|
tags:
|
||||||
|
- yunohost
|
||||||
|
- users
|
||||||
Loading…
Reference in a new issue