diff --git a/README.md b/README.md index a25413be5..d4bfd1289 100644 --- a/README.md +++ b/README.md @@ -9,19 +9,18 @@ **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. +It acts as a companion of reverse proxies like [nginx] or [Traefik] to tell them wether queries should pass through. Unauthenticated user are +redirected to Authelia Sign-in portal instead. - 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! +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. diff --git a/docs/images/archi.png b/docs/images/archi.png new file mode 100644 index 000000000..89f716f0b Binary files /dev/null and b/docs/images/archi.png differ