mirrors
/
authentik
mirror of https://github.com/goauthentik/authentik.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
authentik/README.md

61 lines
3.2 KiB
Markdown
Raw Permalink Normal View History

root: align image on readme
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>
deploy(minor): add docker-compose file for easy testing
2019-10-04 10:50:26 +01:00
wip: rename to authentik (#361) * root: initial rename * web: rename custom element prefix * root: rename external functions with pb_ prefix * root: fix formatting * root: replace domain with goauthentik.io * proxy: update path * root: rename remaining prefixes * flows: rename file extension * root: pbadmin -> akadmin * docs: fix image filenames * lifecycle: ignore migration files * ci: copy default config from current source before loading last tagged * *: new sentry dsn * tests: fix missing python3.9-dev package * root: add additional migrations for service accounts created by outposts * core: mark system-created service accounts with attribute * policies/expression: fix pb_ replacement not working * web: fix last linting errors, add lit-analyse * policies/expressions: fix lint errors * web: fix sidebar display on screens where not all items fit * proxy: attempt to fix proxy pipeline * proxy: use go env GOPATH to get gopath * lib: fix user_default naming inconsistency * docs: add upgrade docs * docs: update screenshots to use authentik * admin: fix create button on empty-state of outpost * web: fix modal submit not refreshing SiteShell and Table * web: fix height of app-card and height of generic icon * web: fix rendering of subtext * admin: fix version check error not being caught * web: fix worker count not being shown * docs: update screenshots * root: new icon * web: fix lint error * admin: fix linting error * root: migrate coverage config to pyproject
2020-12-05 21:08:42 +00:00
---
providers/oidc: fix incorrectly sorted imports
2020-01-02 15:42:52 +00:00
root: use custom url for discord Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
2021-10-21 09:40:43 +01:00
[![Join Discord](https://img.shields.io/discord/809154715984199690?label=Discord&style=for-the-badge)](https://goauthentik.io/discord)
root: update badges Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
2021-09-03 17:11:13 +01:00
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/goauthentik/authentik/authentik-ci-main?label=core%20build&style=for-the-badge)](https://github.com/goauthentik/authentik/actions/workflows/ci-main.yml)
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/goauthentik/authentik/authentik-ci-outpost?label=outpost%20build&style=for-the-badge)](https://github.com/goauthentik/authentik/actions/workflows/ci-outpost.yml)
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/goauthentik/authentik/authentik-ci-web?label=web%20build&style=for-the-badge)](https://github.com/goauthentik/authentik/actions/workflows/ci-web.yml)
root: update readme Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
2021-08-02 11:47:24 +01:00
[![Code Coverage](https://img.shields.io/codecov/c/gh/goauthentik/authentik?style=for-the-badge)](https://codecov.io/gh/goauthentik/authentik)
root: update badges Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
2021-09-03 17:11:13 +01:00
[![Testspace tests](https://img.shields.io/testspace/total/goauthentik/goauthentik:authentik/master?style=for-the-badge)](https://goauthentik.testspace.com/)
root: update readme Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
2021-08-02 11:47:24 +01:00
![Docker pulls](https://img.shields.io/docker/pulls/beryju/authentik.svg?style=for-the-badge)
![Latest version](https://img.shields.io/docker/v/beryju/authentik?sort=semver&style=for-the-badge)
outposts/proxy: detect empty authentik_host Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
2021-09-01 21:09:07 +01:00
[![](https://img.shields.io/badge/Help%20translate-transifex-blue?style=for-the-badge)](https://www.transifex.com/beryjuorg/authentik/)
root: update readme
2020-05-27 16:26:35 +01:00
wip: rename to authentik (#361) * root: initial rename * web: rename custom element prefix * root: rename external functions with pb_ prefix * root: fix formatting * root: replace domain with goauthentik.io * proxy: update path * root: rename remaining prefixes * flows: rename file extension * root: pbadmin -> akadmin * docs: fix image filenames * lifecycle: ignore migration files * ci: copy default config from current source before loading last tagged * *: new sentry dsn * tests: fix missing python3.9-dev package * root: add additional migrations for service accounts created by outposts * core: mark system-created service accounts with attribute * policies/expression: fix pb_ replacement not working * web: fix last linting errors, add lit-analyse * policies/expressions: fix lint errors * web: fix sidebar display on screens where not all items fit * proxy: attempt to fix proxy pipeline * proxy: use go env GOPATH to get gopath * lib: fix user_default naming inconsistency * docs: add upgrade docs * docs: update screenshots to use authentik * admin: fix create button on empty-state of outpost * web: fix modal submit not refreshing SiteShell and Table * web: fix height of app-card and height of generic icon * web: fix rendering of subtext * admin: fix version check error not being caught * web: fix worker count not being shown * docs: update screenshots * root: new icon * web: fix lint error * admin: fix linting error * root: migrate coverage config to pyproject
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.
root: update readme
2020-05-27 16:26:35 +01:00
## Installation
root: add utm_source Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
2021-10-20 15:31:10 +01:00
For small/test setups it is recommended to use docker-compose, see the [documentation](https://goauthentik.io/docs/installation/docker-compose/?utm_source=github)
root: update readme
2020-05-27 16:26:35 +01:00
root: add utm_source Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
2021-10-20 15:31:10 +01:00
For bigger setups, there is a Helm Chart [here](https://github.com/goauthentik/helm). This is documented [here](https://goauthentik.io/docs/installation/kubernetes/?utm_source=github)
root: update readme
2020-05-27 16:26:35 +01:00
## Screenshots
root: update screenshots
2021-03-02 10:56:46 +00:00
Light | Dark
--- | ---
root: optimise images Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
2021-03-20 22:35:05 +00:00
![](https://goauthentik.io/img/screen_apps_light.jpg) | ![](https://goauthentik.io/img/screen_apps_dark.jpg)
![](https://goauthentik.io/img/screen_admin_light.jpg) | ![](https://goauthentik.io/img/screen_admin_dark.jpg)
root: update readme
2020-05-27 16:26:35 +01:00
## Development
root: add utm_source Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
2021-10-20 15:31:10 +01:00
See [Development Documentation](https://goauthentik.io/developer-docs/?utm_source=github)
root: update readme
2020-05-27 16:26:35 +01:00
## Security
See [SECURITY.md](SECURITY.md)
root: add sponsors to readme Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
2021-12-16 09:30:13 +00:00
## Sponsors
This project is proudly sponsored by:
<p>
<a href="https://www.digitalocean.com/?utm_medium=opensource&utm_source=goauthentik.io">
<img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" width="201px">
</a>
</p>
DigitalOcean provides development and testing resources for authentik.
<p>
<a href="https://www.netlify.com">
<img src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg" alt="Deploys by Netlify" />
</a>
</p>
rootL Fix goauthentik.io URL in Readme (#2158)
2022-01-25 19:36:44 +00:00
Netlify hosts the [goauthentik.io](https://goauthentik.io) site.