Managing Multi-Tenancy

Hyku can be utilized as a single-tenant application, but also provides the capacity for multiple discreet repository tenants.

Manage the Tenants in a Multi-Tenant Hyku

To view the tenant manager page, click “Accounts” in the header from the administrator home page or any page at the super admin level. Here, “tenant” and “account” are used interchangeably. This page lists all of the tenants in your repository. It displays their UUID and CNAME. You can search for, add, manage, edit, and delete tenants.

Open

Create Tenants

Click “Create New Account” to add a new tenant. This creation form only requires you to add the tenant’s short name. This is a single or hyphenated name used for technical aspects of the repository (e.g., "acme" or "acme-library"). This name will be prepended to the URL of your proprietor-level home page to access a specific tenant’s URL and home page. You can also check the Search only checkbox to make this a shared search tenant, which indexes other tenants for search but holds no content of its own. (See “Setting Up a Shared Search Tenant” below.)

New tenants default to Private, requiring HTTP authentication for access with a username and password. This use-case is helpful if you need to limit access to this tenant because it’s on a staging instance or if it’s still under construction. Tenants can be set to Public in the Edit interface (See “Edit Tenants” below).

Manage Tenants

After you create your tenant, you will be redirected to the Manage Account page. You can also manage a pre-existing tenant right away by clicking the “Manage link” from the tenant tables’s Actions. On this page, you can:

• add or invite new Repository Administrators to this tenant via email address

• switch between the tabs to see all of the current Repository Administrators and Users on this tenant

• “Add” button assigns a user as a Repository Administrator

• “Remove” button demotes a user to Registered User and revokes their Administrator permissions

Edit Tenants

Clicking the “Edit” link from the accounts table or the tenant management page takes you to an Edit Account form. Options here include:

• Is Public - A check box that allows public access without HTTP authentication.

• Domain Names - A module for setting or updating the domain name and making it it active or inactive.

• Account Settings: (Many of these are works in progress)

  • Allow Signup - Allows users to sign up to your repository.

  • Cache API - Turns on caching for API endpoints.

  • Contact Email - Indicate the email address that system notifications will be sent from.

  • Contact Email To - Indicate the email address that messages submitted via the contact page are sent to.

  • DOI Reader - Show ability to read from Datacite to populate records. NOTE: Currently WIP; not functional

  • DOI Writer - Ability to write DOIs for records. NOTE: Currently WIP; not functional

  • File ACL - Turn off if using a file system like samba or nfs that does not support setting access control lists.

  • Email Domain

  • Email Subject Prefix

  • File Size Limit - This should be set to at least 536870912000.

  • Google Analytics

  • Geonames Username - Register at http://www.geonames.org/manageaccount

  • Google Tag Manager - The ID of your Google Tag Manager account

  • OAI Admin Email - OAI endpoint contact email address.

  • OAI Prefix

  • OAI Sample Identifier

  • S3 Bucket

  • SSI Configured - Set true (check box) if using https.

• DataCite Endpoint - Tor DOI integration information, including Mode, Prefix, Username, Password.

• Solr Endpoint

• Fedora Endpoint - Including Fedora URL and base path.

Delete Tenants

To delete a tenant from your repository, click “Delete” from the tenant table. A pop up will appear to confirm the deletion. If you do so, all Collections and Works within this repository will be permanently deleted.