Files
authentik/website/docs/releases/_template.md
Tana M Berry 8f69d0962a website/docs: new upgrade page (#10742)
* first draft

* add to sidebar

* made mdx

* diff image add troubleshoting

* Optimised images with calibre/image-actions

* tweaks

* edits from review

* more review edits, tweaks

* tab fights

* still fighting tabs

* add link from Rel Note template

* more syntax fights

* i give up

* git hates me

* no comment

* formatting

* styling stuff

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* merge conflict

* add Jens' edits

* fighting my rebase

* tweak

* added note on Rel Note template about versions must match

* git hates me even more today than yesterday

* tweak

---------

Signed-off-by: Jens Langhammer <jens@goauthentik.io>
Co-authored-by: Tana M Berry <tana@goauthentik.com>
Co-authored-by: authentik-automation[bot] <135050075+authentik-automation[bot]@users.noreply.github.com>
Co-authored-by: Jens Langhammer <jens@goauthentik.io>
2024-08-08 08:40:20 -05:00

51 lines
1.7 KiB
Markdown

---
title: Release xxxx.x
slug: "/releases/xxxx.x"
---
:::::note
xxxx.x has not been released yet! We're publishing these release notes as a preview of what's to come, and for our awesome beta testers trying out release candidates.
To try out the release candidate, replace your Docker image tag with the latest release candidate number, such as xxxx.x.0-rc1. You can find the latest one in [the latest releases on GitHub](https://github.com/goauthentik/authentik/releases). If you don't find any, it means we haven't released one yet.
:::::
<!-- ## Breaking changes -->
## New features
## Upgrading
This release does not introduce any new requirements. You can follow the upgrade instructions below; for more detailed information about upgrading authentik, refer to our [Upgrade documentation](../installation/upgrade.mdx).
:::warning
When you upgrade, be aware that the version of the authentik instance and of any outposts must be the same. We recommended that you always upgrade any outposts at the same time you upgrade your authentik instance.
:::
### Docker Compose
To upgrade, download the new docker-compose file and update the Docker stack with the new version, using these commands:
```shell
wget -O docker-compose.yml https://goauthentik.io/version/xxxx.x/docker-compose.yml
docker compose up -d
```
The `-O` flag retains the downloaded file's name, overwriting any existing local file with the same name.
### Kubernetes
Upgrade the Helm Chart to the new version, using the following commands:
```shell
helm repo update
helm upgrade authentik authentik/authentik -f values.yaml --version ^xxxx.x
```
## Minor changes/fixes
<!-- _Insert the output of `make gen-changelog` here_ -->
## API Changes
<!-- _Insert output of `make gen-diff` here_ -->