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

Skip to content
Snippets Groups Projects
README.md 4.83 KiB
Newer Older
  • Learn to ignore specific revisions
  • [![](https://img.shields.io/liberapay/receives/cchaudier.svg?logo=liberapay)](https://liberapay.com/cchaudier/donate)
    [![](https://lab.frogg.it/lydra/yunohost/ansible-yunohost/badges/main/pipeline.svg)](https://lab.frogg.it/lydra/yunohost/ansible-yunohost/-/pipelines)
    [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)
    
    [![Ansible Role](https://img.shields.io/ansible/role/56544)](https://galaxy.ansible.com/lydra/yunohost)
    [![Ansible Quality Score](https://img.shields.io/ansible/quality/56544)](https://galaxy.ansible.com/lydra/yunohost)
    [![Ansible Role](https://img.shields.io/ansible/role/d/56544)](https://galaxy.ansible.com/lydra/yunohost)
    
    [![GitHub last commit](https://img.shields.io/github/last-commit/LydraFr/ansible-yunohost)](https://github.com/LydraFr/ansible-yunohost)
    [![GitHub Release Date](https://img.shields.io/github/release-date/LydraFr/ansible-yunohost)](https://github.com/LydraFr/ansible-yunohost)
    [![GitHub Repo stars](https://img.shields.io/github/stars/LydraFr/ansible-yunohost?style=social)](https://github.com/LydraFr/ansible-yunohost)
    
    
    [🇫🇷 French version](README-FR.md)
    
    sylvainar's avatar
    sylvainar committed
    
    
    Deploy [Yunohost](https://yunohost.org/#/) with Ansible!
    
    sylvainar's avatar
    sylvainar committed
    
    
    sylvainar's avatar
    sylvainar committed
    
    None.
    
    
    Default variables are available in `default/main.yml` however it is necessary to override them according to your needs for Yunohost domains, users and apps.
    
    sylvainar's avatar
    sylvainar committed
    
    
    sylvainar's avatar
    sylvainar committed
    ```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
    
      - 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)).
    
    # The list of Yunohost 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).
    
    # The list of Yunohost apps.
    
    ynh_apps:
      - label: WikiJS
        link: wikijs
        args:
    
          domain: wiki.domain.tld
          path: /
    
          is_public: no
      - label: Discourse
    
        args:
          domain: forum.domain.tld
          path: /
    
    sylvainar's avatar
    sylvainar committed
    ```
    
    
    - `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). 
    
    
    sylvainar's avatar
    sylvainar committed
    
    None.
    
    
    sylvainar's avatar
    sylvainar committed
    ```yml
    
    ---
    - name: Install Yunohost on Debian Server
    
    sylvainar's avatar
    sylvainar committed
      hosts: all
    
    sylvainar's avatar
    sylvainar committed
      pre_tasks:
        - name: Update all packages and index
    
          ansible.builtin.apt:
    
    sylvainar's avatar
    sylvainar committed
            upgrade: dist
            update_cache: yes
    
    sylvainar's avatar
    sylvainar committed
      roles:
    
    sylvainar's avatar
    sylvainar committed
    ```
    
    
    sylvainar's avatar
    sylvainar committed
    
    
    [![ansible-yunohost Copyright 2021 Lydra](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](https://choosealicense.com/licenses/gpl-3.0/)
    
    
    sylvainar's avatar
    sylvainar committed
    GPL-3.0