RPJosh
/
authelia
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: fix istio docs and readme (#4120)

pull/4122/head
James Elliott 2022-10-03 15:57:25 +11:00 committed by GitHub
parent 21a24ac1e1
commit f80edd2f4a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 28 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -16,9 +16,8 @@
[![Matrix](https://img.shields.io/matrix/authelia-support:matrix.org?label=matrix&logo=matrix&style=flat-square&color=blue)](https://matrix.to/#/#support:authelia.com) [![Matrix](https://img.shields.io/matrix/authelia-support:matrix.org?label=matrix&logo=matrix&style=flat-square&color=blue)](https://matrix.to/#/#support:authelia.com)
**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](#proxy-support) by
[Traefik], [Caddy] or [HAProxy] to let them know whether requests should either be allowed or redirected to Authelia's allowing, denying, or redirecting requests.
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/).
@ -32,8 +31,11 @@ The following is a simple diagram of the architecture:
[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)), as a container on [Docker] or [Kubernetes].
the Helm [Chart](https://charts.authelia.com) (beta) leveraging ingress controllers and ingress configurations.
Deployment can be orchestrated via the Helm [Chart](https://charts.authelia.com) (beta) leveraging ingress controllers
and ingress configurations.
<p align="center"> <p align="center">
<img src="./docs/static/images/logos/kubernetes.png" height="100"/> <img src="./docs/static/images/logos/kubernetes.png" height="100"/>
@ -73,10 +75,11 @@ This is a list of the key features of 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 several Kubernetes ingress controllers:
[Traefik Kubernetes CRD](https://doc.traefik.io/traefik/providers/kubernetes-crd/), and the * [ingress-nginx](https://www.authelia.com/integration/kubernetes/nginx-ingress/)
[Traefik Kubernetes Ingress](https://doc.traefik.io/traefik/providers/kubernetes-crd/) Kubernetes ingress * [Traefik Kubernetes CRD](https://www.authelia.com/integration/kubernetes/traefik-ingress/#ingressroute)
controllers out of the box. * [Traefik Kubernetes Ingress](https://www.authelia.com/integration/kubernetes/traefik-ingress/#ingress)
* [Istio](https://www.authelia.com/integration/kubernetes/istio/)
* Beta support for installing via Helm using our [Charts](https://charts.authelia.com). * Beta support for installing via Helm using our [Charts](https://charts.authelia.com).
* Beta support for [OpenID Connect](https://www.authelia.com/roadmap/active/openid-connect/). * Beta support for [OpenID Connect](https://www.authelia.com/roadmap/active/openid-connect/).
@ -86,8 +89,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], [Skipper], [Envoy], or [HAProxy].
Docker or on top of [Kubernetes].
<p align="center"> <p align="center">
<img src="./docs/static/images/logos/nginx.png" height="50"/> <img src="./docs/static/images/logos/nginx.png" height="50"/>
@ -95,7 +97,6 @@ Docker or on top of [Kubernetes].
<img src="./docs/static/images/logos/caddy.png" height="50"/> <img src="./docs/static/images/logos/caddy.png" height="50"/>
<img src="./docs/static/images/logos/envoy.png" height="50"/> <img src="./docs/static/images/logos/envoy.png" height="50"/>
<img src="./docs/static/images/logos/haproxy.png" height="50"/> <img src="./docs/static/images/logos/haproxy.png" height="50"/>
<img src="./docs/static/images/logos/kubernetes.png" height="50"/>
</p> </p>
## Getting Started ## Getting Started
@ -383,10 +384,12 @@ Companies contributing to Authelia via Open Collective will have a special menti
[Webauthn]: https://www.yubico.com/authentication-standards/webauthn/ [Webauthn]: https://www.yubico.com/authentication-standards/webauthn/
[auth_request]: https://nginx.org/en/docs/http/ngx_http_auth_request_module.html [auth_request]: https://nginx.org/en/docs/http/ngx_http_auth_request_module.html
[config.template.yml]: ./config.template.yml [config.template.yml]: ./config.template.yml
[nginx]: https://www.nginx.com/ [nginx]: https://www.authelia.com/integration/proxies/nginx/
[Traefik]: https://traefik.io/ [Traefik]: https://www.authelia.com/integration/proxies/traefik/
[Caddy]: https://caddyserver.com/ [Caddy]: https://www.authelia.com/integration/proxies/caddy/
[HAProxy]: https://www.haproxy.org/ [Skipper]: https://www.authelia.com/integration/proxies/skipper/
[Envoy]: https://www.authelia.com/integration/proxies/envoy/
[HAProxy]: https://www.authelia.com/integration/proxies/haproxy/
[Docker]: https://docker.com/ [Docker]: https://docker.com/
[Kubernetes]: https://kubernetes.io/ [Kubernetes]: https://kubernetes.io/
[security]: https://github.com/authelia/authelia/security/policy [security]: https://github.com/authelia/authelia/security/policy

3
docs/content/en/integration/kubernetes/istio.md
View File

@ -13,6 +13,9 @@ toc: true
--- ---
Istio uses [Envoy](../proxies/envoy.md) as an Ingress. This means it has a relatively comprehensive integration option. Istio uses [Envoy](../proxies/envoy.md) as an Ingress. This means it has a relatively comprehensive integration option.
Istio is supported with Authelia v4.37.0 and higher via [Envoy]'s [external authorization] filter.
[external authorization]: (https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/http/ext_authz/v3/ext_authz.proto.html#extensions-filters-http-ext-authz-v3-extauthz)
## Example ## Example

5
docs/content/en/integration/proxies/envoy.md
View File

@ -46,8 +46,9 @@ Below you will find commented examples of the following configuration:
### Example ### Example
Support for [Envoy] is possible with Authelia v4.37.0 and higher via [Envoy]'s Support for [Envoy] is possible with Authelia v4.37.0 and higher via [Envoy]'s [external authorization] filter.
[external authorization](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/http/ext_authz/v3/ext_authz.proto.html#extensions-filters-http-ext-authz-v3-extauthz).
[external authorization]: (https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/http/ext_authz/v3/ext_authz.proto.html#extensions-filters-http-ext-authz-v3-extauthz)
{{< details "docker-compose.yaml" >}} {{< details "docker-compose.yaml" >}}
```yaml ```yaml

5
docs/content/en/integration/proxies/support.md
View File

@ -87,8 +87,9 @@ available in [Kubernetes]. You would likely have to build your own [HAProxy] ima
### Envoy ### Envoy
[Envoy] is supported with Authelia v4.37.0 and higher via [Envoy]'s [Envoy] is supported with Authelia v4.37.0 and higher via [Envoy]'s [external authorization] filter.
[external authorization](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/http/ext_authz/v3/ext_authz.proto.html#extensions-filters-http-ext-authz-v3-extauthz).
[external authorization]: (https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/http/ext_authz/v3/ext_authz.proto.html#extensions-filters-http-ext-authz-v3-extauthz)
### Caddy ### Caddy