Instances of this class represents unit operation done on the ynh instance. Each time an action of the yunohost cli/api change the system, o

BackupRestoreTargetsManager manage the targets in BackupManager and RestoreManager

This class collect files to backup in a list and apply one or several backup method on it. The list contains dict with source and dest p

This is the 'root' level of the config panel toml file #### Examples ```toml version = 1.0 [config] # …refer to Panels doc

RestoreManager allow to restore a past backup archive Currently it's a tar file, but it could be another kind of archive Public propert

Command line action.

Alerts displays a important message with a level of severity. You can use markdown in `ask` but will only be rendered in the web-admin.

Ask for a user app. Renders as a select in the web-admin and as a regular prompt in CLI with autocompletion of installed apps. #### Exam

Create a virtual package in apt, depending on the list of specified packages that the app needs. The virtual packages is called `$app-ynh-deps` (

BackupMethod is an abstract class that represents a way to backup and restore a list of files. Daughters of this class can be used by a

Rest of the option types available are considered `inputs`. #### Example ```toml [section.my_option_id] type = "string" # …

Options are fields declaration that renders as form items, button, alert or text in the web-admin and printed or prompted in CLI. They are us

Ask for a boolean. Renders as a switch in the web-admin and a yes/no prompt in CLI. #### Example ```toml [section.my_option_id]

Triggers actions. Available only in config panels. Renders as a `button` in the web-admin and can be called with `yunohost [app|domain|se

Details of dynamic argument completion function.

Command line category. Categories have different level: - level 1: main category, e.g. `yunohost user` - level 2: sub-categ

Ask for a color represented as a hex value (with possibly an alpha channel). Renders as color picker in the web-admin and as a prompt that ac

Installs a composer version to be used by the app You may then use `ynh_composer_exec` in your script to run composer actions Note that

This class just do an uncompress copy of each file in a location, and could be the inverse for restoring

This class use a bash script/hook "backup_method" to do the backup/restore operations. A user can add his own hook inside /etc/yunohost/h

Initialize a database, either using MySQL or Postgresql. Relevant DB infos are stored in settings `$db_name`, `$db_user` and `$db_pwd`. NB:

Creates a directory to be used by the app as the data store directory, typically where the app multimedia or large assets added by users are loca

Ask for a date in the form `"2025-06-14"`. Renders as a date-picker in the web-admin and a regular prompt in CLI. Can also take a timest

https://github.com/storaged-project/udisks/issues/1352#issuecomment-2678874537

Display simple multi-line content. #### Example ```toml [section.my_option_id] type = "display_text" ask = "Simple text ren

Ask for a user domain. Renders as a select in the web-admin and as a regular prompt in CLI with autocompletion of registered domains. ##

Ask for an email. Validation made with [python-email-validator](https://github.com/JoshData/python-email-validator) #### Example ```tom

r""" Ask for file. Renders a file prompt in the web-admin and ask for a path in CLI. #### Example ```toml [section.my_option_id]

Base form on which dynamic forms are built upon Options.

Details of a helper function.

Installs a go version to be used by the app, using "goenv" Sourcing the helpers will then automatically tweak the `PATH` variable such that

Ask for a group. Renders as a select in the web-admin and as a regular prompt in CLI with autocompletion of available groups. #### Examp

Creates a directory to be used by the app as the installation directory, typically where the app sources and assets are located. The correspondin

Display markdown multi-line content. Markdown is currently only rendered in the web-admin #### Example ```toml [section.my_opti

Rework the firewall configuration