authentik/README.md

32 lines
1.7 KiB
Markdown
Raw Normal View History

<img src="website/static/img/logo.svg" height="50" alt="passbook logo"><img src="website/static/img/brand_inverted.svg" height="50" alt="passbook">
2020-07-12 21:53:25 +01:00
[![CI Build status](https://img.shields.io/azure-devops/build/beryjuorg/passbook/1?style=flat-square)](https://dev.azure.com/beryjuorg/passbook/_build?definitionId=1)
![Tests](https://img.shields.io/azure-devops/tests/beryjuorg/passbook/1?compact_message&style=flat-square)
2020-07-12 21:53:25 +01:00
[![Code Coverage](https://img.shields.io/codecov/c/gh/beryju/passbook?style=flat-square)](https://codecov.io/gh/BeryJu/passbook)
2020-06-15 10:56:20 +01:00
![Docker pulls](https://img.shields.io/docker/pulls/beryju/passbook.svg?style=flat-square)
![Latest version](https://img.shields.io/docker/v/beryju/passbook?sort=semver&style=flat-square)
![LGTM Grade](https://img.shields.io/lgtm/grade/python/github/BeryJu/passbook?style=flat-square)
2020-05-27 16:26:35 +01:00
## What is passbook?
2020-05-27 16:57:43 +01:00
passbook is an open-source Identity Provider focused on flexibility and versatility. You can use passbook in an existing environment to add support for new protocols. passbook is also a great solution for implementing signup/recovery/etc in your application, so you don't have to deal with it.
2020-05-27 16:26:35 +01:00
## Installation
2020-11-22 23:21:11 +00:00
For small/test setups it is recommended to use docker-compose, see the [documentation](https://passbook.beryju.org/docs/installation/docker-compose/)
2020-05-27 16:26:35 +01:00
2020-11-22 23:21:11 +00:00
For bigger setups, there is a Helm Chart in the `helm/` directory. This is documented [here](https://passbook.beryju.org/docs/installation/kubernetes/)
2020-05-27 16:26:35 +01:00
## Screenshots
![](website/static/img/screen_apps.png)
![](website/static/img/screen_admin.png)
2020-05-27 16:26:35 +01:00
## Development
See [Development Documentation](https://passbook.beryju.org/docs/development/local-dev-environment)
2020-05-27 16:26:35 +01:00
## Security
See [SECURITY.md](SECURITY.md)