YunoHost package generator

Version: 0.11

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.

1/9 - General information

App name

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

Application identifier (id)

Small caps and without spaces

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

2/9 - Upstream information

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

3/9 - Integration in YunoHost

Version

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.

4/9 - Questions to ask during installation

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 ('domain' and 'path' variables)

Ask who can access to the app

In the users groups : by default at least 'visitors', 'all_users' et 'admins' exists. (It was previously the private/public app concept)

Ask who can access to the admin interface

In the case where the app has an admin interface

Supported languages

5/9 - Resources to initialize

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

Sources du logiciel

Application source code or executable

Sources sha256 checksum

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

6/9 - Specific technology

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

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

7/9 - App configuration

The app uses a specific configuration file

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

Name or file path to use

App configuration file pattern

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

8/9 - General and advanced documentation

doc/DESCRIPTION.md: A comprehensive presentation of the app, possibly listing the main features, possible warnings and specific details on its functioning in Yunohost (e.g. warning about integration issues).

doc/PRE_INSTALL.md: important info to be shown to the admin before installing the app

Leave empty if not relevant

doc/POST_INSTALL.md: important info to be shown to the admin after installing the app

Leave empty if not relevant

doc/PRE_UPGRADE.md: important info to be shown to the admin before upgrading the app

Leave empty if not relevant

doc/POST_UPGRADE.md: important info to be shown to the admin after upgrading the app

Leave empty if not relevant

doc/ADMIN.md: general tips on how to administrate this app

Leave empty if not relevant

9/9 - Advanced options

Handle app install URL change (change_url script)

Use logrotate for the app logs

Protect the application against brute force attacks (via fail2ban)

Regular expression for fail2ban

Add a CRON task for this application

Corresponds to some app periodic operations

Type the CRON file content