About Hanko

Hanko is an open-source authentication and user management solution with a focus on moving the login beyond passwords while being 100% deployable today.

• Supports all modern authentication methods, incl. passkeys, social logins, and SAML SSO
• Highly flexible configuration options (e.g. optional/user-deletable passwords, passkey-only, OAuth-only)
• Fast integration with Hanko Elements web components (embeddable components for login/registration and account profile)
• API-first, small footprint, cloud-native

Available for self-hosting and on Hanko Cloud.

Features

To follow the development of this project, watch our releases, leave a star, sign up to our Product News or join our Discord Community. Here's a brief overview of Hanko's current and upcoming features:

Visit our Roadmap for more information.

Contact us

Schedule a Hanko demo. Learn how Hanko will speed up your registration and login flows with passkeys.

Architecture

The main building blocks of the Hanko project are

• backend - An authentication API for passkeys, passcodes, and (optional) passwords, OAuth SSO, as well as user management and JWT issuing
• hanko-elements - Web components made for Hanko backend that provide onboarding and login functionality and are customizable with CSS
• hanko-frontend-sdk - A client package for using the Hanko API

The remainder of the repository consists of:

• quickstart - A quickstart example app showing off Hanko's login experience and acting as a reference implementation
• examples - Example implementations for a number of frameworks
• docs - The Hanko documentation (docs.hanko.io) -> Moved to its own repo here: https://github.com/teamhanko/docs

Getting started

1. Try our hosted live example and our companion page passkeys.io or use the quickstart app to get a feel for the user experience provided by an application that leverages the Hanko backend API and our custom web component
2. To run the project locally, there are two options available:
   • Bare metal:
     • Head over to the backend section to learn how to get it up and running for your own project. Use Hanko Cloud for a hosted backend.
   • Docker:
     • If you prefer to use Docker to run the project locally, please visit the Run the quickstart for information on how to run the project. This will create everything, including frontend and backend components.
     • If you wish to keep only the backend components, you can modify the quickstart.yaml to remove the unnecessary services. To make changes to the configuration to meet your needs, modify config.yaml.
3. Then, integrate hanko-elements – we provide example applications and guides for your favourite frontend framework in the official documentation
4. if you have an enterprise license or use Hanko Cloud you can also integrate SAML SSO. Feel free to use this guide to start with SAML SSO

If you want to use the Hanko backend API but prefer to build your own UI, you can still make use of the hanko-frontend-sdk. It forms the basis of our web components, and the client it provides handles communication with the Hanko backend API and saves you the time of rolling your own.

Community

Questions, bugs, ideas

If you have any questions or issues, please check this project's Q&A section in discussions and the open issues. Feel free to comment on existing issues or create a new issue if you encounter any bugs or have a feature request. For yet unanswered questions, feedback, or new ideas, please open a new discussion.

Discord community & X

We invite you to join our growing Discord Community if you want to get the latest updates on passkeys, WebAuthn, and this project or if you just want to chat with us. You can also follow us on X.

Licenses

hanko-elements and hanko-frontend-sdk are licensed under the MIT License. Everything else in this repository, including hanko backend, is licensed under the AGPL-3.0.