diff --git a/docs/docker.md b/docs/docker.md index 0dd3f33c..9a2c0892 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -6,10 +6,12 @@ The following tags are available: * `latest`: Latest Lychee release * `v[NUMBER]`: Stable version tag for a Lychee release -* `dev`: Current master branch tag (Lychee operates on a stable master, so this should usually be safe) +* `nightly` (also `dev`): Current master branch tag (Lychee operates on a stable master, so this should usually be safe) +* `devtools`: Same as `nightly`, but includes development dependencies (e.g. api docs, debug bar) +* `alpha`: Current alpha branch tag (The alpha branch contains bleeding edge changes that are not peer-reviewed) +* `alpha-devtools`: Same as `alpha`, but includes development dependencies (e.g. api docs, debug bar) * `testing`: Tag for testing new branches and pull requests. Designed for internal use by LycheeOrg. -Note that only the `:dev` tag is available for armv6 and armv7 systems. This is due to an issue with the build environment and is hopefully temporary. ## Setup diff --git a/docs/update.md b/docs/update.md index 121d4acf..d54a3448 100644 --- a/docs/update.md +++ b/docs/update.md @@ -32,6 +32,47 @@ If you have the `post-merge` hook set up the following is enough: git pull ``` +## Using Docker compose + +There are two cases. Either you are pinned to a release tag, _e.g._ v5.1.2 or you are using a rolling update tag. + +> {tip} When using docker, a version rollback is difficult to apply: it requires to bash into the container to run the required migrate commands on the new version before dropping the tag to the previous value. + +#### With Rolling update tag + +This procedure is for those following one of those tags: + +- `latest` — the last official release +- `nightly` or `dev` — the last build from the `master` branch (peer reviewed) +- `alpha` — the last build from the `alpha` branch (no peer review) + +Simply run the following. +```bash +docker compose down +docker compose pull +docker compose up -d +``` + +The database migrations will be applied automatically. + +#### With version tag. + +First edit your `docker-compose.yml` to point to the version you would like to migrate to. + +```diff +- image: lycheeorg/lychee:v5.1.0 ++ image: lycheeorg/lychee:v5.1.2 +``` + +Save and run the following. +```bash +docker compose down +docker compose pull +docker compose up -d +``` + +The migration will be applied automatically and you should be running the requested tagged version. + ## Update manually This update will be the one you have to use if you are following the Release channel.