2021-06-08 21:10:17 +00:00
---
2021-11-01 14:56:24 +00:00
title: Overview
2021-06-08 21:10:17 +00:00
---
2021-12-01 19:19:09 +00:00
The proxy outpost sets the following user-specific headers:
2021-06-08 21:10:17 +00:00
2021-12-01 19:19:09 +00:00
- X-authentik-username: `akadmin`
The username of the currently logged in user
- X-authentik-groups: `foo|bar|baz`
The groups the user is member of, separated by a pipe
- X-authentik-email: `root@localhost`
The email address of the currently logged in user
- X-authentik-name: `authentik Default Admin`
Full name of the current user
- X-authentik-uid: `900347b8a29876b45ca6f75722635ecfedf0e931c6022e3a29a8aa13fb5516fb`
The hashed identifier of the currently logged in user.
2021-06-08 21:10:17 +00:00
Additionally, you can set `additionalHeaders` on groups or users to set additional headers.
If you enable *Set HTTP-Basic Authentication* option, the HTTP Authorization header is being set.
2021-12-01 19:19:09 +00:00
Besides these user-specific headers, some application specific headers are also set:
2021-12-20 20:37:31 +00:00
- X-authentik-meta-outpost: `authentik Embedded Outpost`
2021-12-01 19:19:09 +00:00
The authentik outpost's name.
- X-authentik-meta-provider: `test`
The authentik provider's name.
- X-authentik-meta-app: `test`
The authentik application's slug.
2022-01-14 09:45:37 +00:00
- X-authentik-meta-version: `authentik-outpost@1.2.3`
2021-12-01 19:41:55 +00:00
The authentik outpost's version.
2022-02-10 22:09:55 +00:00
### Only in proxy mode
- X-Forwarded-Host:
The original Host header sent by the client. This is set as the `Host` header is set to the host of the configured backend.
2021-12-18 14:50:42 +00:00
## HTTPS
2021-06-08 21:10:17 +00:00
2021-09-08 18:04:56 +00:00
The outpost listens on both 9000 for HTTP and 9443 for HTTPS.
2021-06-08 21:10:17 +00:00
:::info
If your upstream host is HTTPS, and you're not using forward auth, you need to access the outpost over HTTPS too.
:::
2021-07-06 12:26:11 +00:00
2021-12-18 14:50:42 +00:00
## Logging out
2021-07-06 12:26:11 +00:00
Login is done automatically when you visit the domain without a valid cookie.
2022-02-08 19:25:38 +00:00
When using single-application mode, navigate to `app.domain.tld/outpost.goauthentik.io/sign_out` .
2021-07-06 12:26:11 +00:00
2022-02-08 19:25:38 +00:00
When using domain-level mode, navigate to `auth.domain.tld/outpost.goauthentik.io/sign_out` , where auth.domain.tld is the external host configured for the provider.
2021-07-06 12:26:11 +00:00
2022-02-08 19:25:38 +00:00
To log out, navigate to `/outpost.goauthentik.io/sign_out` .
2021-12-18 14:50:42 +00:00
## Allowing unauthenticated requests
To allow un-authenticated requests to certain paths/URLs, you can use the *Unauthenticated URLs* / *Unauthenticated Paths* field.
Each new line is interpreted as a regular expression, and is compiled and checked using the standard Golang regex parser.
The behaviour of this field changes depending on which mode you're in.
### Proxy and Forward auth (single application)
In this mode, the regular expressions are matched against the Request's Path.
### Forward auth (domain level)
In this mode, the regular expressions are matched against the Request's full URL.
2022-02-09 09:41:42 +00:00
## Dynamic backend selection
You can configure the backend the proxy should access dynamically via *Scope mappings* . To do so, create a new *Scope mapping* , with a name and scope of your choice. As expression, use this:
```python
return {
"ak_proxy": {
"backend_override": f"http://foo.bar.baz/{request.user.username}"
}
}
```
Afterwards, edit the *Proxy provider* and add this new mapping. The expression is only evaluated when the user logs into the application.