diff --git a/docs/_sidebar.md b/docs/_sidebar.md index c736ee68..9de855a8 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -17,6 +17,7 @@ - [Third party projects](additional-software/third-party-projects.md) - In Depth - [Operating WildDuck](in-depth/operating-wildduck.md) + - [Default values](in-depth/default-values.md) - [E-Mail Protocol support](in-depth/protocol-support.md) - [ACME certificates](in-depth/acme-certificates.md) - [Security implementation](in-depth/security.md) diff --git a/docs/in-depth/default-values.md b/docs/in-depth/default-values.md new file mode 100644 index 00000000..74901504 --- /dev/null +++ b/docs/in-depth/default-values.md @@ -0,0 +1,11 @@ +# Default values + +You can set system wide defaults using either the [Settings API endpoints](https://docs.wildduck.email/api/#tag/Settings) or by using the built in API client for system settings. + +You can find the client from API path _/public/config.html_, eg. if your API is runnin gon port 8080 then the URL should be http://127.0.0.1:8080/public/config.html + +If your API is configured to require authentication, then you need to provide either a _root_ token or a _settings_-role token. Otherwise you can leave the access token field empty. + +![Defaults Screenshot](img/defaults.png) + +**NB!** while the API endpoints only take milliseconds and byte values for duration and size key values, then the web based client allows to use human readable numbers, so you can use _30d_ instead of _2592000000_. diff --git a/docs/in-depth/img/defaults.png b/docs/in-depth/img/defaults.png new file mode 100644 index 00000000..0990f5e7 Binary files /dev/null and b/docs/in-depth/img/defaults.png differ