You are here

Managing tenants

The default Alfresco administrator user has access to the default environment and can be considered to be a "super tenant". Use the Tenant Console in the Admin Console to manage tenants.

  1. Open the Admin Console.
  2. In the Consoles section, click Tenant Console.

    You see the Tenant Console page.

  3. Perform the following as required:
    1. To list all tenants and show their details, type show tenants.
    2. To show details for a single tenant, type show tenant <tenant domain>.

      This shows the status (for example, whether it is enabled or disabled) and the root content store directory.

    3. To create a tenant, type create <tenant domain> <tenant admin password> [<root contentstore dir>].

      For example, create l3tm31n /usr/tenantstores/zzz

      This creates an empty tenant. By default the tenant will be enabled. It will have an administrator user called admin@<tenant domain> with the supplied password. All users that the administrator creates can log in using <username>@<tenant domain>. The root of the contentstore directory can be optionally specified. If it is not specified, or does not exist, the repository default root content store will be used (as specified by the dir.contentstore property).

      Tenant metadata is co-mingled but the binaries can be separated if, for example, multiple volumes are used to store groups of tenants.

    4. To enable a tenant, type enable <tenant domain>.

      This enables the tenant so that it is active and available for new logins.

    5. To disable a tenant, type disable <tenant domain>.

      This disables the tenant so that it is inactive and prevents tenant login.

Note: If you have pre-existing user logins with syntax <name>@<domain>, you should not create a tenant with that domain name. This will break the login functionality of the existing users with logins <name>@<domain>.