mirror of
https://github.com/YunoHost-Apps/armadietto_ynh.git
synced 2024-09-03 18:06:18 +02:00
78 lines
No EOL
3.7 KiB
TOML
78 lines
No EOL
3.7 KiB
TOML
|
|
## Config panel are available from webadmin > Apps > YOUR_APP > Config Panel Button
|
|
## Those panels let user configure some params on their apps using a friendly interface,
|
|
## and remove the need to manually edit files from the command line.
|
|
|
|
## From a packager perspective, this .toml is coupled to the scripts/config script,
|
|
## which may be used to define custom getters/setters. However, most use cases
|
|
## should be covered automagically by the core, thus it may not be necessary
|
|
## to define a scripts/config at all!
|
|
|
|
## -----------------------------------------------------------------------------
|
|
## IMPORTANT: In accordance with YunoHost's spirit, please keep things simple and
|
|
## do not overwhelm the admin with tons of misunderstandable or advanced settings.
|
|
## -----------------------------------------------------------------------------
|
|
|
|
## The top level describe the entire config panels screen.
|
|
|
|
## The version is a required property.
|
|
## Here a small reminder to associate config panel version with YunoHost version
|
|
## | Config | YNH | Config panel small change log |
|
|
## | ------ | --- | ------------------------------------------------------- |
|
|
## | 0.1 | 3.x | 0.1 config script not compatible with YNH >= 4.3 |
|
|
## | 1.0 | 4.3.x | The new config panel system with 'bind' property |
|
|
version = "1.0"
|
|
|
|
## (optional) i18n property let you internationalize questions, however this feature
|
|
## is only available in core configuration panel (like yunohost domain config).
|
|
## So in app config panel this key is ignored for now, but you can internationalize
|
|
## by using a lang dictionary (see property name bellow)
|
|
# i18n = "prefix_translation_key"
|
|
|
|
################################################################################
|
|
#### ABOUT PANELS
|
|
################################################################################
|
|
|
|
## The next level describes web admin panels
|
|
## You have to choose an ID for each panel, in this example the ID is "main"
|
|
## Keep in mind this ID will be used in CLI to refer to your question, so choose
|
|
## something short and meaningfull.
|
|
## In the webadmin, each panel corresponds to a distinct tab / form
|
|
[main]
|
|
|
|
## Define the label for your panel
|
|
## Internationalization works similarly to the 'description' and 'ask' questions in the manifest
|
|
# name.en = "Main configuration"
|
|
# name.fr = "Configuration principale"
|
|
|
|
## (optional) If you need to trigger a service reload-or-restart after the user
|
|
## change a question in this panel, you can add your service in the list.
|
|
services = ["__APP__"]
|
|
# or services = ["nginx", "__APP__"] to also reload-or-restart nginx
|
|
|
|
## (optional) This help properties is a short help displayed on the same line
|
|
## than the panel title but not displayed in the tab.
|
|
# help = ""
|
|
|
|
############################################################################
|
|
#### ABOUT SECTIONS
|
|
############################################################################
|
|
|
|
## A panel is composed of one or several sections.
|
|
##
|
|
## Sections are meant to group questions together when they correspond to
|
|
## a same subtopic. This impacts the rendering in terms of CLI prompts
|
|
## and HTML forms
|
|
##
|
|
## You should choose an ID for your section, and prefix it with the panel ID
|
|
## (Be sure to not make a typo in the panel ID, which would implicitly create
|
|
## an other entire panel)
|
|
##
|
|
## We use the context of pepettes_ynh as an example,
|
|
## which is a simple donation form app written in python,
|
|
## and for which the admin will want to edit the configuration
|
|
[main.customization]
|
|
|
|
## (optional) Defining a proper title for sections is not mandatory
|
|
## and depends on the exact rendering you're aiming for the CLI / webadmin
|
|
name = "PLOP" |