| Name | Logo | Website | Case Study |
|---|---|---|---|
| OpenAI |
|
openai.com | OpenAI Case Study |
| Fandom |
|
fandom.com | Fandom Case Study |
| Lumin |
|
luminpdf.com | Lumin Case Study |
| Sencrop |
|
sencrop.com | Sencrop Case Study |
| OSINT Industries |
|
osint.industries | OSINT Industries Case Study |
| HGV |
|
hgv.it | HGV Case Study |
| Maxroll |
|
maxroll.gg | Maxroll Case Study |
| Zezam |
|
zezam.io | Zezam Case Study |
| T.RowePrice |
|
troweprice.com | |
| Mistral |
|
mistral.ai | |
| Axel Springer |
|
axelspringer.com | |
| Hemnet |
|
hemnet.se | |
| Cisco |
|
cisco.com | |
| Presidencia de la República Dominicana |
|
presidencia.gob.do | |
| Moonpig |
|
moonpig.com | |
| Booster |
|
choosebooster.com | |
| Zaptec |
|
zaptec.com | |
| Klarna |
|
klarna.com | |
| Raspberry PI Foundation |
|
raspberrypi.org | |
| Tulip |
|
tulip.com | |
| Hootsuite |
|
hootsuite.com | |
| Segment |
|
segment.com | |
| Arduino |
|
arduino.cc | |
| Sainsbury's |
|
sainsburys.co.uk | |
| Contraste |
|
contraste.com | |
| inMusic |
|
inmusicbrands.com | |
| Buhta |
|
buhta.com | |
| Amplitude |
|
amplitude.com | |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
## Getting Started
To get started with some easy examples, head over to the
[Get Started Documentation](https://www.ory.sh/docs/guides/protect-page-login/).
### Installation
Head over to the
[Ory Developer Documentation](https://www.ory.sh/kratos/docs/install) to learn
how to install Ory Kratos on Linux, macOS, Windows, and Docker and how to build
Ory Kratos from source.
## Ecosystem
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: Identity and User Infrastructure and Management
[Ory Kratos](https://github.com/ory/kratos) is an API-first Identity and User
Management system that is built according to
[cloud architecture best practices](https://www.ory.sh/docs/next/ecosystem/software-architecture-philosophy).
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: OAuth2 & OpenID Connect Server
[Ory Hydra](https://github.com/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. It gives absolute control over the user
interface and user experience flows.
### Ory Oathkeeper: Identity & Access Proxy
[Ory Oathkeeper](https://github.com/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: Access Control Policies as a Server
[Ory Keto](https://github.com/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.
## Security
Running identity infrastructure requires
[attention and knowledge of threat models](https://www.ory.sh/kratos/docs/concepts/security).
### Disclosing vulnerabilities
If you think you found a security vulnerability, please refrain from posting it
publicly on the forums, the chat, or GitHub. You can find all info for
responsible disclosure in our
[security.txt](https://www.ory.sh/.well-known/security.txt).
## Telemetry
Ory's services collect summarized, anonymized data that can optionally be turned
off. Click [here](https://www.ory.sh/docs/ecosystem/sqa) to learn more.
## Documentation
### Guide
The Guide is available [here](https://www.ory.sh/kratos/docs).
### HTTP API documentation
The HTTP API is documented [here](https://www.ory.sh/kratos/docs/sdk/api).
### Upgrading and Changelog
New releases might introduce breaking changes. To help you identify and
incorporate those changes, we document these changes in the
[CHANGELOG.md](./CHANGELOG.md). For upgrading, please visit the
[upgrade guide](https://www.ory.sh/kratos/docs/guides/upgrade).
### Command line documentation
Run kratos -h or
kratos help.
### Develop
We encourage all contributions and encourage you to read our
[contribution guidelines](./CONTRIBUTING.md)
#### Dependencies
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.
#### Install from source
make install#### Formatting Code You can format all code using
make format. Our
CI checks if your code is properly formatted.
#### Running Tests
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
Short tests run fairly quickly. You can either test all of the code at once
```shell script
go test -short -tags sqlite ./...
```
or test just a specific module:
```shell script
cd client; go test -tags sqlite -short .
```
##### Regular Tests
Regular tests require a database set up. Our test suite is able to work with
docker directly (using [ory/dockertest](https://github.com/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 testPlease 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:
```shell script
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:
```shell script
go test -tags sqlite ./...
# or in a module:
cd client; go test -tags sqlite .
```
##### Updating Test Fixtures
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:
```bash
UPDATE_SNAPSHOTS=true go test -p 4 -tags sqlite ./...
```
You can also run this command from a sub folder.
##### End-to-End Tests
We use [Cypress](https://www.cypress.io) to run our e2e tests.
⚠️ To run Cypress on ARM based Mac's, at the moment it is
[necessary to install Rosetta 2](https://www.cypress.io/blog/2021/01/20/running-cypress-on-the-apple-m1-silicon-arm-architecture-using-rosetta-2/).
To install, use the command -
`softwareupdate --install-rosetta --agree-to-license`
The simplest way to develop e2e tests is:
./test/e2e/run.sh --dev sqliteYou can run all tests (with databases) using:
make test-e2eFor more details, run:
./test/e2e/run.sh**Run only a singular test** Add `.only` to the test you would like to run. For example: ```ts 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. ```json "testFiles": ["profiles/network/*"], ``` Now start the tests again using the run script or makefile. #### Build Docker You can build a development Docker Image using:
make docker#### Preview API documentation - 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