authelia/README.md

60 KiB

Build OpenSSF Best Practices Go Report Card GitHub Release Docker Tag Docker Size Docker Pulls AUR source version AUR binary version AUR development version License Sponsor Discord Matrix

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 by allowing, denying, or redirecting requests.

Documentation is available at https://www.authelia.com/.

The following is a simple diagram of the architecture:

Authelia can be installed as a standalone service from the AUR, APT, FreeBSD Ports, or using a static binary, .deb package, as a container on Docker or Kubernetes.

Deployment can be orchestrated via the Helm Chart (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:

For more details take a look at the Overview.

If you want to know more about the roadmap, follow Roadmap.

Proxy support

Authelia works in combination with nginx, Traefik, Caddy, Skipper, Envoy, or HAProxy.

Getting Started

See the Get Started Guide or one of the curated examples below.

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

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

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.

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. This guide will show you how to deploy it on bare metal as well as on Kubernetes.

Security

Authelia takes security very seriously. If you discover a vulnerability in Authelia, please see our Security Policy.

For more information about security related matters, please read the documentation.

Contact Options

Several contact options exist for our community, the primary one being Matrix. These are in addition to GitHub issues for creating a new issue.

Matrix

Community members are invited to join the Matrix Space which includes both the Support Room and the Contributing Room.

  • The core team members are identified as administrators in the Space and individual Rooms.
  • All channels are linked to Discord.

Discord

Community members are invited to join the Discord Server.

Email

You can contact the core team by email via team@authelia.com. Please note the 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 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.

Authelia exists thanks to all the people who contribute so don't be shy, come chat with us on either Matrix or Discord and start contributing too.

Thanks goes to these wonderful people (emoji key):

Clément Michaud
Clément Michaud

💻 📖 🤔 🚧 💬 👀 ⚠️ 🧑‍🏫 🚇 🎨 📓 🔧 🔬
Amir Zarrinkafsh
Amir Zarrinkafsh

💻 📖 🤔 🚧 💬 👀 ⚠️ 🧑‍🏫 🚇 🎨 📓 🔧 🔬
James Elliott
James Elliott

💻 📖 🤔 🚧 💬 👀 ⚠️ 🧑‍🏫 🚇 🎨 📓 🔧 🔬
Antoine Favre
Antoine Favre

🐛 🤔
BankaiNoJutsu
BankaiNoJutsu

💻 🎨
Philipp Rintz
Philipp Rintz

📖
Callan Bryant
Callan Bryant

💻 📖
Ian
Ian

💻
FrozenDragoon
FrozenDragoon

💻
vdot0x23
vdot0x23

💻
alexw1982
alexw1982

📖
Sohalt
Sohalt

💻 📖
Stoica Tedy
Stoica Tedy

💻
Dylan Smith
Dylan Smith

💻
Lukas Klass
Lukas Klass

📖
Philipp Staiger
Philipp Staiger

💻 📖 ⚠️
James Hodgkinson
James Hodgkinson

📖
Chris Smith
Chris Smith

📖
Mihály
Mihály

📖
Silver Bullet
Silver Bullet

📖
Paul Williams
Paul Williams

💻 ⚠️
Timo
Timo

📖
Andrew Kliskey
Andrew Kliskey

📖
Kristof Mattei
Kristof Mattei

📖
ZMiguel Valdiviesso
ZMiguel Valdiviesso

📖
akusei
akusei

💻 📖
Daniel Miller
Daniel Miller

📖
Dustin Sweigart
Dustin Sweigart

💻 📖 ⚠️
Shawn Haggard
Shawn Haggard

💻 ⚠️
Kevyn Bruyere
Kevyn Bruyere

📖
Daniel Sutton
Daniel Sutton

💻
Valentin Höbel
Valentin Höbel

💻
thehedgefrog
thehedgefrog

📖
Victor
Victor

📖
Chris Whisker
Chris Whisker

📖
nasatome
nasatome

📖
Begley Brothers (Development)
Begley Brothers (Development)

📖
Mike Kusold
Mike Kusold

💻
Dimitris Zervas
Dimitris Zervas

📖
TheCatLady
TheCatLady

🤔
Lauri Võsandi
Lauri Võsandi

🤔
Kennard Vermeiren
Kennard Vermeiren

🤔
ThinkChaos
ThinkChaos

💻 📖 ⚠️
Hasan
Hasan

🛡️
David Chidell
David Chidell

📖
Marcel Marquardt
Marcel Marquardt

🐛
Ian Gallagher
Ian Gallagher

📖
Wu Han
Wu Han

📖
lavih
lavih

📖
Jon B.
Jon B.

🛡️
Alex Gustafsson
Alex Gustafsson

💻 📖
Arsenović Arsen
Arsenović Arsen

💻 ⚠️ 🛡️
dakriy
dakriy

💻
Dave
Dave

📓
Nicolas Reymundo
Nicolas Reymundo

📖
polandy
polandy

📖
yossbg
yossbg

💻 🎨
Michael Campbell
Michael Campbell

📖
Justin Sievenpiper
Justin Sievenpiper

💻
Aram Akhavan
Aram Akhavan

📖
Shadow
Shadow

📖
Patrick Ruckstuhl
Patrick Ruckstuhl

📖
Andrew Moore
Andrew Moore

💻 📖 ⚠️
Dennis Gaida
Dennis Gaida

📖
Alestrix
Alestrix

📖
bgh-github
bgh-github

📖
Manuel Nuñez
Manuel Nuñez

💻 🌍 📖 🐛 🎨 ⚠️ 👀 🔬 🤔
protvis74
protvis74

🌍
Jamie (Bear) Murphy
Jamie (Bear) Murphy

👀
Robin van Boven
Robin van Boven

🛡️
alphabet5
alphabet5

🤔
Robert Meredith
Robert Meredith

🤔
Adrian Gąsior
Adrian Gąsior

🛡️
James White
James White

💬
Zhao Xiang Lim
Zhao Xiang Lim

📖
Auzborn123
Auzborn123

🌍
SvanGlan
SvanGlan

🌍
HannesJo0139
HannesJo0139

📖
andreas-berg
andreas-berg

🐛
Clément Radenac
Clément Radenac

📖
boomam
boomam

📖
Northguy
Northguy

📖
Brennan Kinney
Brennan Kinney

📖
Michał Mieszczak
Michał Mieszczak

🤔 💻
Paul Ohl
Paul Ohl

📖
Stephen Kent
Stephen Kent

🤔 💻 🎨
Ohelig
Ohelig

📖
Dinh Bao Dang
Dinh Bao Dang

📖
levkoburburas
levkoburburas

💻 🤔 🐛
tiuub
tiuub

📖
Josh Gordon
Josh Gordon

🤔 🛡️
silasfrancisco
silasfrancisco

🛡️
Ricardo Pesqueira
Ricardo Pesqueira

🛡️
Harold
Harold

📖
Brynn Crowley
Brynn Crowley

📖 🎨
Budiman Jojo
Budiman Jojo

📖
Hendrik Sievers
Hendrik Sievers

📖 🎨 🤔
Marcus Georgi
Marcus Georgi

📖
samos667
samos667

📖

This project follows the all-contributors specification. Contributions of any kind welcome!

Sponsors

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.

Any company can become a sponsor by donating or providing any benefit to the project or the team helping improve Authelia.

Balto

Thank you to Balto Balto for hosting our apt repository.

JetBrains

Thank you to JetBrains JetBrains for providing us with free licenses to their great tools.

Microsoft

Our pipeline agents which we rely on for productivity are hosted on Azure and our git repositories are hosted on GitHub which are both Microsoft products.

microsoft

Azure

Open Collective

Backers

Thank you to all our backers! 🙏 Become a backer 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.

Sponsorship

Companies contributing to Authelia via Open Collective will have a special mention below. Become a sponsor.

License

Authelia is licensed under the Apache 2.0 license. The terms of the license are detailed in LICENSE.

FOSSA Status