203 lines
13 KiB
Markdown
203 lines
13 KiB
Markdown
<p align="center">
|
|
<img src="./docs/images/authelia-title.png" width="350" title="Authelia">
|
|
</p>
|
|
|
|
[](https://buildkite.com/authelia/authelia)
|
|
[](https://goreportcard.com/report/github.com/authelia/authelia)
|
|
[](https://microbadger.com/images/authelia/authelia)
|
|
[](https://hub.docker.com/r/authelia/authelia/tags)
|
|
[](https://github.com/authelia/authelia/releases)
|
|
[](https://aur.archlinux.org/packages/authelia/)
|
|
[](https://aur.archlinux.org/packages/authelia-bin/)
|
|
[](https://aur.archlinux.org/packages/authelia-git/)
|
|
[][Apache 2.0]
|
|
[](https://opencollective.com/authelia-sponsors)
|
|
[](https://discord.authelia.com)
|
|
[](https://riot.im/app/#/room/#authelia:matrix.org)
|
|
|
|
**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 users are
|
|
redirected to Authelia Sign-in portal instead.
|
|
|
|
Documentation is available at https://docs.authelia.com.
|
|
|
|
The architecture is shown in the diagram below.
|
|
|
|
<p align="center" style="margin:50px">
|
|
<img src="./docs/images/archi.png"/>
|
|
</p>
|
|
|
|
**Authelia** can be installed as a standalone service from the [AUR](https://aur.archlinux.org/packages/authelia/), [FreeBSD Ports](https://svnweb.freebsd.org/ports/head/www/authelia/), or using a [Static binary](https://github.com/authelia/authelia/releases/latest),
|
|
[Docker] or [Kubernetes] leveraging ingress controllers and ingress configurations. Assistance to publish a [debian package](https://github.com/authelia/authelia/issues/573) would be greatly appreciated.
|
|
|
|
<p align="center">
|
|
<img src="./docs/images/logos/kubernetes.logo.png" height="100"/>
|
|
<img src="./docs/images/logos/docker.logo.png" width="100">
|
|
</p>
|
|
|
|
Here is what Authelia's portal looks like
|
|
|
|
<p align="center">
|
|
<img src="./docs/images/1FA.png" width="400" />
|
|
<img src="./docs/images/2FA-METHODS.png" width="400" />
|
|
</p>
|
|
|
|
## Features summary
|
|
|
|
Here is the list of the main available features:
|
|
|
|
* Several kind of second factor:
|
|
* **[Security Key (U2F)](https://docs.authelia.com/features/2fa/security-key)** with [Yubikey].
|
|
* **[Time-based One-Time password](https://docs.authelia.com/features/2fa/one-time-password)** with [Google Authenticator].
|
|
* **[Mobile Push Notifications](https://docs.authelia.com/features/2fa/push-notifications)** with [Duo](https://duo.com/).
|
|
* 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](https://github.com/kubernetes/ingress-nginx) controller out of the box.
|
|
|
|
For more details about the features, follow [Features](https://docs.authelia.com/features/).
|
|
|
|
If you want to know more about the roadmap, follow [Roadmap](https://docs.authelia.com/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].
|
|
|
|
<p align="center">
|
|
<img src="./docs/images/logos/nginx.logo.png" height="50"/>
|
|
<img src="./docs/images/logos/traefik.logo.png" height="50"/>
|
|
<img src="./docs/images/logos/haproxy.logo.png" height="50"/>
|
|
<img src="./docs/images/logos/kubernetes.logo.png" height="50"/>
|
|
</p>
|
|
|
|
## Getting Started
|
|
|
|
You can start utilising Authelia with the provided `docker-compose` bundles:
|
|
|
|
#### [Local](https://docs.authelia.com/getting-started)
|
|
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](https://docs.authelia.com/deployment/deployment-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](https://docs.authelia.com/deployment/deployment-ha)
|
|
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](https://docs.authelia.com/deployment/deployment-ha).
|
|
This guide will show you how to deploy it on bare metal as well as on
|
|
[Kubernetes](https://kubernetes.io/).
|
|
|
|
## Security
|
|
|
|
Authelia takes security very seriously. We follow the rule of
|
|
[responsible disclosure](https://en.wikipedia.org/wiki/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](#matrix) or [email](#email) as described in the [contact options](#contact-options) below.
|
|
|
|
For details about security measures implemented in Authelia, please follow
|
|
this [link](https://docs.authelia.com/security/measures.html) and for reading about
|
|
the threat model follow this [link](https://docs.authelia.com/security/threat-model.html).
|
|
|
|
### Contact Options
|
|
|
|
#### Matrix
|
|
|
|
Join the [Matrix Room](https://riot.im/app/#/room/#authelia:matrix.org) 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.
|
|
|
|
#### Discord
|
|
|
|
Join the [Discord Server](https://discord.authelia.com) and message the
|
|
[#support](https://discord.com/channels/707844280412012608/707844280412012612) chat which links to [Matrix](#matrix)
|
|
and contact a maintainer.
|
|
|
|
#### Email
|
|
|
|
You can contact any of the maintainers for security vulnerability related issues by emailing
|
|
[security@authelia.com](mailto: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](#matrix) or
|
|
[team@authelia.com](mailto:team@authelia.com).
|
|
|
|
## Breaking changes
|
|
|
|
See [BREAKING](./BREAKING.md).
|
|
|
|
## 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 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, check the documentation available
|
|
[here](https://docs.authelia.com/contributing/).
|
|
|
|
Authelia exists thanks to all the people who contribute so don't be shy,
|
|
come chat with us on [Matrix](#matrix) and start contributing too. [[Contribute](./CONTRIBUTING.md)].
|
|
<a href="https://github.com/authelia/authelia/graphs/contributors"><img src="https://opencollective.com/authelia-sponsors/contributors.svg?width=890" /></a>
|
|
|
|
## Backers
|
|
|
|
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/authelia-sponsors/contribute)] 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.
|
|
<a href="https://opencollective.com/authelia-sponsors#backers"><img src="https://opencollective.com/authelia-sponsors/backers.svg?width=890"></a>
|
|
|
|
## Sponsors
|
|
|
|
Support Authelia by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/authelia-sponsors#sponsor)]
|
|
|
|
<a href="https://opencollective.com/authelia-sponsors/sponsor/0/website"><img src="https://opencollective.com/authelia-sponsors/sponsor/0/avatar.svg"></a>
|
|
<a href="https://opencollective.com/authelia-sponsors/sponsor/1/website"><img src="https://opencollective.com/authelia-sponsors/sponsor/1/avatar.svg"></a>
|
|
<a href="https://opencollective.com/authelia-sponsors/sponsor/2/website"><img src="https://opencollective.com/authelia-sponsors/sponsor/2/avatar.svg"></a>
|
|
<a href="https://opencollective.com/authelia-sponsors/sponsor/3/website"><img src="https://opencollective.com/authelia-sponsors/sponsor/3/avatar.svg"></a>
|
|
<a href="https://opencollective.com/authelia-sponsors/sponsor/4/website"><img src="https://opencollective.com/authelia-sponsors/sponsor/4/avatar.svg"></a>
|
|
<a href="https://opencollective.com/authelia-sponsors/sponsor/5/website"><img src="https://opencollective.com/authelia-sponsors/sponsor/5/avatar.svg"></a>
|
|
<a href="https://opencollective.com/authelia-sponsors/sponsor/6/website"><img src="https://opencollective.com/authelia-sponsors/sponsor/6/avatar.svg"></a>
|
|
<a href="https://opencollective.com/authelia-sponsors/sponsor/7/website"><img src="https://opencollective.com/authelia-sponsors/sponsor/7/avatar.svg"></a>
|
|
<a href="https://opencollective.com/authelia-sponsors/sponsor/8/website"><img src="https://opencollective.com/authelia-sponsors/sponsor/8/avatar.svg"></a>
|
|
<a href="https://opencollective.com/authelia-sponsors/sponsor/9/website"><img src="https://opencollective.com/authelia-sponsors/sponsor/9/avatar.svg"></a>
|
|
|
|
## License
|
|
|
|
**Authelia** is **licensed** under the **[Apache 2.0]** license. The terms of the license are detailed
|
|
in [LICENSE](./LICENSE).
|
|
|
|
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fauthelia%2Fauthelia?ref=badge_large)
|
|
|
|
|
|
[Apache 2.0]: https://www.apache.org/licenses/LICENSE-2.0
|
|
[TOTP]: https://en.wikipedia.org/wiki/Time-based_One-time_Password_Algorithm
|
|
[Security Key]: https://www.yubico.com/about/background/fido/
|
|
[Yubikey]: https://www.yubico.com/products/yubikey-hardware/yubikey4/
|
|
[auth_request]: https://nginx.org/en/docs/http/ngx_http_auth_request_module.html
|
|
[Google Authenticator]: https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2&hl=en
|
|
[config.template.yml]: ./config.template.yml
|
|
[nginx]: https://www.nginx.com/
|
|
[Traefik]: https://traefik.io/
|
|
[HAProxy]: https://www.haproxy.org/
|
|
[Docker]: https://docker.com/
|
|
[Kubernetes]: https://kubernetes.io/
|