Added docs for tenant configurtions, small fix on en.json about app colors

This commit is contained in:
Thomas Georgios Giannos 2024-05-10 14:39:25 +03:00
parent 6ed11c2cdd
commit d024212985
2 changed files with 69 additions and 2 deletions

View File

@ -348,7 +348,7 @@
"LANGUAGE": "Language",
"PRIMARY-COLOR": "Primary Color",
"PRIMARY-COLOR-2": "Primary Color 2",
"PRIMARY-COLOR-3": "Primary Color 2",
"PRIMARY-COLOR-3": "Primary Color 3",
"SECONDARY-COLOR": "Secondary Color",
"DISABLE-SYSTEM-SOURCES": "Disable System Sources",
"DEPOSIT-PLUGINS": "Plugin",

View File

@ -5,4 +5,71 @@ description: Configure the tenant you are logged in with
# Tenant Configuration
TODO: thgiannos
On this page, we can configure the tenant we are logged in with. The configuration options are separated in the following sections.
:::info
Only tenant administrators can access this page.
:::
<details>
<summary>Default Tenant Locale</summary>
Here we specify the locale configuration, which will be applied by default to the users of this tenant.
- **Timezone**
- **Culture**
- **Language**
</details>
<details>
<summary>App Colors</summary>
Here we specify the color accents, which will be applied to the UI when this tenant is selected. Every tenant can have a different theme.
- **Primary Color**
- **Primary Color 2**
- **Primary Color 3**
- **Secondary Color**
</details>
<details>
<summary>Deposit Plugins</summary>
Here we specify the deposit plugins, which will be available for this tenant. We can add plugins by pressing the `Add Source` button. For every plugin, we have to specify the following.
- **Repository Id**: An identifier for the deposit plugin.
- **Url**: The url of the endpoint the deposit listens to.
- **Issuer Url**: The authentication token issuer url.
- **Client Id**: The authentication client.
- **Client Secret**: The authentication client secret.
- **Scope**: The authentication token scope.
- **Pdf Transformer Id**: The id of the file transformer plugin used for pdf files, if configured and available.<br/>*Please refer to the next section.*
- **Rda Transformer Id**: The id of the file transformer plugin used for rda files, if configured and available.<br/>*Please refer to the next section.*
</details>
<details>
<summary>File Transformer Plugins</summary>
Here we specify the file transformer plugins, which will be available for this tenant. We can add plugins by pressing the `Add Source` button. For every plugin, we have to specify the following.
- **Transformer Id**: An identifier for the transformer plugin.<br/>*This id can be added on deposit plugin configurations.*
- **Url**: The url of the endpoint the deposit listens to.
- **Issuer Url**: The authentication token issuer url.
- **Client Id**: The authentication client.
- **Client Secret**: The authentication client secret.
- **Scope**: The authentication token scope.
</details>
<details>
<summary>Extra Logo</summary>
Here we can upload an extra logo, which will be displayed next to the platform logo. It is a great way for tenant branding.
</details>
<details>
<summary>Notification Preferences</summary>
Here we specify the notification preferences, which will be applied by default to the users of this tenant. For every notification case, we can specify the channels which will be used and their priority.
</details>