Revert "website/docs: Prepare for monorepo. (#14119)" (#14239)

This reverts commit 5bdef1c4f6.
This commit is contained in:
Marcelo Elizeche Landó
2025-04-24 15:44:13 -04:00
committed by GitHub
parent 98d201d34c
commit df472dd842
61 changed files with 3847 additions and 5852 deletions

View File

@ -29,8 +29,8 @@ You can also use custom email templates, to use your own design or layout.
Starting with authentik 2024.2, it is possible to create `.txt` files with the same name as the `.html` template. If a matching `.txt` file exists, the email sent will be a multipart email with both the text and HTML template.
:::
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
<Tabs
defaultValue="docker-compose"

View File

@ -2,9 +2,8 @@
title: Caddy
---
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Placeholders from "./__placeholders.md";
import CaddyStandalone from "./_caddy_standalone.md";

View File

@ -2,9 +2,8 @@
title: Envoy
---
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Placeholders from "./__placeholders.md";
import EnvoyIstio from "./_envoy_istio.md";

View File

@ -1,5 +1,5 @@
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
# nginx

View File

@ -1,5 +1,5 @@
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
# Traefik

View File

@ -1,82 +0,0 @@
import styles from "./styles.module.css";
const RADIUSProtocols = [
"PAP",
"CHAP",
"Digest",
"MS-CHAP",
"PEAP",
"MS-CHAPv2",
"Cisco LEAP",
"EAP-GTC",
"EAP-MD5",
"EAP-PWD",
] as const satisfies string[];
type RADIUSProtocol = (typeof RADIUSProtocols)[number];
const HashKinds = [
"Cleartext",
"NT",
"MD5",
"Salted MD5",
"SHA1",
"Salted SHA1",
"Unix Crypt",
] as const satisfies string[];
type HashKind = (typeof HashKinds)[number];
const supportMatrix: Record<HashKind, RADIUSProtocol[]> = {
"Cleartext": [
"PAP",
"CHAP",
"Digest",
"MS-CHAP",
"PEAP",
"MS-CHAPv2",
"Cisco LEAP",
"EAP-GTC",
"EAP-MD5",
"EAP-PWD",
],
"NT": ["PAP", "MS-CHAP", "PEAP", "MS-CHAPv2", "Cisco LEAP", "EAP-GTC"],
"MD5": ["PAP", "EAP-GTC"],
"Salted MD5": ["PAP", "EAP-GTC"],
"SHA1": ["PAP", "EAP-GTC"],
"Salted SHA1": ["PAP", "EAP-GTC", "EAP-PWD"],
"Unix Crypt": ["PAP", "EAP-GTC", "EAP-PWD"],
};
export const HashSupport: React.FC = () => {
return (
<table className={styles.table}>
<thead>
<tr>
<th></th>
{HashKinds.map((hashKind, i) => (
<th key={i}>{hashKind}</th>
))}
</tr>
</thead>
<tbody>
{RADIUSProtocols.map((radiusProtocol, i) => (
<tr key={i}>
<td>{radiusProtocol}</td>
{HashKinds.map((hashKind) => {
const protocols = supportMatrix[hashKind];
const supported = protocols.includes(radiusProtocol);
return (
<td data-supported={supported} key={hashKind}>
{supported ? "✓" : "✗"}
</td>
);
})}
</tr>
))}
</tbody>
</table>
);
};

View File

@ -2,7 +2,7 @@
title: RADIUS Provider
---
import { HashSupport } from "./HashSupport";
import { Check, X, AlertTriangle } from "react-feather";
You can configure a Radius provider for applications that don't support any other protocols or that require Radius.
@ -56,4 +56,15 @@ After creation, make sure to select the RADIUS property mapping in the RADIUS pr
The RADIUS provider only supports the [PAP](https://en.wikipedia.org/wiki/Password_Authentication_Protocol) (Password Authentication Protocol) protocol:
<HashSupport />
| | Clear-text | NT hash | MD5 hash | Salted MD5 hash | SHA1 hash | Salted SHA1 hash | Unix Crypt |
| ------------ | --------------- | --------------- | --------------- | --------------- | --------------- | ---------------- | --------------- |
| PAP | <Check></Check> | <Check></Check> | <Check></Check> | <Check></Check> | <Check></Check> | <Check></Check> | <Check></Check> |
| CHAP | <Check></Check> | <X></X> | <X></X> | <X></X> | <X></X> | <X></X> | <X></X> |
| Digest | <Check></Check> | <X></X> | <X></X> | <X></X> | <X></X> | <X></X> | <X></X> |
| MS-CHAP | <Check></Check> | <Check></Check> | <X></X> | <X></X> | <X></X> | <X></X> | <X></X> |
| PEAP | <Check></Check> | <Check></Check> | <X></X> | <X></X> | <X></X> | <X></X> | <X></X> |
| EAP-MSCHAPv2 | <Check></Check> | <Check></Check> | <X></X> | <X></X> | <X></X> | <X></X> | <X></X> |
| Cisco LEAP | <Check></Check> | <Check></Check> | <X></X> | <X></X> | <X></X> | <X></X> | <X></X> |
| EAP-GTC | <Check></Check> | <Check></Check> | <Check></Check> | <Check></Check> | <Check></Check> | <Check></Check> | <Check></Check> |
| EAP-MD5 | <Check></Check> | <X></X> | <X></X> | <X></X> | <X></X> | <X></X> | <X></X> |
| EAP-PWD | <Check></Check> | <X></X> | <X></X> | <X></X> | <X></X> | <Check></Check> | <Check></Check> |

View File

@ -1,20 +0,0 @@
.table td {
text-align: center;
font-weight: bold;
&:first-child {
text-align: right;
width: 13ch;
}
&:not(:first-child) {
width: 10ch;
}
&[data-supported="true"] {
color: var(--ifm-color-success-dark);
}
&[data-supported="false"] {
color: var(--ifm-color-danger-dark);
}
}

View File

@ -4,7 +4,6 @@ title: Example
This is one of the default packaged blueprints to create the default authentication flow.
<!-- prettier-ignore-start -->
```yaml
version: 1
metadata:
@ -65,4 +64,3 @@ entries:
target: !KeyOf flow
model: authentik_flows.flowstagebinding
```
<!-- prettier-ignore-end -->

View File

@ -48,8 +48,6 @@ Returns the value of the given environment variable. Can be used as a scalar wit
Examples:
{/* prettier-ignore-start */}
```yaml
configure_flow: !Find [authentik_flows.flow, [slug, default-password-change]]
```
@ -62,8 +60,6 @@ configure_flow:
]
```
{/* prettier-ignore-end */}
Looks up any model and resolves to the the matches' primary key.
First argument is the model to be queried, remaining arguments are expected to be pairs of key=value pairs to query for.
@ -71,15 +67,10 @@ First argument is the model to be queried, remaining arguments are expected to b
Example:
{/* prettier-ignore-start */}
```yaml
configure_flow: !Context foo
```
{/* prettier-ignore-end */}
Find values from the context. Can optionally be called with a default like `!Context [foo, default-value]`.
#### `!Format`
@ -218,8 +209,6 @@ For example, given a sequence like this - `["a", "b", "c"]`, this tag will resol
Minimal examples:
{/* prettier-ignore-start */}
```yaml
configuration_stages: !Enumerate [
!Context map_of_totp_stage_names_and_types,
@ -235,8 +224,6 @@ configuration_stages: !Enumerate [
]
```
{/* prettier-ignore-end */}
The above example will resolve to something like this:
```yaml
@ -278,8 +265,6 @@ Full example:
Note that an `!Enumeration` tag's iterable can never be an `!Item` or `!Value` tag with a depth of `0`. Minimum depth allowed is `1`. This is because a depth of `0` refers to the `!Enumeration` tag the `!Item` or `!Value` tag is in, and an `!Enumeration` tag cannot iterate over itself.
:::
{/* prettier-ignore-start */}
```yaml
example: !Enumerate [
!Context sequence, # ["foo", "bar"]
@ -303,8 +288,6 @@ example: !Enumerate [
]
```
{/* prettier-ignore-end */}
The above example will resolve to something like this:
```yaml

View File

@ -2,8 +2,8 @@
To further modify the look of authentik, a custom CSS file can be created. Creating such a file is outside the scope of this document.
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
<Tabs
defaultValue="docker-compose"

View File

@ -242,8 +242,8 @@ This section covers the usage of React components within our documentation. File
Use **Tabs** to display different configurations (e.g., setting up authentication with OIDC vs. SAML) to help users navigate between options. Default to the easier or more common option. Insert the following lines wherever you want the code block to appear:
```jsx
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
<Tabs
defaultValue="oidc"

View File

@ -148,6 +148,7 @@ We'll be publishing a security Issue (CVE-2022-xxxxx) and accompanying fix on _d
<details>
<summary>Mailing list template</summary>
<p>
Subject: `Release of authentik Security releases 2022.10.3 and 2022.11.3`
@ -157,10 +158,12 @@ The security advisory for CVE-2022-xxxxx has been published: https://github.com/
Releases 2022.10.3 and 2022.11.3 with fixes included are available here: https://github.com/goauthentik/authentik/releases
```
</p>
</details>
<details>
<summary>Discord template</summary>
<p>
```markdown
[...existing announcement...]
@ -172,4 +175,5 @@ Advisory for for CVE-2022-xxxxx has been published here https://github.com/goaut
The fixed versions 2022.10.3 and 2022.11.3 are available here: https://github.com/goauthentik/authentik/releases
```
</p>
</details>

View File

@ -62,7 +62,7 @@ Depending on platform, some native dependencies might be required. On macOS, run
4. From the cloned repository root, install the front-end dependencies using NPM.
```shell
# From the root of the repository
cd web
npm ci
```

View File

@ -9,9 +9,9 @@ tags:
- docker
---
import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment";
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment";
## Requirements

View File

@ -24,34 +24,39 @@ The authentik product provides the following consoles:
In authentik, you can use Light or Dark mode for the Admin interface, User interface, and the Flow interface.
import useBaseUrl from "@docusaurus/useBaseUrl";
import ReactBeforeSliderComponent from "react-before-after-slider-component";
import "react-before-after-slider-component/dist/build.css";
import ReactBeforeSliderComponent from "react-before-after-slider-component";
import useBaseUrl from "@docusaurus/useBaseUrl";
<ReactBeforeSliderComponent
firstImage={{
id: 1,
imageUrl: useBaseUrl("img/screen_flow_dark.jpg"),
}}
secondImage={{
id: 2,
imageUrl: useBaseUrl("img/screen_flow_light.jpg"),
}}
/>
<ReactBeforeSliderComponent
firstImage={{
id: 1,
imageUrl: useBaseUrl("img/screen_apps_dark.jpg"),
}}
secondImage={{
id: 2,
imageUrl: useBaseUrl("img/screen_apps_light.jpg"),
}}
/>
<ReactBeforeSliderComponent
firstImage={{
id: 1,
imageUrl: useBaseUrl("img/screen_admin_dark.jpg"),
}}
secondImage={{
id: 2,
imageUrl: useBaseUrl("img/screen_admin_light.jpg"),
}}
/>

View File

@ -17,8 +17,8 @@ To disable these outbound connections, adjust the settings as follows:
To view a list of all configuration options, refer to the [Configuration](./configuration/configuration.mdx) documentation.
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
<Tabs
defaultValue="docker-compose"

View File

@ -8,8 +8,8 @@ You can test upcoming authentik versions, including major new features that are
Downgrading from the Beta is not supported. It is recommended to take a backup before upgrading, or test Beta versions on a separate install. Upgrading from Beta versions to the next release is usually possible, however also not supported.
:::
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
<Tabs
defaultValue="docker-compose"

View File

@ -17,8 +17,8 @@ All of these variables can be set to values, but you can also use a URI-like for
## Set your environment variables
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
<Tabs groupId="platform">
<TabItem value="docker-compose" label="Docker Compose" default>

View File

@ -27,8 +27,8 @@ This installation method is for test setups and small-scale production setups.
To download the latest `docker-compose.yml` open your terminal and navigate to the directory of your choice.
Run the following command:
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
{/* prettier-ignore */}
<Tabs groupId="OS">

View File

@ -20,8 +20,8 @@ authentik does not support downgrading. Make sure to back up your database in ca
## Upgrade authentik
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
<Tabs groupId="platform">
<TabItem value="docker-compose" label="Docker Compose" default>

View File

@ -14,8 +14,8 @@ By default, the GeoIP database is loaded from `/geoip/GeoLite2-City.mmdb`. If mo
If you want to disable GeoIP, you can set the path to a non-existent path and authentik will skip the GeoIP.
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
<Tabs
defaultValue="docker-compose"

View File

@ -2,8 +2,8 @@
title: General troubleshooting steps
---
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
## Set the log level to TRACE

View File

@ -10,8 +10,8 @@ The server and worker containers support multiple log levels: `debug`, `info`, `
To modify the log level, follow the steps for your platform
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
<Tabs
groupId="platform"

View File

@ -32,7 +32,6 @@ See the [overview](../../property-mappings/index.md) for information on how prop
Each top level SCIM attribute is available as a variable in the expression. For example given an SCIM request with the payload of
<!-- prettier-ignore-start -->
```json
{
"schemas": [
@ -58,7 +57,6 @@ Each top level SCIM attribute is available as a variable in the expression. For
}
}
```
<!-- prettier-ignore-end -->
The following variables are available in the expression: