From 221e4b665c6464220a53449e0752ec3cb9a4508b Mon Sep 17 00:00:00 2001 From: Jens Langhammer Date: Fri, 12 Mar 2021 18:04:42 +0100 Subject: [PATCH] docs: add beta opt-in docs --- docker-compose.yml | 6 ++--- website/docs/installation/beta.mdx | 43 ++++++++++++++++++++++++++++++ website/docs/installation/index.md | 2 +- website/docs/releases/next.md | 17 ++++++++++++ website/sidebars.js | 1 + 5 files changed, 65 insertions(+), 4 deletions(-) create mode 100644 website/docs/installation/beta.mdx create mode 100644 website/docs/releases/next.md diff --git a/docker-compose.yml b/docker-compose.yml index d3971f525..f05eceb82 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -19,7 +19,7 @@ services: networks: - internal server: - image: beryju/authentik:${AUTHENTIK_TAG:-2021.3.3} + image: ${AUTHENTIK_IMAGE:-beryju/authentik}:${AUTHENTIK_TAG:-2021.3.3} command: server environment: AUTHENTIK_REDIS__HOST: redis @@ -47,7 +47,7 @@ services: env_file: - .env worker: - image: beryju/authentik:${AUTHENTIK_TAG:-2021.3.3} + image: ${AUTHENTIK_IMAGE:-beryju/authentik}:${AUTHENTIK_TAG:-2021.3.3} command: worker networks: - internal @@ -66,7 +66,7 @@ services: env_file: - .env static: - image: beryju/authentik-static:${AUTHENTIK_TAG:-2021.3.3} + image: ${AUTHENTIK_IMAGE_STATIC:-beryju/authentik-static}:${AUTHENTIK_TAG:-2021.3.3} networks: - internal labels: diff --git a/website/docs/installation/beta.mdx b/website/docs/installation/beta.mdx new file mode 100644 index 000000000..370d1eaf4 --- /dev/null +++ b/website/docs/installation/beta.mdx @@ -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'; + + + +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) + + +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) + + diff --git a/website/docs/installation/index.md b/website/docs/installation/index.md index b88bf106e..289e061a7 100644 --- a/website/docs/installation/index.md +++ b/website/docs/installation/index.md @@ -2,6 +2,6 @@ title: Installation --- -If you want to try out authentik, or only want a small deployment (< 100 Users), you should use [docker-compose](./docker-compose). +If you want to try out authentik, or only want a small deployment you should use [docker-compose](./docker-compose). If you want a larger deployment, or you want High-Availability, you should use [Kubernetes](./kubernetes). diff --git a/website/docs/releases/next.md b/website/docs/releases/next.md new file mode 100644 index 000000000..fd7c2463f --- /dev/null +++ b/website/docs/releases/next.md @@ -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`. diff --git a/website/sidebars.js b/website/sidebars.js index cdd53b370..7d70df6d3 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -17,6 +17,7 @@ module.exports = { "installation/docker-compose-config", "installation/reverse-proxy", "installation/kubernetes", + "installation/beta", ], }, {