Skip to content

Commit

Permalink
Improve docs (#122)
Browse files Browse the repository at this point in the history
---------

Co-authored-by: Martin Stone <[email protected]>
  • Loading branch information
ildyria and d7415 authored Feb 15, 2024
1 parent 308b1f3 commit fc5d2fe
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
41 changes: 41 additions & 0 deletions docs/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -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` &mdash; the last official release
- `nightly` or `dev` &mdash; the last build from the `master` branch (peer reviewed)
- `alpha` &mdash; 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.
Expand Down

0 comments on commit fc5d2fe

Please sign in to comment.