-
-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
209 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
--- | ||
title: Beta versions | ||
--- | ||
|
||
You can test upcoming authentik versions by switching to the *next* images. These beta versions supported upgrades from the latest stable version, and have a supported upgrade plan to the next stable version. | ||
|
||
import Tabs from '@theme/Tabs'; | ||
import TabItem from '@theme/TabItem'; | ||
|
||
<Tabs | ||
defaultValue="docker-compose" | ||
values={[ | ||
{label: 'docker-compose', value: 'docker-compose'}, | ||
{label: 'Kubernetes', value: 'kubernetes'}, | ||
]}> | ||
<TabItem value="docker-compose"> | ||
Add the following block to your `.env` file: | ||
|
||
```shell | ||
AUTHENTIK_IMAGE=docker.beryju.org/authentik/server | ||
AUTHENTIK_IMAGE_STATIC=docker.beryju.org/authentik/static | ||
AUTHENTIK_TAG=gh-next | ||
AUTHENTIK_OUTPOSTS__DOCKER_IMAGE_BASE=docker.beryju.org/authentik | ||
``` | ||
|
||
Afterwards, run the upgrade commands from the [release notes](../releases/next) | ||
</TabItem> | ||
<TabItem value="kubernetes"> | ||
Add the following block to your `values.yml` file: | ||
|
||
```yaml | ||
image: | ||
name: docker.beryju.org/authentik/server | ||
name_static: docker.beryju.org/authentik/static | ||
name_outposts: docker.beryju.org/authentik | ||
tag: gh-next | ||
# pullPolicy: Always to ensure you always get the latest version | ||
pullPolicy: Always | ||
``` | ||
Afterwards, run the upgrade commands from the [release notes](../releases/next) | ||
</TabItem> | ||
</Tabs> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
--- | ||
title: docker-compose configuration | ||
--- | ||
|
||
These are all the configuration options you can set via docker-compose. These don't apply to Kubernetes, as those settings are configured via helm. | ||
|
||
Append any of the following keys to your `.env` file, and run `docker-compose up -d` to apply them. | ||
|
||
## AUTHENTIK_LOG_LEVEL | ||
|
||
Log level for the server and worker containers. Possible values: debug, info, warning, error | ||
Defaults to `info`. | ||
|
||
## AUTHENTIK_ERROR_REPORTING | ||
|
||
- AUTHENTIK_ERROR_REPORTING__ENABLED | ||
|
||
Enable error reporting. Defaults to `false`. | ||
|
||
Error reports are sent to https://sentry.beryju.org, and are used for debugging and general feedback. Anonymous performance data is also sent. | ||
|
||
- AUTHENTIK_ERROR_REPORTING__ENVIRONMENT | ||
|
||
Unique environment that is attached to your error reports, should be set to your email address for example. Defaults to `customer`. | ||
|
||
- AUTHENTIK_ERROR_REPORTING__SEND_PII | ||
|
||
Whether or not to send personal data, like usernames. Defaults to `false`. | ||
|
||
## AUTHENTIK_EMAIL | ||
|
||
- AUTHENTIK_EMAIL__HOST | ||
|
||
Default: `localhost` | ||
|
||
- AUTHENTIK_EMAIL__PORT | ||
|
||
Default: `25` | ||
|
||
- AUTHENTIK_EMAIL__USERNAME | ||
|
||
Default: `""` | ||
|
||
- AUTHENTIK_EMAIL__PASSWORD | ||
|
||
Default: `""` | ||
|
||
- AUTHENTIK_EMAIL__USE_TLS | ||
|
||
Default: `false` | ||
|
||
- AUTHENTIK_EMAIL__USE_SSL | ||
|
||
Default: `false` | ||
|
||
- AUTHENTIK_EMAIL__TIMEOUT | ||
|
||
Default: `10` | ||
|
||
- AUTHENTIK_EMAIL__FROM | ||
|
||
Default: `authentik@localhost` | ||
|
||
Email address authentik will send from, should have a correct @domain | ||
|
||
## AUTHENTIK_OUTPOSTS | ||
|
||
- AUTHENTIK_OUTPOSTS__DOCKER_IMAGE_BASE | ||
|
||
This is the prefix used for authentik-managed outposts. Default: `beryju/authentik`. | ||
|
||
## AUTHENTIK_AUTHENTIK | ||
|
||
- AUTHENTIK_AUTHENTIK__AVATARS | ||
|
||
Controls which avatars are shown. Defaults to `gravatar`. Can be set to `none` to disable avatars. | ||
|
||
- AUTHENTIK_AUTHENTIK__BRANDING__TITLE | ||
|
||
Branding title used throughout the UI. Defaults to `authentik`. | ||
|
||
- AUTHENTIK_AUTHENTIK__BRANDING__LOGO | ||
|
||
Logo shown in the sidebar and flow executions. Defaults to `/static/dist/assets/icons/icon_left_brand.svg` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
title: Next | ||
--- | ||
|
||
# TBD | ||
|
||
## Upgrading | ||
|
||
This release does not introduce any new requirements. | ||
|
||
### docker-compose | ||
|
||
Download the latest docker-compose file from [here](https://raw.githubusercontent.com/BeryJu/authentik/version-2021.4/docker-compose.yml). Afterwards, simply run `docker-compose up -d` and then the standard upgrade command of `docker-compose run --rm server migrate`. | ||
|
||
### Kubernetes | ||
|
||
Run `helm repo update` and then upgrade your release with `helm upgrade passbook authentik/authentik --devel -f values.yaml`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters