mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-02-18 15:13:32 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #7482 from owncloud/mmattel-patch-1

Browse Source 
[docs-only] Update README.md of the settings service
This commit is contained in:
Martin
2023-10-13 09:58:54 +02:00
committed by GitHub
parent bd955f75ed bef11c32f4
commit 445abc09f4
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
services/settings/README.md
View File

@@ -2,6 +2,8 @@
The `settings` service provides functionality for other services to register new settings as well as storing and retrieving the respective settings' values.
## Settings Managed
The settings service is currently used for managing the:
* users' `profile` settings like the language and the email notification settings,
@@ -66,14 +68,14 @@ Infinite Scale services can register *settings bundles* with the settings servic
## Settings Usage
Services can set or query ocis *setting values* of a user from settings bundles.
Services can set or query Infinite Scale *setting values* of a user from settings bundles.
## Service Accounts
The settings service needs to know the ID's of service accounts but it doesn't need their secrets. Currently only one service account can be configured which has the admin role. This can be set with the `SETTINGS_SERVICE_ACCOUNT_ID_ADMIN` envvar, but it will also pick up the global `OCIS_SERVICE_ACCOUNT_ID` envvar. Also see the 'auth-service' service description for additional details.
The settings service needs to know the ID's of service accounts but it doesn't need their secrets. Currently only one service account can be configured which has the admin role. This can be set with the `SETTINGS_SERVICE_ACCOUNT_ID_ADMIN` envvar, but it will also pick up the global `OCIS_SERVICE_ACCOUNT_ID` environment variable. Also see the 'auth-service' service description for additional details.
## Default Language
The default language can be defined via SETTINGS_DEFAULT_LANGUAGE environment variable. If this variable is not defined, English will be used as default. The value has the ISO 639-1 format ("de", "en", etc.) and is limited by the list supported languages. This setting can be used to set the default language for invitation emails.
The default language can be defined via `SETTINGS_DEFAULT_LANGUAGE` environment variable. If this variable is not defined, English will be used as default. The value has the ISO 639-1 format ("de", "en", etc.) and is limited by the list supported languages. This setting can be used to set the default language for invitation emails.
Important developer note: the list of supported languages is at the moment not easy defineable, as it is the minimum intersection of languages shown in the WebUI and languages defined in the ocis code for the use of notifications. Even more, not all languages where there are translations available on transifex, are available in the WebUI respectively for ocis notifications, and the translation rate for existing languages is partially not that high. You will see therefore quite often English default strings though a supported language may exist and was selected.