authentik/README.md

39 lines
2.0 KiB
Markdown
Raw Normal View History

2021-03-02 16:00:36 +00:00
<p align="center">
<img src="https://goauthentik.io/img/icon_top_brand_colour.svg" height="150" alt="authentik logo">
</p>
2020-12-05 21:08:42 +00:00
---
2021-02-22 16:27:16 +00:00
[![](https://img.shields.io/discord/809154715984199690?label=Discord&style=flat-square)](https://discord.gg/KPnmtNWy)
2020-12-05 21:08:42 +00:00
[![CI Build status](https://img.shields.io/azure-devops/build/beryjuorg/authentik/1?style=flat-square)](https://dev.azure.com/beryjuorg/authentik/_build?definitionId=1)
[![Tests](https://img.shields.io/azure-devops/tests/beryjuorg/authentik/1?compact_message&style=flat-square)](https://dev.azure.com/beryjuorg/authentik/_build?definitionId=1)
[![Code Coverage](https://img.shields.io/codecov/c/gh/beryju/authentik?style=flat-square)](https://codecov.io/gh/BeryJu/authentik)
![Docker pulls](https://img.shields.io/docker/pulls/beryju/authentik.svg?style=flat-square)
![Latest version](https://img.shields.io/docker/v/beryju/authentik?sort=semver&style=flat-square)
![LGTM Grade](https://img.shields.io/lgtm/grade/python/github/BeryJu/authentik?style=flat-square)
2020-05-27 16:26:35 +01:00
2020-12-05 21:08:42 +00:00
## What is authentik?
authentik is an open-source Identity Provider focused on flexibility and versatility. You can use authentik in an existing environment to add support for new protocols. authentik 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-12-05 21:08:42 +00:00
For small/test setups it is recommended to use docker-compose, see the [documentation](https://goauthentik.io/docs/installation/docker-compose/)
2020-05-27 16:26:35 +01:00
2020-12-05 21:08:42 +00:00
For bigger setups, there is a Helm Chart in the `helm/` directory. This is documented [here](https://goauthentik.io/docs/installation/kubernetes/)
2020-05-27 16:26:35 +01:00
## Screenshots
2021-03-02 10:56:46 +00:00
Light | Dark
--- | ---
![](https://goauthentik.io/img/screen_apps_light.png) | ![](https://goauthentik.io/img/screen_apps_dark.png)
![](https://goauthentik.io/img/screen_admin_light.png) | ![](https://goauthentik.io/img/screen_admin_dark.png)
2020-05-27 16:26:35 +01:00
## Development
2020-12-05 21:08:42 +00:00
See [Development Documentation](https://goauthentik.io/docs/development/local-dev-environment)
2020-05-27 16:26:35 +01:00
## Security
See [SECURITY.md](SECURITY.md)