docs(updater): document --url option for offline/air-gapped installs#14846
Merged
Conversation
Covers --url (HTTP/HTTPS and file://), --signature for providing a base64 archive signature, --no-verify as escape hatch, and combining all three with --no-interaction for automated runs. Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
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>
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
Contributor
📖 Documentation Preview📄 1 changed documentation pageLast updated: Wed, 20 May 2026 06:49:45 GMT |
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
skjnldsv
force-pushed
the
docs/updater-url-option
branch
from
1b405c3 to
dc0413e
Compare
Altahrim
approved these changes
May 20, 2026
- Remove -E from all sudo commands throughout the file; the flag preserves the calling user's environment variables, which is not needed and can mask permission issues - Update --no-verify description: add "or if you have already verified the archive yourself" and include a sha512sum example - Move the warning inside the --no-verify bullet so it is scoped to that option rather than floating after the whole block Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
☑️ Resolves
Relates to the
--urloption added toupdater.phar.What changed and why
Adds a new section "Using a custom download URL (offline / air-gapped installs)" to
admin_manual/maintenance/update.rst.The
updater.pharsupports a--urloption that lets admins point the updater at any HTTP/HTTPS orfile://URL instead of the official download servers. This is useful for:The section covers:
--urlwith HTTP/HTTPS mirror example--urlwithfile://for locally staged archives--signatureto supply the base64 archive signature when using a custom URL--no-verifyas an escape hatch (with a warning)--no-interactionexample for fully automated offline runs✅ Checklist
codespellor similar and addressed any spelling issues