7.9 KiB
| title | description | lead | date | draft | images | menu | weight | toc | aliases | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Support | An support matrix for Authelia and several supported reverse proxies | This documentation details a support matrix for Authelia features and specific reverse proxies as well as several caveats etc. | 2022-05-13T12:34:15+10:00 | false |
|
311 | true |
|
| Proxy | Standard | Kubernetes | XHR Redirect | Request Method |
|---|---|---|---|---|
| Traefik | ||||
| NGINX | ||||
| NGINX Proxy Manager | ||||
| SWAG | ||||
| HAProxy | ||||
| Caddy | ||||
| Traefik 1.x | ||||
| Envoy | ||||
| Skipper | ||||
| Apache | ||||
| IIS |
Legend:
| Icon | Meaning |
|---|---|
| Supported | |
| Unknown | |
| Partially Supported | |
| Not Supported |
Support
Standard
Standard support includes the essential features in securing an application with Authelia such as:
- Redirecting users to the Authelia portal if they are not authenticated.
- Redirecting users to the target application after authentication has occurred successfully.
It does not include actually running Authelia as a service behind the proxy, any proxy should be compatible with serving the Authelia portal itself. Standard support is only important for protected applications.
Kubernetes
While proxies that generally support Authelia outside a Kubernetes cluster, there are a few situations where that does not translate to being possible when used as an Ingress Controller. There are various reasons for this such as the reverse proxy in question does not even support running as a Kubernetes Ingress Controller, or the required modules to perform authentication transparently to the user are not typically available inside a cluster.
More information about Kubernetes deployments of Authelia can be read in the documentation.
XHR Redirect
Note: The XHR is a deprecated web feature and applications should be using the new Fetch API which does not have the same issues regarding redirects (the Fetch API allows developers to control how to handle them). As such the fact a proxy does not support it should only be seen as a means to communicate a feature not that the proxy should not be used.
XML HTTP Requests do not typically redirect browsers when returned 30x status codes. Instead, the standard method is to return a 401 status code with a Location header. While this may seem trivial; currently there isn't wide support for it. For example the nginx ngx_http_auth_request_module does not seem to support this in any way.
Request Method
Authelia detects the upstream request method using the X-Forwarded-Method header. Some proxies set this out of the box, some require you to configure this manually. At the present time all proxies that have Standard Support do support this.
Specific proxy notes
HAProxy
HAProxy is only supported via a lua module. Lua is typically not available in Kubernetes. You would likely have to build your own HAProxy image.
Envoy
Envoy is currently not documented however we believe it is likely to be technically supported. This should be possible via Envoy's external authorization.
Caddy
Caddy needs to be version 2.5.1 or greater.
Apache
Apache is not supported as it has no module that supports this kind of authentication method. It's not certain this would even be possible, however if anyone did something like this in the future we'd be interested in a contribution.
IIS
Microsoft IIS is not supported as it has no module that supports this kind of authentication method. It's not certain this would even be possible, however if anyone did something like this in the future we'd be interested in a contribution.