139 lines
6.9 KiB
Markdown
139 lines
6.9 KiB
Markdown
<p align="center">
|
|
<img src="./docs/images/authelia-title.png" width="350" title="Authelia">
|
|
</p>
|
|
<!-- Current release: 4.8.0 -->
|
|
|
|
[](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://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 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.
|
|
|
|
<p align="center" style="margin:50px">
|
|
<img src="./docs/images/archi.png"/>
|
|
</p>
|
|
|
|
**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](https://aur.archlinux.org/packages/authelia/), using a [Static binary](https://github.com/authelia/authelia/releases/latest), [Docker]
|
|
or can also be deployed easily on [Kubernetes] leveraging ingress controllers and ingress configuration.
|
|
|
|
<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/).
|
|
|
|
## 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 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](https://docs.authelia.com/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](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
|
|
|
|
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](https://riot.im/app/#/room/#authelia:matrix.org) or by
|
|
[email](mailto:clement.michaud34@gmail.com).
|
|
|
|
For details about security measures implemented in Authelia, please follow
|
|
this [link](https://docs.authelia.com/security/measures.html).
|
|
|
|
## Breaking changes
|
|
|
|
See [BREAKING](./BREAKING.md).
|
|
|
|
## Contribute
|
|
|
|
If you want to contribute to Authelia, check the documentation available
|
|
[here](https://docs.authelia.com/contributing/).
|
|
|
|
## Sponsorship
|
|
|
|
[Become a backer](https://opencollective.com/authelia-sponsors) to support Authelia.
|
|
|
|
## License
|
|
|
|
**Authelia** is **licensed** under the **[Apache 2.0]** license. The terms of the license are detailed
|
|
in [LICENSE](./LICENSE).
|
|
|
|
|
|
[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/
|