Chat |
Discussions |
Newsletter
Guide |
API Docs |
Code Docs
Support this project!
Work in Open Source, Ory is hiring!
Ory Kratos is the first cloud native Identity and User Management System in the world. Finally, it is no longer necessary to implement a User Login process for the umpteenth time!
The easiest way to get started with Ory Software is in Ory Cloud! Ory Cloud is free forever for developers, no credit card required.
Install the Ory CLI and create a new project to get started with Ory Kratos right away:
# If you don't have Ory CLI installed yet:
bash <(curl https://raw.githubusercontent.com/ory/meta/master/install.sh) -b . ory
sudo mv ./ory /usr/local/bin/
# Sign up
ory auth
# Create project
ory create project
Ory Cloud ships administrative user interfaces, hosted pages (e.g. for login or registration), support for custom domains, collaborative features for your colleagues, integration services, and much more!
Ory community members get the Ory Cloud Start Up plan free for half a year, with all quality-of-life features available, such as custom domains and giving your team members access. Sign up with your GitHub account and use the coupon code FIRST900 on the "Start-Up Plan" checkout page to claim your free project now! Make sure to be signed up to the Ory Community Slack when using the code!
Table of Contents
Ory Kratos is an API-first Identity and User Management system that is built according to cloud architecture best practices. It implements core use cases that almost every software application needs to deal with:
- Self-service Login and Registration: Allow end-users to create and sign into accounts (we call them identities) using Username / Email and password combinations, Social Sign In ("Sign in with Google, GitHub"), Passwordless flows, and others.
- Multi-Factor Authentication (MFA/2FA): Support protocols such as TOTP (RFC 6238 and IETF RFC 4226 - better known as Google Authenticator)
- Account Verification: Verify that an E-Mail address, phone number, or physical address actually belong to that identity.
- Account Recovery: Recover access using "Forgot Password" flows, Security Codes (in case of MFA device loss), and others.
- Profile and Account Management: Update passwords, personal details, email addresses, linked social profiles using secure flows.
- Admin APIs: Import, update, delete identities.
We highly recommend reading the Ory Kratos introduction docs to learn more about Ory Krato's background, feature set, and differentiation from other products.
The Ory community stands on the shoulders of individuals, companies, and maintainers. We thank everyone involved - from submitting bug reports and feature requests, to contributing patches, to sponsoring our work. Our community is 1000+ strong and growing rapidly. The Ory stack protects 16.000.000.000+ API requests every month with over 250.000+ active service nodes. We would have never been able to achieve this without each and everyone of you!
The following list represents companies that have accompanied us along the way and that have made outstanding contributions to our ecosystem. If you think that your company deserves a spot here, reach out to office-muc@ory.sh now!
Please consider giving back by becoming a sponsor of our open source work on Patreon or Open Collective.
| Type | Name | Logo | Website |
|---|---|---|---|
| Sponsor | Raspberry PI Foundation |  |
raspberrypi.org |
| Contributor | Kyma Project |  |
kyma-project.io |
| Sponsor | Tulip |  |
tulip.com |
| Sponsor | Cashdeck / All My Funds |  |
cashdeck.com.au |
| Contributor | Hootsuite |  |
hootsuite.com |
| Adopter * | Segment |  |
segment.com |
| Adopter * | Arduino |  |
arduino.cc |
| Adopter * | DataDetect |  |
unifiedglobalarchiving.com/data-detect/ |
| Adopter * | Sainsbury's |  |
sainsburys.co.uk |
| Adopter * | Contraste |  |
contraste.com |
| Adopter * | Reyah |  |
reyah.eu |
| Adopter * | Zero |  |
getzero.dev |
| Adopter * | Padis |  |
padis.io |
| Adopter * | Cloudbear |  |
cloudbear.eu |
| Adopter * | Security Onion Solutions |  |
securityonionsolutions.com |
| Adopter * | Factly |  |
factlylabs.com |
| Adopter * | Nortal |  |
nortal.com |
| Sponsor | OrderMyGear |  |
ordermygear.com |
| Sponsor | Spiri.bo |  |
spiri.bo |
| Sponsor | Strivacity |  |
strivacity.com |
| Adopter * | Hanko |  |
hanko.io |
| Adopter * | Rabbit |  |
rabbit.co.th |
| Adopter * | inMusic |  |
inmusicbrands.com |
| Adopter * | Buhta |  |
buhta.com |
We also want to thank all individual contributors
as well as all of our backers
and past & current supporters (in alphabetical order) on Patreon: Alexander Alimovs, Billy, Chancy Kennedy, Drozzy, Edwin Trejos, Howard Edidin, Ken Adler Oz Haven, Stefan Hans, TheCrealm.
* Uses one of Ory's major projects in production.
To get started with some easy examples, head over to the Get Started Documentation.
Head over to the Ory Developer Documentation to learn how to install Ory Kratos on Linux, macOS, Windows, and Docker and how to build Ory Kratos from source.
We build Ory on several guiding principles when it comes to our architecture design:
- Minimal dependencies
- Runs everywhere
- Scales without effort
- Minimize room for human and network errors
Ory's architecture is designed to run best on a Container Orchestration system such as Kubernetes, CloudFoundry, OpenShift, and similar projects. Binaries are small (5-15MB) and available for all popular processor types (ARM, AMD64, i386) and operating systems (FreeBSD, Linux, macOS, Windows) without system dependencies (Java, Node, Ruby, libxml, ...).
Ory Kratos is an API-first Identity and User Management system that is built according to cloud architecture best practices. It implements core use cases that almost every software application needs to deal with: Self-service Login and Registration, Multi-Factor Authentication (MFA/2FA), Account Recovery and Verification, Profile, and Account Management.
Ory Hydra is an OpenID Certifiedā¢ OAuth2 and OpenID Connect Provider which easily connects to any existing identity system by writing a tiny "bridge" application. Gives absolute control over user interface and user experience flows.
Ory Oathkeeper is a BeyondCorp/Zero Trust
Identity & Access Proxy (IAP) with configurable authentication, authorization,
and request mutation rules for your web services: Authenticate JWT, Access
Tokens, API Keys, mTLS; Check if the contained subject is allowed to perform the
request; Encode resulting content into custom headers (X-User-ID), JSON Web
Tokens and more!
Ory Keto is a policy decision point. It uses a set of access control policies, similar to AWS IAM Policies, in order to determine whether a subject (user, application, service, car, ...) is authorized to perform a certain action on a resource.
Running identity infrastructure requires attention and knowledge of threat models.
If you think you found a security vulnerability, please refrain from posting it publicly on the forums, the chat, or GitHub and send us an email to hi@ory.am instead.
Ory's services collect summarized, anonymized data that can optionally be turned off. Click here to learn more.
The Guide is available here.
The HTTP API is documented here.
New releases might introduce breaking changes. To help you identify and incorporate those changes, we document these changes in the CHANGELOG.md. For upgrading, please visit the upgrade guide.
Run kratos -h or
kratos help.
We encourage all contributions and encourage you to read our contribution guidelines
You need Go 1.16+ and (for the test suites):
- Docker and Docker Compose
- Makefile
- NodeJS / npm
It is possible to develop Ory Kratos on Windows, but please be aware that all guides assume a Unix shell like bash or zsh.
make install
You can format all code using make format. Our CI checks if your code is properly formatted.
There are three types of tests you can run:
- Short tests (do not require a SQL database like PostgreSQL)
- Regular tests (do require PostgreSQL, MySQL, CockroachDB)
- End to end tests (do require databases and will use a test browser)
Short tests run fairly quickly. You can either test all of the code at once
go test -short -tags sqlite ./...or test just a specific module:
cd client; go test -tags sqlite -short .Regular tests require a database set up. Our test suite is able to work with docker directly (using ory/dockertest) but we encourage to use the Makefile instead. Using dockertest can bloat the number of Docker Images on your system and are quite slow. Instead we recommend doing:
make test
Please be aware that make test recreates the
databases every time you run make test. This
can be annoying if you are trying to fix something very specific and need the
database tests all the time. In that case we suggest that you initialize the
databases with:
make test-resetdb
export TEST_DATABASE_MYSQL='mysql://root:secret@(127.0.0.1:3444)/mysql?parseTime=true'
export TEST_DATABASE_POSTGRESQL='postgres://postgres:secret@127.0.0.1:3445/kratos?sslmode=disable'
export TEST_DATABASE_COCKROACHDB='cockroach://root@127.0.0.1:3446/defaultdb?sslmode=disable'Then you can run go test as often as you'd like:
go test -tags sqlite ./...
# or in a module:
cd client; go test -tags sqlite .Some tests use fixtures. If payloads change, you can update them with:
make test-update-snapshots
This will only update the snapshots of the short tests. To update all snapshots, run:
UPDATE_SNAPSHOTS=true go test -p 4 -tags sqlite ./...You can also run this command from a sub folder.
We use Cypress to run our e2e tests.
The simplest way to develop e2e tests is:
./test/e2e/run.sh --dev sqlite
You can run all tests (with databases) using:
make test-e2e
For more details, run:
./test/e2e/run.sh
Run only a singular test
Add .only to the test you would like to run.
For example:
it.only('invalid remote recovery email template', () => {
...
})Run a subset of tests
This will require editing the cypress.json file located in the test/e2e/ folder.
Add the testFiles option and specify the test to run inside the cypress/integration folder.
As an example we will add only the network tests.
"testFiles": ["profiles/network/*"],Now start the tests again using the run script or makefile.
You can build a development Docker Image using:
make docker
To prepare documentation tests, run npm i to install
Text-Runner.
- test all documentation:
make test-docs - test an individual file:
text-run
- update the SDK including the OpenAPI specification:
make sdk - run preview server for API documentation:
make docs/api - run preview server for swagger documentation:
make docs/swagger