Editing Accounts on Server and Within Tenants

Editing Accounts on Server and Within Tenants

The page includes configuration information for each tenant and is available to Super Admins via the server/web (all fields are available) and Repository Administrators from within the tenant (available fields are dependent on hosting provider).

Super Admins have access to all fields only on the server/web. When logged into a tenant using Super Admin credentials, only configuration options available to Repository Administrators will be available.

Is public

image-20250716-183448.png
Checkbox for “Is Public” option

This checkbox makes a tenant available without authentication. Specific collection and/or works can be hidden within a publicly-available tenant. Unchecking this box will require a user to log in.

Default: unchecked

Tenant UUID

image-20250716-185851.png
Field for Tenant UUID

Each tenant has a unique identifier assigned by the system called the UUID (Universally Unique Identifier). This field is visible, but not editable.

Domain Names

These fields describe the domain name(s) used for this tenant.

image-20250716-192540.png
Fields for Domain Names

Domain Name

This field is visible, but not edible. To change the domain name, the user must delete this tenant and create and new one.

Is active

The “Is active” checkbox . . .

Remove/add domain names

“remove domain name” and “add domain name” - use cases; why would this be used?

Default:

  • Current domain name displayed

  • “Is active” is checked

  • No additional domain names

Account Setting

These fields allow Super Admins to add or modify functionality for this tenant.

image-20250716-213112.png
Account Settings

Allow downlads

By checking this box, all publicly-available objects within this tenant will include an option to download the file(s).

Default: Checked

Allow signup

By checking this box, the tenant home page will include an option for users to create an account for the repository.

Default: not checked

Analytics

To use Google Analytics 4 for statistics, this box must be checked. This allows libraries to retrieve statistics directly from Google. With additional server configuration, Matomo is another option for statistics.

  • Configure Google Analytics 4 - link to documentation

  • Configure Matomo - link to documentation

Default: checked

Analytics reporting

To view use statistics from Google Analytics 4 within Hyku, this box must be checked. As of July 2025, statistics viewed within Hyku are at the server, not repository, level. Tenant-level viewing is on the roadmap.

Default: checked

Batch email notifications

Help!!

Default: not checked

Bulkrax Field Mappings

Mappings are visible and editable; must update structured file used to import metadata to match

Help

image-20250716-213330.png
Account Settings

Cache API

Help

Default: unchecked

Contact email

System notifications are sent to this email address. These can include . . . If a domain other than that used for the tenant is needed, contact your server administrator or hosting provider.

Default: provided by the hosting provider

Contact email to

Messages submitted by users via the Contact Form will be sent to this email address.

Default: an example is provided, e.g., change-me-in-settings.example.com ==> Do we need this message anymore? Don’t we just add an email address here?

Depositor email notifications

One role within Hyku is a “Depositor.” These are users that only submit works and metadata to either be automatically added to the collection or checked by a staff member for quality control. If this box is checked, depositors will receive a daily summary of the works they have submitted. Google Analytics or Matomo must be enabled (see above) for this to work.

Defaul: unchecked

DOI reader

This functionality is not yet available in Hyku. When available, it will allow users and library staff to auto-populate metadata from DataCite records.

Default: unchecked

DOI writer

This functionality is not yet available in Hyku. When available, it will create DOIs for records and update DataCite.

Default: unchecked

image-20250716-214438.png
Account Settings

File ACL

Help

Default: unchecked

Email domain

Help - why is this here? Is this connected to the additional domain needed for the Contact Email field?

Default: an example is provided, e.g., example.com

Email subject prefix

Email messages from Hyku will include this prefix in the subject line, e.g., Hyku Support or Hyku Question. This can be useful to auto-filter email messages into specific folders.

Default: blank

File size limit

In bytes, this field indicates the largest file size that can be uploaded to Hyku. For example, 5368709120 bytes equals 5.3687 gigabytes.

Default: 5368709120

Google analytics

The library’s Google Analytics ID should be inserted here. This is provided through their setup process.

Default: blank

Google analytics property

The Google Analytics property for Hyku should be inserted here. This is provided through their setup process.

Default: blank

Geonames username

To use the Location metadata field, a Geonames username is required. This is a free account and can be found at http://www.geonames.org/manageaccount .

Default: blank

image-20250716-215500.png
Accounts Settings

Google tag manager

Not required, but institutions can use the Google Tag Manager as part of the Google Analytics implementation.

Default: blank

Oai admin email

This field includes the email address for the contact at the institution that is knowledgeable and can answer questions about their Open Archives Initiative (OAI) implementation.

Default: blank

Oai prefix

Help

Default: oai:hyku

Oai sample identifier

Help

Default: 806bbc5e-8ebe-468c-a188-b7c14fbe34df

S3 bucket

Help

Default: blank

Ssl configured

This box should be check if this tenant is using Secure Sockets Layer (SSL).

Default: checked

DataCite Endpoint

image-20250716-220008.png
Settings for DataCite Endpoint

Mode

Help

Default: blank

Prefix

Help

Default: blank

Username

Help

Default: blank

Password

Help

Default: blank

Solr Endpoint

image-20250716-220133.png
URL for Solr Endpoint

URL

Solr is an open-source search platform used by Hyku. To connect with Solr, Hyku requires its endpoint, or URL, so it can find the search service.

Default: provided by hosting provider

image-20250716-220344.png
Settings for Fedora Endpoint

Fedora Endpoint

URL

Fedora is an open-source repository system used by Hyku to store and manage content. To connect with Fedora, Hyku requires its endpoint, or URL, so it can find the service.

Default: provided by hosting provider

Base Path

This is the path to the root directory in Fedora.

Default: provided by hosting provider