Skip to content
This repository was archived by the owner on Aug 19, 2026. It is now read-only.

Commit e12fd44

Browse files
docs: require explicit docker image versions (#1577)
* docs: require explicit docker image versions Every documented image reference now carries an explicit version tag and the `latest` tag is no longer offered as an option. `owncloud/server:latest` does not necessarily point to the release line documented on this branch, so a container restart can silently pull a different version. The docker page uses a literal `docker-image-version` page attribute rather than one of the global `-version` attributes: those track the latest release of the product, which is not this branch, so interpolating them here would document an image that does not belong to this release line. Also pin the selenium and inbucket images in the UI testing guide, matching the chrome pins the page already carries for owncloud/core#35444. Signed-off-by: Thomas Müller <1005065+DeepDiver1975@users.noreply.github.com> * docs: fix Useful Pages xrefs into the latest server version The page deliberately links into the *latest* server version rather than this branch, but it used this branch's page paths. The 11.0 release is docker-only and reorganized accordingly: `installation/index.adoc` (manual installation) is gone, the docker page moved from `installation/docker/index.adoc` to `installation/installing_with_docker.adoc`, and `maintenance/manual_upgrade.adoc` moved under `maintenance/upgrading/`. Three of the five links therefore break as soon as `latest-server-version` advances to 11.0, which fails the aggregated site build. Point them at the paths that exist there and drop the manual installation entry, which has no 11.0 equivalent. Signed-off-by: Thomas Müller <1005065+DeepDiver1975@users.noreply.github.com> * revert(docs): unpin the third-party docker images again The explicit-version requirement is about `owncloud/server` only: its `latest` tag does not track the release line documented here and there are no rolling major or minor tags, so following it installs a version the docs do not describe. That reasoning does not carry over to the selenium and inbucket images used by the UI test setup. Pinning them fixes no documented-version mismatch and only adds pins that nothing in this repo keeps current, so restore them to their previous untagged form. The two `standalone-chrome*` pins stay, they predate this and exist because of owncloud/core#35444. Signed-off-by: Thomas Müller <1005065+DeepDiver1975@users.noreply.github.com> --------- Signed-off-by: Thomas Müller <1005065+DeepDiver1975@users.noreply.github.com>
1 parent 4c6aee9 commit e12fd44

2 files changed

Lines changed: 17 additions & 8 deletions

File tree

modules/admin_manual/pages/installation/docker/index.adoc

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55
:linux-server-doc-url: https://docs.linuxserver.io/faq
66
:docker-compose-build-url: https://docs.docker.com/compose/compose-file/build/
77
:description: ownCloud can be installed using the official ownCloud Docker image.
8+
// the image version documented on this branch. this is intentionally a literal
9+
// and not an attribute, because the global -version attributes track the latest
10+
// release of the product and not this branch.
11+
:docker-image-version: 10.15.3
812

913
== Introduction
1014

@@ -48,10 +52,10 @@ For testing purposes or a quick hands-on to get familiar with the look and feel,
4852

4953
[source,docker,subs="attributes+"]
5054
----
51-
docker run --rm --name oc-eval -d -p{std-port-http}:{std-port-http} owncloud/server
55+
docker run --rm --name oc-eval -d -p{std-port-http}:{std-port-http} owncloud/server:{docker-image-version}
5256
----
5357

54-
This starts a docker container with the name "oc-eval" in the background (option `-d`). `owncloud/server` is the docker image downloaded from Docker Hub. If you don't start the container with option `-d`, the logs will be displayed in the shell. If you are running it in the background as in the example above, you can display the logs with the command:
58+
This starts a docker container with the name "oc-eval" in the background (option `-d`). `owncloud/server:{docker-image-version}` is the docker image downloaded from Docker Hub. Always name an explicit version tag, see the note on the `OWNCLOUD_VERSION` setting below. If you don't start the container with option `-d`, the logs will be displayed in the shell. If you are running it in the background as in the example above, you can display the logs with the command:
5559

5660
[source,docker]
5761
----
@@ -115,7 +119,7 @@ include::example$installation/docker/docker-compose.yml[]
115119
[source,bash,subs="attributes+"]
116120
----
117121
cat << EOF > .env
118-
OWNCLOUD_VERSION={latest-server-version}
122+
OWNCLOUD_VERSION={docker-image-version}
119123
OWNCLOUD_DOMAIN=localhost:{std-port-http}
120124
OWNCLOUD_TRUSTED_DOMAINS=localhost
121125
ADMIN_USERNAME=admin
@@ -133,8 +137,9 @@ Only a few settings are required, these are:
133137
| Example
134138

135139
| `OWNCLOUD_VERSION`
136-
| The ownCloud version
137-
| `latest`
140+
| The ownCloud version. +
141+
Always use an explicit version, never `latest`.
142+
| `{docker-image-version}`
138143

139144
| `OWNCLOUD_DOMAIN`
140145
| The ownCloud domain
@@ -157,6 +162,8 @@ Only a few settings are required, these are:
157162
| `{std-port-http}`
158163
|===
159164

165+
NOTE: Pin `OWNCLOUD_VERSION` to a full version like `{docker-image-version}`. Do not use the `latest` tag: it does not necessarily point to the release line documented here, so a container restart can pull a different version than you expect.
166+
160167
NOTE: `ADMIN_USERNAME` and `ADMIN_PASSWORD` will not change between deploys even if you change the
161168
values in the .env file. To change them, you'll need to do `docker volume prune`, which
162169
*will delete all your data*.

modules/admin_manual/pages/useful_pages.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@
1111

1212
Note that this section always points to the latest server version available. In case you need a different version, select your topic and manually switch to one of the available ones.
1313

14-
* xref:{latest-server-version}@server:admin_manual:installation/index.adoc[Manual Installation]
15-
* xref:{latest-server-version}@server:admin_manual:installation/docker/index.adoc[Installation with Docker]
14+
// note that these targets must use the page paths of the *latest* server
15+
// version, not this branch's: the latest version is a docker-only release and
16+
// has reorganized its installation and upgrading pages accordingly.
17+
* xref:{latest-server-version}@server:admin_manual:installation/installing_with_docker.adoc[Installation with Docker]
1618
* xref:{latest-server-version}@server:admin_manual:configuration/server/occ_command.adoc[OCC Commands]
1719
* xref:{latest-server-version}@server:admin_manual:configuration/server/caching_configuration.adoc#small-organization-single-server-setup[File Locking and Caching Configuration]
18-
* xref:{latest-server-version}@server:admin_manual:maintenance/manual_upgrade.adoc[Manual Upgrade]
20+
* xref:{latest-server-version}@server:admin_manual:maintenance/upgrading/manual_upgrade.adoc[Manual Upgrade]

0 commit comments

Comments
 (0)