diff --git a/README.md b/README.md index fee6d83f3..dc3691124 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@

- [![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)][Apache 2.0] + [![license](https://img.shields.io/badge/license-Apache%202.0-green.svg)][Apache 2.0] [![Build](https://travis-ci.org/clems4ever/authelia.svg?branch=master)](https://travis-ci.org/clems4ever/authelia) [![Known Vulnerabilities](https://snyk.io/test/github/clems4ever/authelia/badge.svg?targetFile=package.json)](https://snyk.io/test/github/clems4ever/authelia?targetFile=package.json) [![Gitter](https://img.shields.io/gitter/room/badges/shields.svg)](https://gitter.im/authelia/general?utm_source=share-link&utm_medium=link&utm_campaign=share-link) @@ -10,14 +10,25 @@ **Authelia** is an open-source authentication and authorization server providing 2-factor authentication and single sign-on (SSO) for your -applications. -It acts as a companion of reverse proxies by handling authentication and -authorization requests. +applications via a web portal. +It acts as a companion of reverse proxies like [nginx] or [Traefik] by handling forwarded authentication and authorization requests. + +

+ + + + +

**Authelia** can be installed as a standalone service using Docker or NPM -but can also be deployed easily on Kubernetes. On the latest, one can -leverage ingress configuration to set up authentication and authorizations -for specific services in only few seconds. +but can also be deployed easily on [Kubernetes] leveraging ingress controllers and ingress configuration. + +

+ + +

+ +Here is what Authelia's portal looks like

@@ -32,16 +43,28 @@ Here is the list of the main available features: * **[Security Key (U2F)](./docs/2factor/security-key.md)** with [Yubikey]. * **[Time-based One-Time password](./docs/2factor/time-based-one-time-password.md)** with [Google Authenticator]. * **[Mobile Push Notifications](./docs/2factor/duo-push-notifications.md)** with [Duo](https://duo.com/). -* Password reset with identity verification using email. +* 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. -* High-availability using distributed database and KV store. -* Compatible with Kubernetes ingress-nginx controller out of the box. +* Support of basic authentication for endpoints protected by single factor. +* Highly-available using distributed database and 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](./docs/features.md). +## Proxy support + +Authelia works in combination with [nginx] or [Traefik] and soon with [HAProxy] as discussed in +[#271](https://github.com/clems4ever/authelia/issues/271). It can be deployed on bare metal with +Docker or directly in [Kubernetes]. + +

+ + + +

+ ## Getting Started You can start off with @@ -102,3 +125,7 @@ in [LICENSE](LICENSE). [auth_request]: http://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]: https://github.com/clems4ever/authelia/blob/master/config.template.yml +[nginx]: https://www.nginx.com/ +[Traefik]: https://traefik.io/ +[HAproxy]: http://www.haproxy.org/ +[Kubernetes]: https://kubernetes.io/ diff --git a/docs/deployment-production.md b/docs/deployment-production.md index d7d251f89..8b933920d 100644 --- a/docs/deployment-production.md +++ b/docs/deployment-production.md @@ -31,9 +31,10 @@ the root of the repo. docker run -v /path/to/your/config.yml:/etc/authelia/config.yml clems4ever/authelia + ## On top of Kubernetes - + **Authelia** can also be installed on top of [Kubernetes] using [nginx ingress controller](https://github.com/kubernetes/ingress-nginx). diff --git a/images/authelia-title-white.png b/images/authelia-title-white.png deleted file mode 100644 index 75621a5f3..000000000 Binary files a/images/authelia-title-white.png and /dev/null differ diff --git a/images/authelia-title.png b/images/authelia-title.png index c56711689..61e891165 100644 Binary files a/images/authelia-title.png and b/images/authelia-title.png differ diff --git a/images/authelia-title.xcf b/images/authelia-title.xcf new file mode 100644 index 000000000..c0fa1b35e Binary files /dev/null and b/images/authelia-title.xcf differ diff --git a/images/authelia.logo.png b/images/authelia.logo.png new file mode 100644 index 000000000..65747fea1 Binary files /dev/null and b/images/authelia.logo.png differ diff --git a/images/docker.logo.png b/images/docker.logo.png new file mode 100644 index 000000000..dc5b89699 Binary files /dev/null and b/images/docker.logo.png differ diff --git a/images/icon.png b/images/icon.png deleted file mode 100644 index a0587ae73..000000000 Binary files a/images/icon.png and /dev/null differ diff --git a/images/kube-logo.png b/images/kube-logo.png deleted file mode 100644 index 05fc5e1d2..000000000 Binary files a/images/kube-logo.png and /dev/null differ diff --git a/images/kubernetes.logo.png b/images/kubernetes.logo.png new file mode 100644 index 000000000..5e2b1ab75 Binary files /dev/null and b/images/kubernetes.logo.png differ diff --git a/images/nginx.logo.png b/images/nginx.logo.png new file mode 100644 index 000000000..e879ce45d Binary files /dev/null and b/images/nginx.logo.png differ diff --git a/images/plus.png b/images/plus.png new file mode 100644 index 000000000..88f0a1fdd Binary files /dev/null and b/images/plus.png differ diff --git a/images/traefik.logo.png b/images/traefik.logo.png new file mode 100644 index 000000000..5c3c9783f Binary files /dev/null and b/images/traefik.logo.png differ diff --git a/images/user.svg b/images/user.svg new file mode 100644 index 000000000..db78e7d94 --- /dev/null +++ b/images/user.svg @@ -0,0 +1,51 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +