The Single Sign-On Multi-Factor portal for web apps
 
 
 
 
 
Go to file
Clément Michaud bb24cf16f7
Update README.md
2020-01-18 00:41:29 +01:00
.buildkite Add back wait block in buildkite pipeline. 2020-01-18 00:12:36 +01:00
cmd Build docker image upfront in CI and use it in integration tests. (#555) 2020-01-17 20:46:51 +01:00
docs Update Authelia logo in README and the icon of the webapp. (#556) 2020-01-17 21:30:50 +01:00
example Build docker image upfront in CI and use it in integration tests. (#555) 2020-01-17 20:46:51 +01:00
internal Fixes Remember Me functionality 2020-01-18 00:27:01 +01:00
web Update Authelia logo in README and the icon of the webapp. (#556) 2020-01-17 21:30:50 +01: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 Update references to remove hash router 2020-01-10 11:33:18 +01:00
CHANGELOG.md Prepare changelog for v4.1.0 release. 2020-01-12 20:17:11 +01:00
Dockerfile Build docker image upfront in CI and use it in integration tests. (#555) 2020-01-17 20:46:51 +01:00
Dockerfile.arm32v7 Build docker image upfront in CI and use it in integration tests. (#555) 2020-01-17 20:46:51 +01:00
Dockerfile.arm64v8 Build docker image upfront in CI and use it in integration tests. (#555) 2020-01-17 20:46:51 +01:00
LICENSE Change license from MIT to Apache 2.0. 2019-04-16 23:40:15 +02:00
README.md Update README.md 2020-01-18 00:41:29 +01:00
bootstrap.sh Utilise Buildkite for Authelia CI/CD (#507) 2019-12-27 22:07:53 +11:00
config.template.yml Force TLS and valid x509 certs in SMTP Notifier by default 2020-01-10 17:37:16 +01:00
docker-compose.yml Declare suites as Go structs and bootstrap e2e test framework in Go. 2019-11-15 20:23:06 +01:00
go.mod Rename org from clems4ever to authelia 2019-12-24 13:14:52 +11:00
go.sum Add support for LDAP over TLS. 2019-12-06 21:33:47 +01:00

README.md

Docker Tag Docker Size GitHub Release License Build Gitter

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 or Traefik 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 using Docker or NPM but 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 directly in 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

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.

Changelog & Breaking changes

See CHANGELOG.md and BREAKING.md.

Contribute

Anybody willing to contribute to the project either with code, documentation, security reviews or whatever, are very welcome to issue or review pull requests and take part to discussions in Gitter.

I am very grateful to contributors for their contributions to the project. Don't hesitate, be the next!

Build Authelia

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

License

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