The Single Sign-On Multi-Factor portal for web apps
 
 
 
 
 
Go to file
Clément Michaud 7f19078efb
[MISC] Document usage of env variables for setting secrets. (#606)
Closes #579.
2020-02-02 00:17:39 +11:00
.buildkite [Buildkite] Do not persist Docker secret in builds (#603) 2020-02-01 19:10:18 +11:00
.github [MISC] Add github comment workflow for automated builds (#605) 2020-02-01 12:56:11 +01:00
cmd [Buildkite] Do not persist Docker secret in builds (#603) 2020-02-01 19:10:18 +11:00
docs [MISC] Document usage of env variables for setting secrets. (#606) 2020-02-02 00:17:39 +11:00
example [MISC] Remove unused mongo docker-compose file. (#599) 2020-02-01 22:19:26 +11:00
internal [FIX] Fix default redirection URL not taken into account (#600) 2020-02-01 13:54:50 +01:00
web Misc Spelling Corrections 2020-01-21 12:16:00 +11:00
.dockerignore Added environment variable parsing for: 2019-06-07 17:39:04 +02:00
.gitignore Rename org from clems4ever to authelia 2019-12-24 13:14:52 +11:00
BREAKING.md Add example for v3 -> v4 migrations utilising Docker 2020-01-22 11:53:15 +11:00
CONTRIBUTING.md [MISC] Add a CONTRIBUTING.md to the project. (#604) 2020-02-01 22:05:43 +11:00
Dockerfile Update alpine to 3.11.3 2020-01-22 11:53:15 +11:00
Dockerfile.arm32v7 Update alpine to 3.11.3 2020-01-22 11:53:15 +11:00
Dockerfile.arm64v8 Update alpine to 3.11.3 2020-01-22 11:53:15 +11:00
LICENSE Change license from MIT to Apache 2.0. 2019-04-16 23:40:15 +02:00
README.md [MISC] Add a CONTRIBUTING.md to the project. (#604) 2020-02-01 22:05:43 +11:00
authelia.service Update README.md with AUR references and remove CHANGELOG.md (#576) 2020-01-24 10:21:17 +01:00
bootstrap.sh Utilise Buildkite for Authelia CI/CD (#507) 2019-12-27 22:07:53 +11:00
config.template.yml [MISC] Document usage of env variables for setting secrets. (#606) 2020-02-02 00:17:39 +11:00
docker-compose.yml Add Traefik2 suite and refactor Traefik suite (#562) 2020-01-19 11:06:37 +01:00
go.mod Introduce viper in order to read secrets from env variables. 2020-01-22 10:15:25 +11:00
go.sum Introduce viper in order to read secrets from env variables. 2020-01-22 10:15:25 +11:00

README.md

Build Docker Tag Docker Size GitHub Release AUR source version AUR binary version AUR development version License Sponsor Matrix

Authelia is an open-source authentication and authorization server providing 2-factor authentication and single sign-on (SSO) for your applications via a web portal. It acts as a companion of reverse proxies like nginx, Traefik or HAProxy to let them know whether queries should pass through. Unauthenticated user are redirected to Authelia Sign-in portal instead.

The architecture is shown in the diagram below.

BREAKING NEWS: Authelia v4 has been released! Please read BREAKING.md if you want to migrate from v3 to v4. Otherwise, start fresh in v4 and enjoy!

Authelia can be installed as a standalone service from the AUR, using a Static binary, Docker or can also be deployed easily on Kubernetes leveraging ingress controllers and ingress configuration.

Here is what Authelia's portal looks like

Features summary

Here is the list of the main available features:

  • Several kind of second factor:
  • Password reset with identity verification using email confirmation.
  • Single-factor only authentication method available.
  • Access restriction after too many authentication attempts.
  • Fine-grained access control per subdomain, user, resource and network.
  • Support of basic authentication for endpoints protected by single factor.
  • Highly available using a remote database and Redis as a highly available KV store.
  • Compatible with Kubernetes ingress-nginx controller out of the box.

For more details about the features, follow Features.

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.

Getting Started

You can start off with

git clone https://github.com/authelia/authelia.git && cd authelia
source bootstrap.sh

If you want to go further, please read Getting Started.

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

Security measures

If you want more information about the security measures applied by Authelia and some tips on how to set up Authelia in a secure way, refer to Security.

Vulnerability report

Security is taken very seriously here, therefore we follow the rule of responsible disclosure and we encourage you to do so.

Would you like to report any vulnerability discovered in Authelia, please first contact clems4ever on Matrix or by email.

Breaking changes

See BREAKING.

Build Authelia

If you want to contribute with code, you should follow the documentation explaining how to build the application.

Sponsorship

Become a backer to support Authelia.

License

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