summaryrefslogtreecommitdiff
path: root/docs/admin/settings
diff options
context:
space:
mode:
authorTommaso Colella <tommasocolella95@gmail.com>2025-12-29 15:20:43 +0100
committerGitHub <noreply@github.com>2025-12-29 15:20:43 +0100
commit320c317719466b899e672e2702027f8ebbae8426 (patch)
treee05047f776e3fb6ca1ddf44cabb4485bf068bf26 /docs/admin/settings
parentabae17e6fc49e2b77fb1c090db984e4867cea723 (diff)
[mod] settings.yml: set engines that require an api key to inactive by default
Diffstat (limited to 'docs/admin/settings')
-rw-r--r--docs/admin/settings/settings_engines.rst7
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/admin/settings/settings_engines.rst b/docs/admin/settings/settings_engines.rst
index c614d8b59..ac85947c3 100644
--- a/docs/admin/settings/settings_engines.rst
+++ b/docs/admin/settings/settings_engines.rst
@@ -124,14 +124,17 @@ engine is shown. Most of the options have a default value or even are optional.
``api_key`` : optional
In a few cases, using an API needs the use of a secret key. How to obtain them
- is described in the file.
+ is described in the file. Engines that require an API key are set to
+ ``inactive: true`` by default. To enable such an engine, provide the API key
+ and set ``inactive: false``.
``disabled`` : optional
To disable by default the engine, but not deleting it. It will allow the user
to manually activate it in the settings.
``inactive``: optional
- Remove the engine from the settings (*disabled & removed*).
+ Remove the engine from the settings (*disabled & removed*). This defaults to ``true`` for engines
+ that require an API key, please see the ``api_key`` section if you want to enable such an engine.
``language`` : optional
If you want to use another language for a specific engine, you can define it