Skip to content

Commit fc5d2fe

Browse files
ildyriad7415
andauthored
Improve docs (#122)
--------- Co-authored-by: Martin Stone <[email protected]>
1 parent 308b1f3 commit fc5d2fe

File tree

2 files changed

+45
-2
lines changed

2 files changed

+45
-2
lines changed

docs/docker.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@ The following tags are available:
66

77
* `latest`: Latest Lychee release
88
* `v[NUMBER]`: Stable version tag for a Lychee release
9-
* `dev`: Current master branch tag (Lychee operates on a stable master, so this should usually be safe)
9+
* `nightly` (also `dev`): Current master branch tag (Lychee operates on a stable master, so this should usually be safe)
10+
* `devtools`: Same as `nightly`, but includes development dependencies (e.g. api docs, debug bar)
11+
* `alpha`: Current alpha branch tag (The alpha branch contains bleeding edge changes that are not peer-reviewed)
12+
* `alpha-devtools`: Same as `alpha`, but includes development dependencies (e.g. api docs, debug bar)
1013
* `testing`: Tag for testing new branches and pull requests. Designed for internal use by LycheeOrg.
1114

12-
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.
1315

1416
## Setup
1517

docs/update.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,47 @@ If you have the `post-merge` hook set up the following is enough:
3232
git pull
3333
```
3434

35+
## Using Docker compose
36+
37+
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.
38+
39+
> {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.
40+
41+
#### With Rolling update tag
42+
43+
This procedure is for those following one of those tags:
44+
45+
- `latest` &mdash; the last official release
46+
- `nightly` or `dev` &mdash; the last build from the `master` branch (peer reviewed)
47+
- `alpha` &mdash; the last build from the `alpha` branch (no peer review)
48+
49+
Simply run the following.
50+
```bash
51+
docker compose down
52+
docker compose pull
53+
docker compose up -d
54+
```
55+
56+
The database migrations will be applied automatically.
57+
58+
#### With version tag.
59+
60+
First edit your `docker-compose.yml` to point to the version you would like to migrate to.
61+
62+
```diff
63+
- image: lycheeorg/lychee:v5.1.0
64+
+ image: lycheeorg/lychee:v5.1.2
65+
```
66+
67+
Save and run the following.
68+
```bash
69+
docker compose down
70+
docker compose pull
71+
docker compose up -d
72+
```
73+
74+
The migration will be applied automatically and you should be running the requested tagged version.
75+
3576
## Update manually
3677

3778
This update will be the one you have to use if you are following the Release channel.

0 commit comments

Comments
 (0)