Ansible Role: Yunohost

🇫🇷 French version

Deploy Yunohost 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

# 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

# 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).
• ynh_extra_domains are optional and allow you to install one app per subdomain (more info here).
• ynh_ignore_dyndns_server allow to register domains with a Dynamic DNS service (more info here).

User management

# 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.

App management

# 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

• 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.

Dependencies

None.

Example Playbook

---
- 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

GPL-3.0