YunoHost package generator

Generator mode

In tutorial version, the generated app will contain additionnal comments to ease the understanding. In steamlined version, the generated app will only contain the necessary minimum.

General information (1/7)

App name

It's the application name, displayed in the user interface

Application identifier (id)

This is the 'technical' name of the app. Lowercase, no space

Short description (en)

Explain in a few words (10-15) why this app is useful or what it does (the goal is to give a broad idea for the user browsing an hundred apps long catalog

Short description (fr)

Explain in a few words (10-15) why this app is useful or what it does (the goal is to give a broad idea for the user browsing an hundred apps long catalog

Comprehensive presentation

Corresponds to 'doc/DESCRIPTION.md' and you can use markdown in there. Typically you should list the main features, possible warnings and specific details on its functioning in YunoHost (e.g. warning about integration issues).

Upstream information (2/7)

The word 'upstream' refers to the original project that develops and maintains the app

Licence

You should check this on the upstream repository. The expected format is a SPDX id listed in https://spdx.org/licenses/

Official website

Leave empty if there is no official website

Official app demo

Leave empty if there is no official demo

Admin documentation

Leave empty if there is no official admin doc

Usage documentation

Leave empty if there is no official user doc

Code repository

Integration in YunoHost (3/7)

Version

Corresponds to the upstream version that will be deployed. Typically this should match the URL of the source that you'll specify in section 5

Maintainer of the generated app

Usually you put your name here... If you're okay with it ;)

The app can be installed multiple times at the same time on the same server

Supported architectures

The app will be integrating LDAP

Which means it's possible to use YunoHost credentials to log into this app. LDAP corresponds to the technology used by YunoHost to handle a centralised user base. Bridging the app and YunoHost's LDAP often requires to add the proper technical details in the app's configuration file.

The app will be integrated in YunoHost SSO (Single Sign On)

Which means that people will be logged in the app after logging in YunoHost's portal, without having to sign on specifically into this app.

Questions to ask during installation (4/7)

This part is meant to indicate the questions that will be asked.
NB: only standard questions are asked here, it might be required to complete it by hand using other questions as a guide.

Ask the URL where the app will be installed

Will correspond to the `$domain` and `$path` variables in scripts, and `__DOMAIN__` and `__PATH__` in configuration templates.

Ask who can access to the app

In the users groups: by default at least 'visitors', 'all_users' et 'admins' exists.

Ask who can access to the admin interface

In the case where the app has an admin interface

Resources to initialize (5/7)

Technical elements configured before launching the 'real' app install script. Usually: creating a system user, downloading app sources, initialiser le dossier d'install et de données, install apt dependencies, create a database...

Application source code or executable

Enable automatic update of sources (using a bot running every night)

If the upstream software is hosted in one of the handled sources and publishes proper releases or tags, the bot will create a pull request to update the sources URL and checksum.

Initialize a system user for this app

Initialize an installation folder for this app

By default it's /var/www/$app

Initialize a folder to store the app data

By default it's /var/yunohost.app/$app

Dependencies to be installed via apt

Separated by comma and/or spaces

Initialize an SQL database

App build and configuration (6/7)

App main technology

You probably want to make sure to have 'phpX.Y-fpm' and others 'phpX.Y-foobar' libraries listed the apt dependencies earlier (with X.Y being the php version you want to use)

The generated application draft will include an NGINX configuration snippet that interfaces with PHP-FPM

Use composer

Composer is a PHP dependencies manager used by some apps

NodeJS version

For example: 16.4, 18, 18.2, 20, 20.1...

Install and use Yarn

Go version

For example: 1.20, 1.21, 1.22, 1.23...

You probably want to make sure to have 'python3' and 'python3-venv' listed in the apt dependencies earlier. Other dependencies should be installed inside a venv (cf the proposed install snippet)

Installation specific commands

These commands are executed from the app installation folder (by default, /var/www/$app) after the sources have been deployed. This field uses by default a classic example based on the selected technology. You should probably compare and adapt it according to the app installation documentation.

The generated application draft will include an NGINX configuration snippet that reverse-proxies to a systemd service using an internal port

Command to start the app daemon (from systemd service)

Corresponds to 'ExecStart' statement in systemd. You can use '__INSTALL_DIR__' to refer to the install directory, or '__APP__' to refer to the app id

Use logrotate for the logs

Add a specific configuration file for the app

Typically: .env, config.json, conf.ini, params.yml...

App config filename

App config content

In this field, you can use the syntax __FOO_BAR__ which will automatically replaced by the value of the variable $foo_bar

Advanced options (7/7)

Support URL change

Corresponds to the `change_url` script, allowing to change the domain/path where the app is exposed after installation

Protect against brute force attacks

Use fail2ban, assuming the app logs failed connection attempts, this option allows to automatically ban suspicious IP after a number of failed attempts.

Regular expression for Fail2Ban

Regular expression to check in the log file to activate FailBan (search for a line that indicates a credentials error).

Configure a CRON task

Corresponds to some app periodic operations

CRON file content

Additional documentation bits

General tips on how to administrate this app

Corresponds to 'doc/ADMIN.md'. Leave empty if not relevant

Important info to be shown to the admin before installation

Corresponds to 'doc/PRE_INSTALL.md' Leave empty if not relevant

Important info to be shown to the admin after installation

Corresponds to 'doc/POST_INSTALL.md' Leave empty if not relevant