Hyku Documentation Wiki Space
1.1 Getting Oriented: An Overview of Hyku
Hyku is a flexible digital repository application based on Hyrax. It offers an easy-to-install, easy-to-configure, feature-rich solution that reduces barriers to effective asset management and preservation for collections and content types of any kind. It is supported by a vibrant and ever-growing open-source community.
Hyku is open-source - anyone can get involved and contribute to it. It is continually in development and new features and changes are being added regularly.
If you’d like to learn more about Hyku’s relationship to the Samvera Foundation and Hyrax, see 1.3.1 Hyku vs Hyrax: Questions and Answers
For a detailed list of features: 1.2.1 Hyku Features.
For planned and requested features: Proposed Features and Needs
Hosting
There are a number of options for hosting an instance of Hyku:
Host it yourself. This is a good fit for larger institutions with sufficient IT and engineering resources.
Join a consortium. There are a number of consortia that host instances of Hyku.
Hosting Vendors. There are a number of vendors that also provide hosting services. They all have different value, capabilities, and price points.
Notch8 is a certified Samvera service provider, and a major contributor to Hyku. They host a number of Hyku instances for institutions, and have a hosted instance, HykuUP.
Amigos Library Services is a Samvera partner, and a non-profit, 501(c)3 member-based organization, with a mission to support libraries through the sharing of collections, services, and opportunities
Navigation
A Hyku application has two sides: the Dashboard for Registered Users and the Discovery view for public Users. When a User logs in to the application, they are on the Dashboard. The repository’s Discovery view, or public homepage, is accessed by clicking on the repository name or icon in the header, or by logging out of the application. Users can also navigate back to the Dashboard by clicking on their name in the header and clicking the “Dashboard” link.
Dashboard/Repository Activity
On login, users are redirected to their dashboard. This page will look different for Repository Administrators vs. public Registered Users.
Public Registered User Dashboard
Public Registered (non-Admin) Users will see:
Activity
Repository Activity
Activity Summary
Your Activity
Profile - All Users have a profile which can be edited from here. It includes the number of collections and works created by the user, and space to include email, phone, address. Contact information for a User can only be edited by a Super Admin (see Manage Users Across the Entire Repository). “Edit Profile” allows users to update a profile photo and edit ORCID ID and social media handles; these fields only appear on the profile if they contain a value. Users can also curate highlighted works on their profile here.
Notifications - Displays anything that requires the user’s attention, including Work ownership change requests, approval status for mediated submissions, and batch Work updates. It includes a search bar to find notifications by keyword. Notifications can be deleted individually or with a “Delete All” button that clears them all.
Transfers - Work ownership can be transferred (see …). A log of transfer requests sent or received by the user is displayed here.
Manage Proxies - Users can allow other users to deposit Works on their behalf, which allows both users edit rights to those Works. In this UI, users can search for other registered users to assign or revoke these proxy rights. This can also be done at the individual work level for specific works.
Repository Contents
Collections - Lists any collections created by this users, with limited ability to administer changes.
Works - Lists any works created by this user, with limited ability to administer changes.
Importers - Non-admin users cannot access this module.
Exporters - Non-admin users cannot access this module.
Repository Administrator Dashboard
Administrator level Users will see:
Activity
Repository Activity
Activity Summary
System Status
Your Activity (same as Public Registered User)
Profile
Notifications
Transfers
Manage Proxies
Reports - Module for analytics reporting.
Repository Contents (same as Public Registered User)
Collections
Works
Importers
Exporters
Tasks
Review Submissions
Manage Users
Manage Groups
Manage Embargoes
Manage Leases
Configuration
Settings
Account
Identity Providers
Labels
Appearance
Collection Types
Pages
Content Blocks
Features
Available Work Types
Workflow Roles