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
This checkbox makes a tenant available without authentication. Specific collections 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
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.
Domain Name
The Domain Name allows applications to have a customized (prettier) domain. Multiple domain names can be used at the same time.
This field is visible, but not edible. To change the domain name, the user must delete this tenant and create a new one.
Is active
The “Is active” checkbox indicates whether the domain is currently in use.
Remove Domain Name
Delete a domain from the tenant
Add Domain Name
Add a new custom domain for the tenant
Defaults:
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.
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 could also be used for statistics.
Configure Matomo - Hyku does not support Matomo. There are Matomo environment variables in Hyrax, but no institutions use it, and therefore it is not currently supported as of August 2025.
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
In the Google Analytics 4 integration, there is an option to allow Depositors to receive email messages that include analytics concerning their works. Depositors can modify the frequency of these messages in their Profile.
Default: not checked
Bulkrax Field Mappings
Hyku supports the ability to configure Bulkrax field mappings on a per-tenant basis. These mappings are visible and editable, unless modified by the hosting provider. The mappings must match the structured file used to import metadata in Bulkrac.
By default, this is pre-populated with Hyku’s default field mappings.
Cache API
Choose whether Hyku stores temporary copies of uploaded files on your server’s disk (unchecked) or in memory using Redis (checked). This speeds up file uploads and downloads, especially for large files or those with slow internet connections, the system doesn’t have to fetch them from storage (like AWS) each time.
When checked: Cached files may not update immediately if a file changes. If needed, a developer can clear the cache.
Default: unchecked; disk will be used for caching
Contact email
Email messages sent from Hyku use this email address in the “From” line.
The email address used must be approved as an authorized sender. The process for setting this up depends on the email service being used. AWS has very specific requirements that will prevent the email address from being filtered as spam. Typically, email addresses that use the domain name (see above) are acceptable. If the organization prefers to use an email address that does not share the domain name, it must be added to the “allow list” of the email service and configured in the environment settings of the application by a developer.
Default: provided by the hosting provider
Contact email to
Messages submitted by users via the Contact Form will be sent to this email address. This address does not need to be an authorized sender with the email service used.
Default: an example is provided, e.g., change-me-in-settings@example.com.
Depositor email notifications
One role within Hyku is a “Depositor.” These are users who 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 summary of the works they have submitted. Google Analytics or Matomo must be enabled (see above) for this to work. Once Google Analytics has been configured and the email notifications box has been checked, email frequency can be configured by the Depositor.
As of August 2025, there is a known bug, e.g., counts are incorrect in the summary.
Default: 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
File ACL
The File ACL (Access Control List) is a list of permissions that tells the operating system who can read or write each uploaded file. When enabled, Hyku sets these permissions automatically for files stored on the server.
Enable File ACL if your server supports Unix‑style permissions for more granular file security.
Disable File ACL if you use cloud or networked file systems that don’t support ACLs.
Default: unchecked
Email domain
This should be the domain used for the Contact Email above.
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 Measurement ID (G-XXXXXXXXXX) should be inserted here. Detailed information can be found on the Google Analytics 4 (GA4) Support page.
Default: blank
Google analytics property
The Google Analytics Property ID for Hyku should be inserted here. Detailed information can be found on the Google Analytics 4 (GA4) Support page.
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
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: an example is provided, e.g., changeme@example.com.
Oai prefix
Hyku supports OAI-PMH (Open Archives Initiative Protocol for Metadata Harvesting), which allows other systems (like aggregators or discovery tools) to harvest metadata from your repository.
The OAI Prefix sets the naming convention for all items harvested via OAI-PMH. It is usually based on your repository name or domain. For Hyku, it is oai:hyku.
Default: oai:hyku
Oai sample identifier
The OAI Sample Identifier provides one sample item to help test the OAI-PMH connection.
Default: 806bbc5e-8ebe-468c-a188-b7c14fbe34df
S3 bucket
An AWS S3 bucket can be used for static images, branding images, and derivatives. The S3 account must be configured at the application level (not the tenant level). Additional buckets can be added for tenants.
Default: blank
Ssl configured
This box should be checked if this tenant is using Secure Sockets Layer (SSL).
Default: checked
DataCite Endpoint
DataCit is a global community that shares a common interest: to ensure that research outputs and resources are openly available and connected so that their reuse can advance knowledge across and between disciplines, now and in the future.
In Hyku, DataCite provides creation and management of Digital Object Identifiers (DOIs), which are persistent links to ensure the accessibility of the content even if URLs change, enhancing discoverability.
Mode
There are two options: “test” and “production.” This allows users to test the workflow and process without creating a permanent DOI, which can be difficult or even impossible, to delete.
Default: blank
Prefix
When a new DataCite repository is created, a DOI is automatically assigned to that repository account. By default, each Repository has one prefix. A DOI prefix always starts with '10.' and continues with a number (e.g. '10.1234' or '10.20865').
Default: blank
Username
DataCite credentials consist of an Account ID (username) and password.
Default: blank
Password
DataCite credentials consist of an Account ID (username) and password.
Default: blank
Solr Endpoint
URL
Solr is an open-source search platform used by Hyku.
The Solr Endpoint URL is the web address Hyku uses to connect to its Solr server. The tenant UUID is used to match this application to its location in Solr. If this URL is incorrect, search results may be incomplete or fail entirely. Typically, this is set when the tenant is created and does not need to be changed by account admins unless a single tenant is moving their entire Solr service.
Default: provided by hosting provider
Fedora Endpoint
URL
Fedora is an open-source repository system used by Hyku to store and manage content.
The Fedora Endpoint is the URL Hyku uses to connect to the Fedora repository. Hyku sends uploaded files, metadata, and version history to Fedora for long‑term storage and retrieval.
Default: provided by hosting provider
Base Path
This is the path to the root directory in Fedora, created by using the UUID with an initial forward slash.
Default: provided by hosting provider