Skip to content

docs: require explicit docker image versions #1577

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kw-tmueller merged 3 commits into from
Jul 31, 2026
+17 −8
Merged

docs: require explicit docker image versions #1577

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d03f6dc
docs: require explicit docker image versions
DeepDiver1975 Jul 30, 2026
1a9e4e5
docs: fix Useful Pages xrefs into the latest server version
DeepDiver1975 Jul 30, 2026
1b342ba
revert(docs): unpin the third-party docker images again
DeepDiver1975 Jul 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions modules/admin_manual/pages/installation/docker/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
:linux-server-doc-url: https://docs.linuxserver.io/faq
:docker-compose-build-url: https://docs.docker.com/compose/compose-file/build/
:description: ownCloud can be installed using the official ownCloud Docker image.
// the image version documented on this branch. this is intentionally a literal
// and not an attribute, because the global -version attributes track the latest
// release of the product and not this branch.
:docker-image-version: 10.15.3

== Introduction

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

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

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:
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:

[source,docker]
----
Expand Down Expand Up @@ -115,7 +119,7 @@ include::example$installation/docker/docker-compose.yml[]
[source,bash,subs="attributes+"]
----
cat << EOF > .env
OWNCLOUD_VERSION={latest-server-version}
OWNCLOUD_VERSION={docker-image-version}
OWNCLOUD_DOMAIN=localhost:{std-port-http}
OWNCLOUD_TRUSTED_DOMAINS=localhost
ADMIN_USERNAME=admin
Expand All @@ -133,8 +137,9 @@ Only a few settings are required, these are:
| Example

| `OWNCLOUD_VERSION`
| The ownCloud version
| `latest`
| The ownCloud version. +
Always use an explicit version, never `latest`.
| `{docker-image-version}`

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

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.

NOTE: `ADMIN_USERNAME` and `ADMIN_PASSWORD` will not change between deploys even if you change the
values in the .env file. To change them, you'll need to do `docker volume prune`, which
*will delete all your data*.
Expand Down
8 changes: 5 additions & 3 deletions modules/admin_manual/pages/useful_pages.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,10 @@

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.

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