The Single Sign-On Multi-Factor portal for web apps
 
 
 
 
 
Go to file
Clement Michaud 5b836fc4cf Cleanup documentation.
Remove mention of Mongo and basic suites. Also adapt some part
to changes made to authelia-scripts.
2019-11-16 23:39:26 +01:00
authentication Use pure implementation of crypt to generate and check password hashes. 2019-11-01 23:06:31 +01:00
authorization Bootstrap Go implementation of Authelia. 2019-10-28 23:28:59 +01:00
client Declare suites as Go structs and bootstrap e2e test framework in Go. 2019-11-15 20:23:06 +01:00
cmd Deprecate mongo and add mariadb as storage backend option. 2019-11-16 23:39:26 +01:00
configuration Deprecate mongo and add mariadb as storage backend option. 2019-11-16 23:39:26 +01:00
docs Cleanup documentation. 2019-11-16 23:39:26 +01:00
duo Bootstrap Go implementation of Authelia. 2019-10-28 23:28:59 +01:00
example Cleanup documentation. 2019-11-16 23:39:26 +01:00
handlers Bootstrap Go implementation of Authelia. 2019-10-28 23:28:59 +01:00
images Update README to mention nginx and Traefik and update images. 2019-04-17 23:06:56 +02:00
logging Bootstrap Go implementation of Authelia. 2019-10-28 23:28:59 +01:00
middlewares Bootstrap Go implementation of Authelia. 2019-10-28 23:28:59 +01:00
mocks Bootstrap Go implementation of Authelia. 2019-10-28 23:28:59 +01:00
models Bootstrap Go implementation of Authelia. 2019-10-28 23:28:59 +01:00
notification Declare suites as Go structs and bootstrap e2e test framework in Go. 2019-11-15 20:23:06 +01:00
regulation Declare suites as Go structs and bootstrap e2e test framework in Go. 2019-11-15 20:23:06 +01:00
scripts Declare suites as Go structs and bootstrap e2e test framework in Go. 2019-11-15 20:23:06 +01:00
server Bootstrap Go implementation of Authelia. 2019-10-28 23:28:59 +01:00
session Bootstrap Go implementation of Authelia. 2019-10-28 23:28:59 +01:00
storage Deprecate mongo and add mariadb as storage backend option. 2019-11-16 23:39:26 +01:00
suites Deprecate mongo and add mariadb as storage backend option. 2019-11-16 23:39:26 +01:00
templates Bootstrap Go implementation of Authelia. 2019-10-28 23:28:59 +01:00
test Cleanup documentation. 2019-11-16 23:39:26 +01:00
utils Declare suites as Go structs and bootstrap e2e test framework in Go. 2019-11-15 20:23:06 +01:00
.dockerignore Added environment variable parsing for: 2019-06-07 17:39:04 +02:00
.gitignore Declare suites as Go structs and bootstrap e2e test framework in Go. 2019-11-15 20:23:06 +01:00
.travis.yml Declare suites as Go structs and bootstrap e2e test framework in Go. 2019-11-15 20:23:06 +01:00
AUTHELIA-V4.md Deprecate mongo and add mariadb as storage backend option. 2019-11-16 23:39:26 +01:00
BREAKING.md Deprecate mongo and add mariadb as storage backend option. 2019-11-16 23:39:26 +01:00
CHANGELOG.md Use pure implementation of crypt to generate and check password hashes. 2019-11-01 23:06:31 +01:00
Dockerfile Enable Multiarch docker builds 2019-11-07 07:51:14 +01:00
Dockerfile.arm32v7 Enable Multiarch docker builds 2019-11-07 07:51:14 +01:00
Dockerfile.arm64v8 Enable Multiarch docker builds 2019-11-07 07:51:14 +01:00
LICENSE Change license from MIT to Apache 2.0. 2019-04-16 23:40:15 +02:00
README.md Sync README.md from GitHub to DockerHub after push-manifest 2019-11-10 11:51:24 +01:00
bootstrap.sh Declare suites as Go structs and bootstrap e2e test framework in Go. 2019-11-15 20:23:06 +01:00
config.template.yml Deprecate mongo and add mariadb as storage backend option. 2019-11-16 23:39:26 +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 Deprecate mongo and add mariadb as storage backend option. 2019-11-16 23:39:26 +01:00
go.sum Deprecate mongo and add mariadb as storage backend option. 2019-11-16 23:39:26 +01:00
package-lock.json Declare suites as Go structs and bootstrap e2e test framework in Go. 2019-11-15 20:23:06 +01:00
package.json Cleanup documentation. 2019-11-16 23:39:26 +01:00

README.md

license Build Known Vulnerabilities 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 by handling forwarded authentication and authorization requests.

BREAKING NEWS: Authelia v4 release is coming soon! The new version is written in Go for reliability, performance and security improvements.
It is currently available in beta in master.
Please read AUTHELIA-V4.md if you want to migrate from v3 to v4. But note that the data model migration is not automated yet.

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 distributed database and 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 or Traefik and soon with HAProxy as discussed in #271. 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/clems4ever/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.