[](https://buildkite.com/authelia/authelia) [](https://goreportcard.com/report/github.com/authelia/authelia) [](https://microbadger.com/images/authelia/authelia) [](https://hub.docker.com/r/authelia/authelia/tags) [](https://github.com/authelia/authelia/releases) [](https://aur.archlinux.org/packages/authelia/) [](https://aur.archlinux.org/packages/authelia-bin/) [](https://aur.archlinux.org/packages/authelia-git/) [][Apache 2.0] [](https://opencollective.com/authelia-sponsors) [](https://discord.authelia.com) [](https://riot.im/app/#/room/#authelia:matrix.org) **Authelia** is an open-source authentication and authorization server providing two-factor authentication and single sign-on (SSO) for your applications via a web portal. It acts as a companion for reverse proxies like [nginx], [Traefik] or [HAProxy] to let them know whether requests should either be allowed or redirected to Authelia's portal for authentication. Documentation is available at https://www.authelia.com/docs. The following is a simple diagram of the architecture:

**Authelia** can be installed as a standalone service from the [AUR](https://aur.archlinux.org/packages/authelia/), [APT](https://apt.authelia.com/stable/debian/packages/authelia/), [FreeBSD Ports](https://svnweb.freebsd.org/ports/head/www/authelia/), or using a [Static binary](https://github.com/authelia/authelia/releases/latest), [.deb package]((https://github.com/authelia/authelia/releases/latest)), [Docker] or [Kubernetes] either manually or via the Helm [Chart](https://charts.authelia.com) (beta) leveraging ingress controllers and ingress configurations.

Here is what Authelia's portal looks like:

## Features summary This is a list of the key features of Authelia: * Several second factor methods: * **[Security Key (U2F)](https://www.authelia.com/docs/features/2fa/security-key)** with [Yubikey]. * **[Time-based One-Time password](https://www.authelia.com/docs/features/2fa/one-time-password)** with [Google Authenticator]. * **[Mobile Push Notifications](https://www.authelia.com/docs/features/2fa/push-notifications)** with [Duo](https://duo.com/). * Password reset with identity verification using email confirmation. * Access restriction after too many invalid authentication attempts. * Fine-grained access control using rules which match criteria like subdomain, user, user group membership, request uri, request method, and network. * Choice between one-factor and two-factor policies per-rule. * Support of basic authentication for endpoints protected by the one-factor policy. * Highly available using a remote database and Redis as a highly available KV store. * Compatible with [Traefik](https://doc.traefik.io/traefik) out of the box using the [ForwardAuth](https://doc.traefik.io/traefik/middlewares/forwardauth/) middleware. * Curated configuration from [LinuxServer](https://www.linuxserver.io/) via their [Swag](https://docs.linuxserver.io/general/swag) container as well as a [guide](https://blog.linuxserver.io/2020/08/26/setting-up-authelia/). * Kubernetes Support: * Compatible with the [ingress-nginx](https://github.com/kubernetes/ingress-nginx), the [Traefik Kubernetes CRD](https://doc.traefik.io/traefik/providers/kubernetes-crd/), and the [Traefik Kubernetes Ingress](https://doc.traefik.io/traefik/providers/kubernetes-crd/) Kubernetes ingress controllers out of the box. * Beta support for installing via Helm using our [Charts](https://charts.authelia.com). * Beta support for [OpenID Connect](https://www.authelia.com/docs/configuration/identity-providers/oidc.html). For more details about the features, follow [Features](https://www.authelia.com/docs/features/). If you want to know more about the roadmap, follow [Roadmap](https://www.authelia.com/docs/roadmap). ## Proxy support Authelia works in combination with [nginx], [Traefik] or [HAProxy]. It can be deployed on bare metal with Docker or on top of [Kubernetes].

***Help Wanted:*** Assistance would be appreciated in getting Authelia working with [Caddy](https://caddyserver.com/) and [Envoy](https://www.envoyproxy.io/).

## Getting Started ### docker-compose The `docker-compose` bundles act as a starting point for anyone wanting to see Authelia in action. You will have to customize them to your needs as they come with self-signed certificates. #### [Local](https://www.authelia.com/docs/getting-started) The Local compose bundle is intended to test Authelia without worrying about configuration. It's meant to be used for scenarios where the server is not be exposed to the internet. Domains will be defined in the local hosts file and self-signed certificates will be utilised. #### [Lite](https://www.authelia.com/docs/deployment/deployment-lite) The Lite compose bundle is intended for scenarios where the server will be exposed to the internet, domains and DNS will need to be setup accordingly and certificates will be generated through LetsEncrypt. The Lite element refers to minimal external dependencies; File based user storage, SQLite based configuration storage. In this configuration, the service will not scale well. #### [Full](https://www.authelia.com/docs/deployment/deployment-ha) The Full compose bundle is intended for scenarios where the server will be exposed to the internet, domains and DNS will need to be setup accordingly and certificates will be generated through LetsEncrypt. The Full element refers to a scalable setup which includes external dependencies; LDAP based user storage, Database based configuration storage (MariaDB, MySQL or Postgres). ## Deployment Now that you have tested **Authelia** and you want to try it out in your own infrastructure, you can learn how to deploy and use it with [Deployment](https://www.authelia.com/docs/deployment/deployment-ha). This guide will show you how to deploy it on bare metal as well as on [Kubernetes](https://kubernetes.io/). ## Security Authelia takes security very seriously. If you discover a vulnerability in Authelia, please see our [Security Policy](https://github.com/authelia/authelia/security/policy). For more information about [security](https://www.authelia.com/docs/security/) related matters, please read [the documentation](https://www.authelia.com/docs/security/). ## Contact Options Several contact options exist for our community, the primary one being [Matrix](#matrix). ### Matrix You can join the [Matrix Space](https://app.element.io/#/room/!qcxpPdXBiGBSTbFAJE:matrix.org?via=matrix.org) which includes both the [Support Room](https://riot.im/app/#/room/#authelia:matrix.org) and the [Contributing Room](https://riot.im/app/#/room/#authelia-contributing:matrix.org). The core team members are identified as administrators in the Rooms and Space. ### Discord You can join the [Discord Server](https://discord.authelia.com) where the [#support](https://discord.com/channels/707844280412012608/707844280412012612) and [#contributing](https://discord.com/channels/707844280412012608/804943261265297408) channels link to [Matrix](#matrix). ### Email You can contact the core team by email via [team@authelia.com](mailto:team@authelia.com). Please note the [security@authelia.com](mailto:security@authelia.com) is also available but is strictly reserved for security related matters. ## Breaking changes Since Authelia is still under active development, it is subject to breaking changes. It's recommended to pin a version tag instead of using the `latest` tag and reading the [release notes](https://github.com/authelia/authelia/releases) before upgrading. This is where you will find information about breaking changes and what you should do to overcome said changes. ## Why Open Source? You might wonder why Authelia is open source while it adds a great deal of security and user experience to your infrastructure at zero cost. It is open source because we firmly believe that security should be available for all to benefit in the face of the battlefield which is the Internet, with near zero effort. Additionally, keeping the code open source is a way to leave it auditable by anyone who is willing to contribute. This way, you can be confident that the product remains secure and does not act maliciously. It's important to keep in mind Authelia is not directly exposed on the Internet (your reverse proxies are) however, it's still the control plane for your internal security so take care of it! ## Contribute If you want to contribute to Authelia, please read our [contribution guidelines](./CONTRIBUTING.md). Authelia exists thanks to all the people who contribute so don't be shy, come chat with us on either [Matrix](#matrix) or [Discord](#discord) and start contributing too. Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

Clément Michaud 💻 📖 🤔 🚧 💬 👀 ⚠️	Amir Zarrinkafsh 💻 📖 🤔 🚧 💬 👀 ⚠️	James Elliott 💻 📖 🤔 🚧 💬 👀 ⚠️	Antoine Favre 🐛 🤔	BankaiNoJutsu 💻 🎨	Philipp Rintz 📖	Callan Bryant 💻 📖
Ian 💻	FrozenDragoon 💻	vdot0x23 💻	alexw1982 📖	Sohalt 💻 📖	Stoica Tedy 💻	Dylan Smith 💻
Lukas Klass 📖	Philipp Staiger 💻 📖 ⚠️	James Hodgkinson 📖	Chris Smith 📖	Mihály 📖	Silver Bullet 📖	Paul Williams 💻 ⚠️
Timo 📖	Andrew Kliskey 📖	Kristof Mattei 📖	ZMiguel Valdiviesso 📖	akusei 💻 📖	Daniel Miller 📖	Dustin Sweigart 💻 📖 ⚠️
Shawn Haggard 💻 ⚠️	Kevyn Bruyere 📖	Daniel Sutton 💻	Valentin Höbel 💻	thehedgefrog 📖	Victor 📖	Chris Whisker 📖
nasatome 📖	Begley Brothers (Development) 📖	Mike Kusold 💻	Dimitris Zervas 📖	TheCatLady 🤔	Lauri Võsandi 🤔	Kennard Vermeiren 🤔
ThinkChaos 💻 📖 ⚠️	Hasan 🛡️	David Chidell 📖	Marcel Marquardt 🐛	Ian Gallagher 📖	Wu Han 📖	lavih 📖
Jon B. 🛡️	Alex Gustafsson 💻 📖	Arsenović Arsen 💻 ⚠️ 🛡️	dakriy 💻	Dave 📓

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! ### Backers Thank you to all our backers! 🙏 [Become a backer](https://opencollective.com/authelia-sponsors/contribute) and help us sustain our community. The money we currently receive is dedicated to bootstrap a bug bounty program to give us as many eyes as we can to detect potential vulnerabilities. ### Sponsors Any company can become a sponsor by donating or providing any benefit to the project or the team helping improve Authelia. ***Help Wanted:*** We are actively looking for sponsorship to obtain either a code security audit, penetration testing, or other audits related to improving the security of Authelia. Companies contributing to Authelia will have a specical mention below. [[Become a sponsor](https://opencollective.com/authelia-sponsors#sponsor)] #### Balto Thank you to [ Balto](https://www.getbalto.com/) for hosting our apt repository. #### Digital Ocean Thank you to [ DigitalOcean](https://www.digitalocean.com/?from=Authelia) for contributing on OpenCollective. #### JetBrains Thank you to [ JetBrains](https://www.jetbrains.com/?from=Authelia) for providing us with free licenses to their great tools. * [ IDEA](http://www.jetbrains.com/idea/) * [ GoLand](http://www.jetbrains.com/go/) * [ WebStorm](http://www.jetbrains.com/webstorm/) ## License **Authelia** is **licensed** under the **[Apache 2.0]** license. The terms of the license are detailed in [LICENSE](./LICENSE). [](https://app.fossa.com/projects/git%2Bgithub.com%2Fauthelia%2Fauthelia?ref=badge_large) [Apache 2.0]: https://www.apache.org/licenses/LICENSE-2.0 [TOTP]: https://en.wikipedia.org/wiki/Time-based_One-time_Password_Algorithm [Security Key]: https://www.yubico.com/about/background/fido/ [Yubikey]: https://www.yubico.com/products/yubikey-hardware/yubikey4/ [auth_request]: https://nginx.org/en/docs/http/ngx_http_auth_request_module.html [Google Authenticator]: https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2&hl=en [config.template.yml]: ./config.template.yml [nginx]: https://www.nginx.com/ [Traefik]: https://traefik.io/ [HAProxy]: https://www.haproxy.org/ [Docker]: https://docker.com/ [Kubernetes]: https://kubernetes.io/