Add missing config options
Some checks are pending
ci/woodpecker/push/woodpecker Pipeline is pending

This commit is contained in:
nemunaire 2025-03-19 15:50:05 +01:00
parent 823fdcf446
commit 14ddc9baca
2 changed files with 52 additions and 0 deletions

View File

@ -94,6 +94,9 @@ Here is a list of the main options:
`externalurl`
: URL of the service, as it should appear in emails and content to the public.
`disable-providers-edit`
: Disallow all actions on provider (add/edit/delete), eg. for demo mode.
#### Page layout
@ -103,6 +106,15 @@ Here is a list of the main options:
`custom-body-html`
: String to be placed before the end of the HTML body.
`hide-feedback-button`
: Hide the icon on page that permit to give feedback.
`msg-header-text`
: Custom message banner to add at the top of the app.
`msg-header-color`
: Background color class of the banner added at the top of the app (default "danger", can be primary, secondary, info, success, warning, danger, light, dark, or any bootstrap color class).
### Data storage
@ -141,17 +153,31 @@ Note that without the `mail-smtp-*` options, happyDomain will use the `sendmail`
`no-auth`
: Disables the notion of users and access control. A default account is used.
`disable-embedded-login`
: Disables the internal user/password login in favor of external-auth or OIDC.
`disable-registration`
: Forbids new account creation through public form/API (still allow registration from external services).
`external-auth`
: URL base of the authentication and registration service to be used instead of the embedded login system.
`jwt-secret-key`
: Secret key used to verify JWT tokens.
See also [OpenID Connect settings]({{% relref "oidc" %}}).
### Specific to registrars
Some registrars require third-party applications to identify themselves in addition to the user.
#### Bind
`with-bind-provider`
: Enable the BIND provider (not suitable for cloud/shared instance as it'll access the local file system).
#### OVH
Please refer to [this documentation]({{% relref "ovh" %}}) to generate the identifiers.

View File

@ -93,6 +93,9 @@ Voici la liste des principales options :
`externalurl`
: URL du service, tel qu'il doit apparaître dans les mails et contenus à destination du public.
`disable-providers-edit`
: Interdit toute action sur les fournisseurs de service DNS (ajour/édition/suppression), par exemple pour avoir un mode de démonstration.
#### Mise en page
@ -102,6 +105,15 @@ Voici la liste des principales options :
`custom-body-html`
: Chaîne de caractères à placer avant la fin du corps HTML.
`hide-feedback-button`
: Cache l'icône permettant de donner son retour d'expérience.
`msg-header-text`
: Ajoute un message personnalisé dans une bannière en haut de toutes les pages.
`msg-header-color`
: Classe de couleur de fond pour la bannière ajoutée en haut de l'application web (par défaut "danger", pourrait être primary, secondary, info, success, warning, danger, light, dark, ou toute autre classe de couleur bootstrap).
### Stockage des données
@ -140,17 +152,31 @@ Notez que sans les options `mail-smtp-*`, happyDomain utilisera le binaire `send
`no-auth`
: Désactive la notion d'utilisateurs et de contrôle d'accès. Un compte par défaut est utilisé.
`disable-embedded-login`
: Désactive le mécanisme de connexion interne en faveur de l'external-auth ou d'OIDC.
`disable-registration`
: Interdit la création de nouveau compte à travers le formulaire ou l'API (cela ne désactive pas la création de compte lorsque l'on se connecte pour la première fois à partir d'un service d'authentification externe).
`external-auth`
: Base de l'URL du service d'authentification et d'enregistrement à utiliser à la place du système de connexion embarqué.
`jwt-secret-key`
: Clef secrète utilisée pour vérifier les tokens JWT.
Voir aussi [paramètres OpenID Connect]({{% relref "oidc" %}}).
### Spécifique aux bureaux d'enregistrement
Certain bureau d'enregistrement nécessitent que les applications tierces s'identifient en plus d'identifier l'utilisateur.
#### Bind
`with-bind-provider`
: Active BIND en tant que fournisseur DNS (attention, ce paramètre n'est pas adapté à un environnement partagé/cloud car il accède au système de fichiers local).
#### OVH
Veuillez vous référer à [cette documentation]({{% relref "ovh" %}}) afin de générer les identifiants.