website: Use Docusaurus Frontmatter for badges (#12893)

website/docs: Reduce redundant usage of badges. Move badge logic to components.

- Fix JSX class name warning.
- Remove duplicate titles.
- Flesh out `support_level` frontmatter.
This commit is contained in:
Teffen Ellis
2025-02-19 19:03:05 +01:00
committed by GitHub
parent df2e3878d5
commit a714c781a6
214 changed files with 930 additions and 748 deletions

View File

@ -1,6 +1,6 @@
Use the following configuration:
```
```apacheconf
app.company {
# directive execution order is only as stated if enclosed with route.
route {
@ -26,7 +26,7 @@ app.company {
If you're trying to proxy to an upstream over HTTPS, you need to set the `Host` header to the value they expect for it to work correctly.
```
```conf
reverse_proxy /outpost.goauthentik.io/* https://outpost.company {
header_up Host {http.reverse_proxy.upstream.hostport}
}

View File

@ -1,4 +1,4 @@
```
```nginx
# Increase buffer size for large headers
# This is needed only if you get 'upstream sent too big header while reading response
# header from upstream' error when trying to access an application protected by goauthentik

View File

@ -1,4 +1,4 @@
```
```nginx
# Upgrade WebSocket if requested, otherwise use keepalive
map $http_upgrade $connection_upgrade_keepalive {
default upgrade;

View File

@ -25,9 +25,9 @@ By default, when _Intercept header authentication_ is enabled, authentik will in
If the proxied application requires usage of the "Authorization" header, the setting should be disabled. When this setting is disabled, authentik will still attempt to interpret the "Authorization" header, and fall back to the default behaviour if it can't.
### Receiving HTTP Basic authentication <span class="badge badge--version">authentik 2023.1+</span>
### Receiving HTTP Basic authentication
Proxy providers can receive HTTP basic authentication credentials. The password is expected to be an _App password_, as the credentials are used internally with the [OAuth2 machine-to-machine authentication flow](../oauth2/client_credentials.md).
Proxy providers can receive HTTP basic authentication credentials. The password is expected to be an _App password_, as the credentials are used internally with the [OAuth2 machine-to-machine authentication flow](../oauth2/client_credentials.mdx).
Access control is done with the policies bound to the application being accessed.
@ -39,9 +39,9 @@ It is **strongly** recommended that the client sending requests with HTTP-Basic
Starting with authentik 2023.2, logging in with the reserved username `goauthentik.io/token` will behave as if a bearer token was used. All the same options as below apply. This is to allow token-based authentication for applications which might only support basic authentication.
### Receiving HTTP Bearer authentication <span class="badge badge--version">authentik 2023.1+</span>
### Receiving HTTP Bearer authentication
Proxy providers can receive HTTP bearer authentication credentials. The token is expected to be a JWT token issued for the proxy provider. This is described [here](../oauth2/client_credentials.md), using the _client_id_ value shown in the admin interface. Both static and JWT authentication methods are supported.
Proxy providers can receive HTTP bearer authentication credentials. The token is expected to be a JWT token issued for the proxy provider. This is described [here](../oauth2/client_credentials.mdx), using the _client_id_ value shown in the admin interface. Both static and JWT authentication methods are supported.
Access control is done with the policies bound to the application being accessed.

View File

@ -1,17 +1,14 @@
---
title: Caddy
hide_title: true
---
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
# Caddy <span class="badge badge--version">authentik 2022.8+</span>
import Placeholders from "./__placeholders.md";
import CaddyStandalone from "./_caddy_standalone.md";
The configuration template shown below apply to both single-application and domain-level forward auth.
import Placeholders from "./__placeholders.md";
<Placeholders />
<Tabs
@ -21,8 +18,6 @@ import Placeholders from "./__placeholders.md";
]}>
<TabItem value="caddy-standalone">
import CaddyStandalone from "./_caddy_standalone.md";
<CaddyStandalone />
</TabItem>

View File

@ -1,12 +1,13 @@
---
title: Envoy
hide_title: true
---
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Placeholders from "./__placeholders.md";
import EnvoyIstio from "./_envoy_istio.md";
# Envoy <span class="badge badge--version">authentik 2022.6+</span>
# Envoy
The configuration template shown below apply to both single-application and domain-level forward auth.
@ -14,20 +15,18 @@ The configuration template shown below apply to both single-application and doma
If you are using Istio and Kubernetes, use the port number that is exposed for your cluster.
:::
import Placeholders from "./__placeholders.md";
<Placeholders />
<Tabs
defaultValue="envoy-istio"
values={[
{label: 'Envoy (Istio)', value: 'envoy-istio'},
]}>
<TabItem value="envoy-istio">
import EnvoyIstio from "./_envoy_istio.md";
<EnvoyIstio />
</TabItem>
defaultValue="envoy-istio"
values={[
{
label: "Envoy (Istio)",
value: "envoy-istio",
},
]}
>
<TabItem value="envoy-istio">
<EnvoyIstio />
</TabItem>
</Tabs>