Skip to content

Commit e2e1753

Browse files
committed
docs(updater): document --url option for custom download URL
Covers pinning a specific version, internal mirrors, and offline/ air-gapped use via file://. Includes --signature and --no-verify options with appropriate warnings. Warns explicitly that downgrading and skipping major versions remain unsupported regardless of --url usage. Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
1 parent d3b654c commit e2e1753

1 file changed

Lines changed: 23 additions & 8 deletions

File tree

admin_manual/maintenance/update.rst

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -239,20 +239,35 @@ To execute this, run the command with the ``--no-interaction`` option. (i.e.
239239
:alt: Terminal showing Nextcloud command line updater running in non-interactive batch mode
240240
:class: terminal-image
241241

242-
Using a custom download URL (offline / air-gapped installs)
243-
------------------------------------------------------------
242+
Using a custom download URL
243+
---------------------------
244+
245+
The ``--url`` option lets you override the archive the updater downloads.
246+
Common use cases:
247+
248+
* **Pinning a specific version** — install an exact patch release rather than
249+
whatever the update check resolves to.
250+
* **Internal mirrors** — serve the archive from a company mirror or proxy.
251+
* **Offline / air-gapped environments** — stage the archive locally and
252+
supply it via a ``file://`` URL.
253+
254+
.. warning::
255+
The normal update rules still apply when using ``--url``:
256+
257+
* **Downgrading is not supported** and risks data corruption.
258+
* **Skipping major versions is not supported.** You must update one major
259+
version at a time (e.g. 28 → 29 → 30, not 28 → 30).
260+
261+
Passing ``--url`` does not bypass these constraints.
244262

245-
By default the updater fetches the Nextcloud release archive from the official
246-
download servers. In environments without internet access — or when you want to
247-
serve the archive from an internal mirror — you can point the updater at any
248-
HTTP/HTTPS URL with the ``--url`` option:
263+
Point the updater at any HTTP/HTTPS URL:
249264

250265
.. code-block:: bash
251266
252267
sudo -E -u www-data php /var/www/nextcloud/updater/updater.phar \
253268
--url https://mirror.example.com/nextcloud-30.0.0.tar.bz2
254269
255-
For local file access you can use a ``file://`` URL:
270+
For a locally staged archive, use a ``file://`` URL:
256271

257272
.. code-block:: bash
258273
@@ -292,7 +307,7 @@ automatically. You have two options:
292307
when the archive comes from a fully trusted, controlled source.
293308

294309
These options can be combined with ``--no-interaction`` for fully automated
295-
offline update runs:
310+
runs:
296311

297312
.. code-block:: bash
298313

0 commit comments

Comments
 (0)