ShimoDocs
Get started

Docs

Tenant Management

5 min read · Edit this page on GitHub ↗

← ShimoDocs Suite Deployment Documentation

Tip

Tenant management is used to centrally manage tenants in ShimoDocs Suite. Administrators can view the number of tenants and seat usage, obtain third-party integration credentials, manage AI configurations, and create, edit, enable, or disable tenants here.

1. Access Tenant Management

  1. Log in to the MDP Operations Platform.
  2. Select ShimoDocs Suite in the left navigation bar.
  3. Select Tenant Management.

2. Understand the Tenant Management Page

The top of the page displays the overall information of the current system:

Area Description
API-KEY View and copy AppID and AppSecret.
AI Settings Check if AI features are enabled and access AI model and search configurations.
Total Tenants The number of tenants created in the current system.
Enabled Tenants The number of tenants currently enabled.
Seat Usage The number of seats used, total seats in the system, and usage ratio.

The tenant list below shows the tenant name, activation time, tenant administrator, seat usage, and current status. In the “Actions” column, you can edit or disable the corresponding tenant.

3. View API Keys

AppID and AppSecret are used for authentication when ShimoDocs Suite integrates with third-party systems.

Steps

  1. Find the API-KEY on the tenant management page and select the card.
  2. Click the copy icon.
  3. The system will copy the current environment’s AppID and AppSecret.
  4. Enter the credentials into the corresponding third-party integration configuration.

AppSecret is a sensitive credential. Please keep it safe and do not write it in public documents, chat records, or publicly accessible code repositories.

4. Managing AI Configuration

The AI configuration card displays the activation status of the current AI capabilities.

After clicking the AI configuration card, you can view or edit the following on the “AI Models and Search Configuration” page:

1. Basic Model Configuration

Used to configure general large language models (LLMs) and their available models. On this page, you can view information such as the provider, request URL, API key, default model, model ID, context window, and input capabilities.

2. Image Model Configuration

Used for configuring image generation or image editing models. On the page, you can view the provider, model name, base URL, API key, and supported image features.

3. Web Search Engine Configuration

Used for configuring AI web search services. On the page, you can view the service provider, interface address, API key, and timeout.

4. Embedded Vendor Configuration

Used for configuring text vectorization services. On the page, you can view the base URL, API key, embedding model, and vector dimensions.

Before modifying AI configurations, please first confirm that the service address, API key, model ID, and capability parameters are all correct. After modification, it is recommended to use a small amount of test content to verify whether the model call is functioning properly.

5. Using AI ShimoDocs Suite

After configuration is complete, you can use AI features within ShimoDocs Suite.

5. Managing Existing Tenants

In the tenant list, you can view the basic information and seat usage of each tenant.

Edit Tenant

  1. Find the tenant you need to adjust.
  2. Click “Edit” in the “Actions” column.
  3. Modify the tenant information or number of seats according to the page prompts.
  4. Save the changes and return to the list to confirm the information has been updated.

Disable or Restore Tenant

  • For tenants that are currently enabled, you can click “Disable” in the “Actions” column.
  • To restore a disabled tenant, re-enable it in the corresponding tenant’s actions.

Disabling a tenant will affect normal access to that tenant. Please confirm that the target tenant is correct before proceeding, and schedule the operation according to actual usage.

6. Activate a New Tenant

Before activating a tenant, check the seat usage at the top of the page to ensure that there are seats available for allocation.

Steps

  1. Click “Activate New Tenant” at the top right corner of the page.
  2. Enter a name in ‘Tenant Name’ to identify this tenant.
  3. Confirm the tenant administrator email generated by the system. After the tenant is successfully created, please save this administrator account and initial password, and record them as soon as possible.
  4. Check ‘Assignable Seats’ to see the maximum number of seats that can currently be assigned to the new tenant.
  5. Enter the number of seats to be assigned to this tenant in ‘Tenant Assigned Seats’.
  6. After confirming the information is correct, click ‘Save’.

Seat Field Description

Field Description
Assignable Seats The maximum number of seats that can currently be assigned to a tenant by the system.
Seats Assigned to Tenant The total number of seats assigned to this tenant. This number cannot be less than the number of seats already used by the tenant.
Seats Used by Tenant The number of active company members in this tenant. Each active member occupies one seat.

When creating a tenant, a certain number of seats need to be allocated. The number of seats can be adjusted later based on actual usage.

7. First Login and Changing Initial Password PASSWORD

After the tenant is successfully created, please use the system-generated default account or administrator account to log in to ShimoDocs Suite and immediately change the initial password PASSWORD.

1. Open ShimoDocs Suite

Visit in a browser:

http://<ACCESS_DOMAIN>/

If HTTPS is configured, please visit:

https://<ACCESS_DOMAIN>/

2. Log in to ShimoDocs Suite

Enter the administrator account and the initial password PASSWORD created when setting up the tenant to complete the login.

3. Change the initial PASSWORD

After logging in for the first time, please follow the instructions on the page or the account security settings to change the initial password. Once a new PASSWORD is set, please keep it properly.