website/docs: tweak Config page (#6854)
* used tabs to add k8s info * tweaks * changed to mdx * wording tweaks and rearranged sections * removed old md file renamed to mdx * tweak * added a redirect to toml file * fix references Signed-off-by: Jens Langhammer <jens@goauthentik.io> --------- Signed-off-by: Jens Langhammer <jens@goauthentik.io> Co-authored-by: Tana Berry <tana@goauthentik.io> Co-authored-by: Jens Langhammer <jens@goauthentik.io>
This commit is contained in:
parent
515ce94a85
commit
c79e90964a
|
@ -1,4 +1,4 @@
|
|||
# update website/docs/installation/configuration.md
|
||||
# update website/docs/installation/configuration.mdx
|
||||
# This is the default configuration file
|
||||
postgresql:
|
||||
host: localhost
|
||||
|
|
|
@ -2,12 +2,12 @@
|
|||
title: Configuration
|
||||
---
|
||||
|
||||
These are all the configuration options you can set via environment variables.
|
||||
This page details all the authentik configuration options that you can set via environment variables.
|
||||
|
||||
Append any of the following keys to your `.env` file, and run `docker-compose up -d` to apply them.
|
||||
## About authentik configurations
|
||||
|
||||
:::info
|
||||
The double-underscores are intentional, as all these settings are translated to yaml internally, a double-underscore indicates the next level.
|
||||
The double-underscores are intentional, as all these settings are translated to YAML internally, and a double-underscore indicates the next level (a subsetting).
|
||||
:::
|
||||
|
||||
All of these variables can be set to values, but you can also use a URI-like format to load values from other places:
|
||||
|
@ -15,15 +15,45 @@ All of these variables can be set to values, but you can also use a URI-like for
|
|||
- `env://<name>` Loads the value from the environment variable `<name>`. Fallback can be optionally set like `env://<name>?<default>`
|
||||
- `file://<name>` Loads the value from the file `<name>`. Fallback can be optionally set like `file://<name>?<default>`
|
||||
|
||||
## Checking settings
|
||||
## Set your environment variables
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="docker-compose" label="Docker Compose" default>
|
||||
If you are using Docker Compose, edit your <code>.env</code> file to append any keys that you want to add, and then run the following command to apply them:
|
||||
|
||||
docker-compose up -d
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="kubernetes" label="Kubernetes">
|
||||
If you are running in Kubernetes, edit your <code>values.yaml</code> file to append any keys that you want to add, and then run the following commands to apply:
|
||||
|
||||
helm repo update
|
||||
helm upgrade --install authentik authentik/authentik -f values.yaml
|
||||
|
||||
</TabItem>
|
||||
|
||||
</Tabs>
|
||||
|
||||
## Verify your configuration settings
|
||||
|
||||
To check if your config has been applied correctly, you can run the following command to output the full config:
|
||||
|
||||
```
|
||||
docker-compose run --rm worker dump_config
|
||||
# Or for kubernetes
|
||||
kubectl exec -it deployment/authentik-worker -c authentik -- ak dump_config
|
||||
```
|
||||
<Tabs>
|
||||
<TabItem value="docker-compose" label="Docker Compose" default>
|
||||
|
||||
docker-compose run --rm worker dump_config
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="kubernetes" label="Kubernetes">
|
||||
|
||||
kubectl exec -it deployment/authentik-worker -c authentik -- ak dump_config
|
||||
|
||||
</TabItem>
|
||||
|
||||
</Tabs>
|
||||
|
||||
## PostgreSQL Settings
|
||||
|
|
@ -9,7 +9,7 @@ This integration has the advantage over manual deployments of automatic updates
|
|||
The following outpost settings are used:
|
||||
|
||||
- `object_naming_template`: Configures how the container is called
|
||||
- `container_image`: Optionally overwrites the standard container image (see [Configuration](../../installation/configuration.md#authentik_outposts) to configure the global default)
|
||||
- `container_image`: Optionally overwrites the standard container image (see [Configuration](../../installation/configuration.mdx#authentik_outposts) to configure the global default)
|
||||
- `docker_network`: The Docker network the container should be added to. This needs to be modified if you plan to connect to authentik using the internal hostname.
|
||||
- `docker_map_ports`: Enable/disable the mapping of ports. When using a proxy outpost with Traefik for example, you might not want to bind ports as they are routed through Traefik.
|
||||
- `docker_labels`: Optional additional labels that can be applied to the container.
|
||||
|
|
|
@ -18,7 +18,7 @@ This integration creates the following objects:
|
|||
The following outpost settings are used:
|
||||
|
||||
- `object_naming_template`: Configures how the container is called
|
||||
- `container_image`: Optionally overwrites the standard container image (see [Configuration](../../installation/configuration.md) to configure the global default)
|
||||
- `container_image`: Optionally overwrites the standard container image (see [Configuration](../../installation/configuration.mdx) to configure the global default)
|
||||
- `kubernetes_replicas`: Replica count for the deployment of the outpost
|
||||
- `kubernetes_namespace`: Namespace to deploy in, defaults to the same namespace authentik is deployed in (if available)
|
||||
- `kubernetes_ingress_annotations`: Any additional annotations to add to the ingress object, for example cert-manager
|
||||
|
|
|
@ -21,7 +21,7 @@ slug: "/releases/2023.2"
|
|||
|
||||
- Generated avatars, multiple avatar modes
|
||||
|
||||
authentik now supports multiple avatar modes, and will use the next configured mode when a mode doesn't have an avatar. For example, the new default configuration attempts to use gravatar, but if the user's email does not have a gravatar setup, it will instead use the new generated avatars. See [Configuration](../../installation/configuration.md#authentik_avatars)
|
||||
authentik now supports multiple avatar modes, and will use the next configured mode when a mode doesn't have an avatar. For example, the new default configuration attempts to use gravatar, but if the user's email does not have a gravatar setup, it will instead use the new generated avatars. See [Configuration](../../installation/configuration.mdx#authentik_avatars)
|
||||
|
||||
## Upgrading
|
||||
|
||||
|
|
Reference in New Issue