The Single Sign-On Multi-Factor portal for web apps
 
 
 
 
 
Go to file
Clement Michaud 7d4bbd7cea
Serve docs under www.authelia.com/docs.
2020-06-10 21:08:06 +02:00
.buildkite [RELEASE] v4.19.2 (#1104) 2020-06-10 09:51:51 +10:00
.dependabot [CI] Add Gemfile.lock monitoring to dependabot (#931) 2020-04-27 21:09:26 +02:00
.github [FEATURE] Notifier Startup Checks (#889) 2020-04-21 14:59:38 +10:00
cmd [MISC] Catch and warn on malformed configuration yaml (#1089) 2020-06-09 08:22:41 +10:00
compose [BUGFIX] Prevent lite bundle redis panic (#994) 2020-05-08 23:00:14 +10:00
docs Serve docs under www.authelia.com/docs. 2020-06-10 21:08:06 +02:00
internal [MISC] Catch and warn on malformed configuration yaml (#1089) 2020-06-09 08:22:41 +10:00
web [MISC] (deps): Bump @types/react from 16.9.35 to 16.9.36 in /web (#1107) 2020-06-10 20:47:33 +02:00
.codecov.yml [CI] Add Codecov support (#1065) 2020-06-05 10:43:19 +10:00
.dockerignore Added environment variable parsing for: 2019-06-07 17:39:04 +02:00
.gitignore [CI] Add Codecov support (#1065) 2020-06-05 10:43:19 +10:00
.golangci.yml [CI] Add gocritic linter (#977) 2020-05-06 10:52:06 +10:00
.reviewdog.yml [CI] Update reviewdog level to error (#922) 2020-04-26 15:38:20 +02:00
BREAKING.md [DEPRECATE] Environment Variable Secrets (#905) 2020-05-08 11:01:57 +10:00
CONTRIBUTING.md [MISC] Add a CONTRIBUTING.md to the project. (#604) 2020-02-01 22:05:43 +11:00
Dockerfile [MISC] (deps): Bump golang from 1.14.3-alpine to 1.14.4-alpine (#1086) 2020-06-04 22:02:52 +02:00
Dockerfile.arm32v7 [MISC] (deps): Bump golang from 1.14.3-alpine to 1.14.4-alpine (#1086) 2020-06-04 22:02:52 +02:00
Dockerfile.arm64v8 [MISC] (deps): Bump golang from 1.14.3-alpine to 1.14.4-alpine (#1086) 2020-06-04 22:02:52 +02:00
Dockerfile.coverage [CI] Add Codecov support (#1065) 2020-06-05 10:43:19 +10:00
LICENSE Change license from MIT to Apache 2.0. 2019-04-16 23:40:15 +02:00
README.md [MISC] Add license scan report and status (#1064) 2020-06-02 10:09:31 +10:00
SECURITY.md [FEATURE] Automatic Profile Refresh - LDAP (#912) 2020-05-04 21:39:25 +02:00
authelia.service [FEATURE] Embed static assets in Go binary (#916) 2020-04-29 00:07:20 +10:00
bootstrap.sh [FEATURE] Embed static assets in Go binary (#916) 2020-04-29 00:07:20 +10:00
config.template.yml [FEATURE] Allow Authelia to listen on a specified path (#1027) 2020-05-21 12:20:55 +10:00
go.mod [MISC] (deps): Bump github.com/fasthttp/router from 1.1.7 to 1.2.1 (#1102) 2020-06-09 23:14:15 +02:00
go.sum [MISC] (deps): Bump github.com/fasthttp/router from 1.1.7 to 1.2.1 (#1102) 2020-06-09 23:14:15 +02:00

README.md

Build Go Report Card 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.

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

The architecture is shown in the diagram below.

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.

If you want to know more about the roadmap, follow 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.

Getting Started

You can start utilising Authelia with the provided docker-compose bundles:

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.

Full

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

Security

Authelia takes security very seriously. We follow the rule of responsible disclosure, and we encourage the community to as well.

If you discover a vulnerability in Authelia, please first contact one of the maintainers privately either via Matrix or email as described in the contact options below.

For details about security measures implemented in Authelia, please follow this link and for reading about the threat model follow this link.

Contact Options

Matrix

Join the Matrix Room and locate one of the maintainers. You can identify them as they are the room administrators. Alternatively you can just ask for one of the maintainers. Once you've made contact we ask you privately message the maintainer to communicate the vulnerability.

Email

You can contact any of the maintainers for security vulnerability related issues by emailing security@authelia.com. This email is strictly reserved for security and vulnerability disclosure related matters. If you need to contact us for another reason please use Matrix or team@authelia.com.

Breaking changes

See BREAKING.

Contribute

If you want to contribute to Authelia, check the documentation available here.

Contributors

Authelia exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer] and help us sustain our community.

Sponsors

Support Authelia by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

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

FOSSA Status