diff --git a/docsite/docs/releases/v2.0.0.md b/docsite/docs/releases/v2.0.0.md index 476f5e905..0cf433f87 100644 --- a/docsite/docs/releases/v2.0.0.md +++ b/docsite/docs/releases/v2.0.0.md @@ -15,6 +15,12 @@ Komodo v2 is a major release with significant architectural changes and new feat - **Multi-login Linking**: Users can now link multiple login providers (Local, OIDC, Github, etc) to their account. - **Full OpenAPI documentation**: Interactive API docs [now available](https://demo.komo.do/docs). +### 🚨 Breaking + +- **Debian Bullseye EOL**: Bullseye stopped recieving security updates in 2024 and is slated to be EOL. The binaries are now built with Debian Bookworm which uses openssl v3, +and Periphery may have compatibility issues running on systems running **openssl v1** including **Debian Bullseye / Ubuntu 20.04 and before**. You can still compile Periphery +yourself for these systems if needed (or use containerized periphery), but the official distribution will use the more secure and up-to-date option. + ## Upgrading to Komodo v2 Komodo v2 introduces a new connection and authentication method between Komodo Core and the Periphery agents running on your Servers. Find more information on [Komodo v2 here](../releases/v2.0.0). @@ -51,15 +57,32 @@ volumes: ``` :::warning -Ensure the Komodo Core service includes `init: true`, as shown above. -Failing to do so may cause a build up of zombie processes, and it wasn't -included in earlier releases example compose file. +Ensure the Komodo Core service **and** all Periphery services / containers include `init: true`, +as shown above. Failing to do so may cause a build up of zombie processes, +and it wasn't included in earlier releases example compose file. ::: -#### Upgrade Periphery +#### Upgrade Periphery: Container + +If you are running Komodo Periphery in a container, you also need the `:2` tag for the image, +and the keys will default to being stored in `/config/keys`. + +```yaml +services: + periphery: + image: ghcr.io/moghtech/komodo-periphery:2 + init: true # This should be added regardless of version + volumes: + - keys:/config/keys + - (...unchanged) + (...unchanged) + +volumes: + keys: + (...unchanged) +``` -If you are running Komodo Periphery in a container, you also need the `:2` tag for the image, and the **keys will default to being stored in `$PERIPHERY_ROOT_DIRECTORY/keys` which should already be mounted**. -Still, if running Periphery in container, **ensure you see the private / public keys in the key directory**, you may need to add a mount if you customized mount directories. +#### Upgrade Periphery: Systemd Systemd Periphery users just need to update their Periphery binary version. The keys will be stored in your `root_directory` (default: `/etc/komodo/keys`). diff --git a/docsite/static/CNAME b/docsite/static/CNAME new file mode 100644 index 000000000..f036cbbbc --- /dev/null +++ b/docsite/static/CNAME @@ -0,0 +1 @@ +komo.do