From d024212985333391fa191203da1efb8cbe11b414 Mon Sep 17 00:00:00 2001 From: Thomas Georgios Giannos Date: Fri, 10 May 2024 14:39:25 +0300 Subject: [PATCH] Added docs for tenant configurtions, small fix on en.json about app colors --- dmp-frontend/src/assets/i18n/en.json | 2 +- .../administration/tenant-configuration.md | 69 ++++++++++++++++++- 2 files changed, 69 insertions(+), 2 deletions(-) diff --git a/dmp-frontend/src/assets/i18n/en.json b/dmp-frontend/src/assets/i18n/en.json index 26f39838b..8f50accb6 100644 --- a/dmp-frontend/src/assets/i18n/en.json +++ b/dmp-frontend/src/assets/i18n/en.json @@ -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", diff --git a/docs/docs/documentation/administration/tenant-configuration.md b/docs/docs/documentation/administration/tenant-configuration.md index 694d23ad2..718c297da 100644 --- a/docs/docs/documentation/administration/tenant-configuration.md +++ b/docs/docs/documentation/administration/tenant-configuration.md @@ -5,4 +5,71 @@ description: Configure the tenant you are logged in with # Tenant Configuration -TODO: thgiannos \ No newline at end of file +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. + +::: + +
+ Default Tenant Locale + +Here we specify the locale configuration, which will be applied by default to the users of this tenant. + +- **Timezone** +- **Culture** +- **Language** +
+ +
+ App Colors + +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** +
+ +
+ Deposit Plugins + +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.
*Please refer to the next section.* +- **Rda Transformer Id**: The id of the file transformer plugin used for rda files, if configured and available.
*Please refer to the next section.* +
+ +
+ File Transformer Plugins + +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.
*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. +
+ +
+ Extra Logo + +Here we can upload an extra logo, which will be displayed next to the platform logo. It is a great way for tenant branding. +
+ +
+ Notification Preferences + +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. +
\ No newline at end of file