Skip to content

The Single Sign-On Multi-Factor portal for web apps

License

Notifications You must be signed in to change notification settings

thehijacker/authelia

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

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:

  • Several second factor methods:
  • 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 out of the box using the ForwardAuth middleware.
  • Curated configuration from LinuxServer via their Swag container as well as a guide.
  • Compatible with Caddy using the forward_auth directive.
  • Kubernetes Support:
  • Beta support for OpenID Connect.

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.

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.

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 [email protected]. Please note the [email protected] 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

πŸ›‘οΈ

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

About

The Single Sign-On Multi-Factor portal for web apps

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 88.2%
  • TypeScript 7.7%
  • HTML 1.7%
  • Shell 1.2%
  • Lua 1.0%
  • JavaScript 0.2%