From 034876a2e3923996b6f5be00f882915fd79382fc Mon Sep 17 00:00:00 2001 From: James Elliott Date: Sat, 1 Oct 2022 20:24:31 +1000 Subject: [PATCH] docs: misc fixes (#4111) * docs: misc adjustments * docs: misc adjustments --- README.md | 10 +++++----- examples/compose/lite/docker-compose.yml | 1 + examples/compose/local/docker-compose.yml | 1 + 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 589de509e..ada435e5e 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ **Authelia** is an open-source authentication and authorization server providing two-factor authentication and single sign-on (SSO) for your applications via a web portal. It acts as a companion for reverse proxies like [nginx], -[Traefik], [caddy] or [HAProxy] to let them know whether requests should either be allowed or redirected to Authelia's +[Traefik], [Caddy] or [HAProxy] to let them know whether requests should either be allowed or redirected to Authelia's portal for authentication. Documentation is available at [https://www.authelia.com/](https://www.authelia.com/). @@ -31,7 +31,7 @@ The following is a simple diagram of the architecture: **Authelia** can be installed as a standalone service from the [AUR](https://aur.archlinux.org/packages/authelia/), [APT](https://apt.authelia.com/stable/debian/packages/authelia/), [FreeBSD Ports](https://svnweb.freebsd.org/ports/head/www/authelia/), or using a -[Static binary](https://github.com/authelia/authelia/releases/latest), +[static binary](https://github.com/authelia/authelia/releases/latest), [.deb package]((https://github.com/authelia/authelia/releases/latest)), [Docker] or [Kubernetes] either manually or via the Helm [Chart](https://charts.authelia.com) (beta) leveraging ingress controllers and ingress configurations. @@ -70,7 +70,7 @@ This is a list of the key features of Authelia: * Curated configuration from [LinuxServer](https://www.linuxserver.io/) via their [Swag](https://docs.linuxserver.io/general/swag) container as well as a [guide](https://blog.linuxserver.io/2020/08/26/setting-up-authelia/). -* Compatible with [caddy] using the [forward_auth](https://caddyserver.com/docs/caddyfile/directives/forward_auth) +* Compatible with [Caddy] using the [forward_auth](https://caddyserver.com/docs/caddyfile/directives/forward_auth) directive. * Kubernetes Support: * Compatible with the [ingress-nginx](https://github.com/kubernetes/ingress-nginx), the @@ -86,7 +86,7 @@ If you want to know more about the roadmap, follow [Roadmap](https://www.autheli ## Proxy support -Authelia works in combination with [nginx], [Traefik], [caddy] or [HAProxy]. It can be deployed on bare metal with +Authelia works in combination with [nginx], [Traefik], [Caddy] or [HAProxy]. It can be deployed on bare metal with Docker or on top of [Kubernetes].

@@ -391,7 +391,7 @@ Companies contributing to Authelia via Open Collective will have a special menti [config.template.yml]: ./config.template.yml [nginx]: https://www.nginx.com/ [Traefik]: https://traefik.io/ -[caddy]: https://caddyserver.com/ +[Caddy]: https://caddyserver.com/ [HAProxy]: https://www.haproxy.org/ [Docker]: https://docker.com/ [Kubernetes]: https://kubernetes.io/ diff --git a/examples/compose/lite/docker-compose.yml b/examples/compose/lite/docker-compose.yml index b4187cd6c..061e7e79f 100644 --- a/examples/compose/lite/docker-compose.yml +++ b/examples/compose/lite/docker-compose.yml @@ -26,6 +26,7 @@ services: - 9091 restart: unless-stopped healthcheck: + ## In production the healthcheck section should be commented. disable: true environment: - TZ=Australia/Melbourne diff --git a/examples/compose/local/docker-compose.yml b/examples/compose/local/docker-compose.yml index 11bc35bc7..04693a7d0 100644 --- a/examples/compose/local/docker-compose.yml +++ b/examples/compose/local/docker-compose.yml @@ -26,6 +26,7 @@ services: - 9091 restart: unless-stopped healthcheck: + ## In production the healthcheck section should be commented. disable: true environment: - TZ=Australia/Melbourne