habsi/authentik
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

website/docs: tweak Config page (#6854)

Browse Source 
* 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:
Tana M Berry
2023-09-12 15:30:40 -05:00
committed by GitHub
parent 515ce94a85
commit c79e90964a
5 changed files with 43 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
website/docs/installation/configuration.md → website/docs/installation/configuration.mdx
View File

@ -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