Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions website/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,5 @@ yarn-error.log*

static/docker-compose.yml
static/schema.yml
static/releases.gen.json
docs/developer-docs/api/reference/**
7 changes: 0 additions & 7 deletions website/.prettierignore

This file was deleted.

1 change: 0 additions & 1 deletion website/.prettierrc.json

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -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 Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";

<Tabs
defaultValue="docker-compose"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
title: Caddy
---

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";

import Placeholders from "./__placeholders.md";
import CaddyStandalone from "./_caddy_standalone.md";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
title: Envoy
---

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";

import Placeholders from "./__placeholders.md";
import EnvoyIstio from "./_envoy_istio.md";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";

# nginx

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";

# Traefik

Expand Down
82 changes: 82 additions & 0 deletions website/docs/add-secure-apps/providers/radius/HashSupport.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
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>
);
};
15 changes: 2 additions & 13 deletions website/docs/add-secure-apps/providers/radius/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: RADIUS Provider
---

import { Check, X, AlertTriangle } from "react-feather";
import { HashSupport } from "./HashSupport";

You can configure a Radius provider for applications that don't support any other protocols or that require Radius.

Expand Down Expand Up @@ -56,15 +56,4 @@ 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:

| | 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> |
<HashSupport />
20 changes: 20 additions & 0 deletions website/docs/add-secure-apps/providers/radius/styles.module.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
.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);
}
}
2 changes: 2 additions & 0 deletions website/docs/customize/blueprints/v1/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: Example

This is one of the default packaged blueprints to create the default authentication flow.

<!-- prettier-ignore-start -->
```yaml
version: 1
metadata:
Expand Down Expand Up @@ -64,3 +65,4 @@ entries:
target: !KeyOf flow
model: authentik_flows.flowstagebinding
```
<!-- prettier-ignore-end -->
17 changes: 17 additions & 0 deletions website/docs/customize/blueprints/v1/tags.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ 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]]
```
Expand All @@ -60,17 +62,24 @@ 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.

#### `!Context`

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`
Expand Down Expand Up @@ -209,6 +218,8 @@ 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,
Expand All @@ -224,6 +235,8 @@ configuration_stages: !Enumerate [
]
```

{/* prettier-ignore-end */}

The above example will resolve to something like this:

```yaml
Expand Down Expand Up @@ -265,6 +278,8 @@ 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"]
Expand All @@ -288,6 +303,8 @@ example: !Enumerate [
]
```

{/* prettier-ignore-end */}

The above example will resolve to something like this:

```yaml
Expand Down
2 changes: 1 addition & 1 deletion website/docs/customize/interfaces/_global/customcss.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";

<Tabs
defaultValue="docker-compose"
Expand Down
2 changes: 1 addition & 1 deletion website/docs/developer-docs/docs/style-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -255,8 +255,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 Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";

<Tabs
defaultValue="oidc"
Expand Down
4 changes: 0 additions & 4 deletions website/docs/developer-docs/releases/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,6 @@ 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`

Expand All @@ -158,12 +157,10 @@ 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...]
Expand All @@ -175,5 +172,4 @@ 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>
Original file line number Diff line number Diff line change
Expand Up @@ -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
cd web
# From the root of the repository
npm ci
```

Expand Down
4 changes: 2 additions & 2 deletions website/docs/developer-docs/setup/full-dev-environment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ tags:
- docker
---

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment";
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";

## Requirements

Expand Down
11 changes: 3 additions & 8 deletions website/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,39 +24,34 @@ 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 "react-before-after-slider-component/dist/build.css";
import ReactBeforeSliderComponent from "react-before-after-slider-component";
import useBaseUrl from "@docusaurus/useBaseUrl";
import ReactBeforeSliderComponent from "react-before-after-slider-component";

import "react-before-after-slider-component/dist/build.css";

<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"),
}}
/>
Expand Down
2 changes: 1 addition & 1 deletion website/docs/install-config/air-gapped.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";

<Tabs
defaultValue="docker-compose"
Expand Down
Loading
Loading