self-hosted/Mailu
1
0
Fork 0
mirror of https://github.com/Mailu/Mailu.git synced 2025-08-10 22:31:47 +02:00
Code Issues Releases Activity

Update documentation with new length requirement for API_TOKEN

Browse Source
This commit is contained in:
Dimitri Huisman
2024-06-09 09:44:42 +00:00
parent 2db75921a2
commit 12ccdebd20
2 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api.rst
View File

@@ -12,7 +12,7 @@ It can also be manually configured via mailu.env:
* ``API`` - Expose the API interface (value: true, false) * ``API`` - Expose the API interface (value: true, false)
* ``WEB_API`` - Path to the API interface * ``WEB_API`` - Path to the API interface
* ``API_TOKEN`` - API token for authentication * ``API_TOKEN`` - API token for authentication (with minimum length of 3 characters)
For more information refer to the detailed descriptions in the For more information refer to the detailed descriptions in the
:ref:`configuration reference <advanced_settings>`. :ref:`configuration reference <advanced_settings>`.

1
docs/configuration.rst
View File

@@ -218,6 +218,7 @@ Advanced settings
The ``AUTH_REQUIRE_TOKENS`` (default: False) setting controls whether thick clients can authenticate using passwords or whether they are forced to use tokens/application specific passwords. The ``AUTH_REQUIRE_TOKENS`` (default: False) setting controls whether thick clients can authenticate using passwords or whether they are forced to use tokens/application specific passwords.
The ``API_TOKEN`` (default: None) setting configures the authentication token. The ``API_TOKEN`` (default: None) setting configures the authentication token.
The minimum length is 3 characters.
This token must be passed as request header to the API as authentication token. This token must be passed as request header to the API as authentication token.
This is a mandatory setting for using the RESTful API. This is a mandatory setting for using the RESTful API.