docs: misc fixes (#4111)

* docs: misc adjustments

* docs: misc adjustments
pull/3968/head^2
James Elliott 2022-10-01 20:24:31 +10:00 committed by GitHub
parent fea3bd108b
commit 034876a2e3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 5 deletions

View File

@ -17,7 +17,7 @@
**Authelia** is an open-source authentication and authorization server providing two-factor authentication and single **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], 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. portal for authentication.
Documentation is available at [https://www.authelia.com/](https://www.authelia.com/). 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/), **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/), [APT](https://apt.authelia.com/stable/debian/packages/authelia/),
[FreeBSD Ports](https://svnweb.freebsd.org/ports/head/www/authelia/), or using a [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 [.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. 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 * Curated configuration from [LinuxServer](https://www.linuxserver.io/) via their
[Swag](https://docs.linuxserver.io/general/swag) container as well as a [Swag](https://docs.linuxserver.io/general/swag) container as well as a
[guide](https://blog.linuxserver.io/2020/08/26/setting-up-authelia/). [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. directive.
* Kubernetes Support: * Kubernetes Support:
* Compatible with the [ingress-nginx](https://github.com/kubernetes/ingress-nginx), the * 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 ## 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]. Docker or on top of [Kubernetes].
<p align="center"> <p align="center">
@ -391,7 +391,7 @@ Companies contributing to Authelia via Open Collective will have a special menti
[config.template.yml]: ./config.template.yml [config.template.yml]: ./config.template.yml
[nginx]: https://www.nginx.com/ [nginx]: https://www.nginx.com/
[Traefik]: https://traefik.io/ [Traefik]: https://traefik.io/
[caddy]: https://caddyserver.com/ [Caddy]: https://caddyserver.com/
[HAProxy]: https://www.haproxy.org/ [HAProxy]: https://www.haproxy.org/
[Docker]: https://docker.com/ [Docker]: https://docker.com/
[Kubernetes]: https://kubernetes.io/ [Kubernetes]: https://kubernetes.io/

View File

@ -26,6 +26,7 @@ services:
- 9091 - 9091
restart: unless-stopped restart: unless-stopped
healthcheck: healthcheck:
## In production the healthcheck section should be commented.
disable: true disable: true
environment: environment:
- TZ=Australia/Melbourne - TZ=Australia/Melbourne

View File

@ -26,6 +26,7 @@ services:
- 9091 - 9091
restart: unless-stopped restart: unless-stopped
healthcheck: healthcheck:
## In production the healthcheck section should be commented.
disable: true disable: true
environment: environment:
- TZ=Australia/Melbourne - TZ=Australia/Melbourne