fix(exapps): correct errors in 3-host HaRP deployment section#14676
Merged
Conversation
…dd docker-engine-port note Agent-Logs-Url: https://github.com/nextcloud/documentation/sessions/f5612a35-41f3-4e7c-8a09-7e43a1ea0bc5 Co-authored-by: nextcloud-command <88102737+nextcloud-command@users.noreply.github.com>
Member
|
@manik0u, do you mind having a quick look at those tiny improvements I asked copilot to do ? |
Copilot
AI
changed the title
[WIP] Fix errors in 3-host deployment diagram
fix(exapps): correct errors in 3-host HaRP deployment section
Apr 29, 2026
skjnldsv
approved these changes
Apr 29, 2026
Contributor
Member
|
/backport to stable33 please |
Member
|
/backport to stable32 please |
|
The backport to # Switch to the target branch and update it
git checkout stable33
git pull origin stable33
# Create the new backport branch
git checkout -b backport/14676/stable33
# Cherry pick the change from the commit sha1 of the change against the default branch
# This might cause conflicts, resolve them
git cherry-pick 54985095 3b4225ba
# Push the cherry pick commit to the remote repository and open a pull request
git push origin backport/14676/stable33Error: Failed to check for changes with origin/stable33: No changes found in backport branch Learn more about backports at https://docs.nextcloud.com/server/stable/go.php?to=developer-backports. |
|
The backport to # Switch to the target branch and update it
git checkout stable32
git pull origin stable32
# Create the new backport branch
git checkout -b backport/14676/stable32
# Cherry pick the change from the commit sha1 of the change against the default branch
# This might cause conflicts, resolve them
git cherry-pick 54985095 3b4225ba
# Push the cherry pick commit to the remote repository and open a pull request
git push origin backport/14676/stable32Error: Failed to check for changes with origin/stable32: No changes found in backport branch Learn more about backports at https://docs.nextcloud.com/server/stable/go.php?to=developer-backports. |
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
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.
Four errors introduced in the 3-host HaRP deployment section of
DeployConfigurations.rst.Changes:
DockerSocketProxyreplaced withHaRPin the Host2 state; the original diagram was contradicted by the actualdocker runcommand which mounts/var/run/docker.sockdirectly into HaRP, no socket proxy involvedmkdirbrace expansion artifact —mkdir -p /some/path/{certs,}→mkdir -p /some/path/certs; trailing comma silently created a duplicate pathHP_TRUSTED_PROXY_IPSplaceholder clarity — added inline comment flagging192.168.0.0/24as a value that must be replaced, not copied verbatimdocker-engine-port: 24000— added a.. note::before the testcurlcommands explaining that this header is HaRP's internal virtual port routing mechanism and24000is the default for a directly-mounted socket, requiring no extra firewall rules☑️ Resolves
🖼️ Screenshots
N/A — no visual/layout changes.
✅ Checklist
codespellor similar and addressed any spelling issuesOriginal prompt
Problem
PR #13992 added a new section to
admin_manual/exapps_management/DeployConfigurations.rstdocumenting a 3-host deployment (Nextcloud / Apache Reverse Proxy / Docker+HaRP). Several errors were introduced that need to be fixed.File to change
admin_manual/exapps_management/DeployConfigurations.rstThe section to fix is: "Docker / Reverse Proxy / Nextcloud on 3 independent hosts - with HaRP container" (starting around line 182).
Fix 1 — Mermaid diagram contradicts actual setup
The diagram in the new section shows
DockerSocketProxyinside Host2 managing containers. However, the actualdocker runcommand mounts/var/run/docker.sockdirectly into the HaRP container — no DockerSocketProxy is involved. The diagram is misleading.Change: Replace all occurrences of
DockerSocketProxyin the Host2 state diagram withHaRPto accurately reflect the architecture.Current diagram (Host2 state):
Should become:
Fix 2 — Broken
mkdirbrace expansionCurrent:
mkdir -p /some/path/{certs,}The trailing comma in
{certs,}expands to bothcertsand an empty string, creating/some/path/(which already exists) alongside/some/path/certs. This is a copy-paste artifact.Change: Simplify to:
Fix 3 —
HP_TRUSTED_PROXY_IPSlooks like a real value, not a placeholderCurrent:
-e HP_TRUSTED_PROXY_IPS="192.168.0.0/24" \This specific subnet looks like a real network address, not clearly a placeholder. Readers may copy it verbatim without adapting it to their network.
Change: Add an inline comment to clarify it must be customised:
Fix 4 —
docker-engine-port: 24000is unexplainedThe test
curlcommands include this header:-H "docker-engine-port: 24000" \But port
24000is never mentioned or configured anywhere in the setup steps, leaving readers confused about where it comes from.Change: Add a short note before the curl test commands explaining what this header is and where
24000comes from. In this setup, HaRP mounts the Docker socket directly;docker-engine-porttells HaRP which internal virtual port to use for the locally-mounted Docker socket. The value24000is HaRP's default virtual port for a directly-mounted socket. Example note to add:Summary of all changes
DockerSocketProxyshown but HaRP mounts raw socketDockerSocketProxywithHaRPin diagram{certs,}brace expansion artifactmkdir -p /some/path/certsHP_TRUSTED_PROXY_IPSlooks like a real subnetdocker-engine-port: 24000unexplained.. note::before the curl commands explaining the headerThe following is the prior conversation context from the user's chat exploration (may be truncated):
User: Can you review @nextcloud/documentation/pull/13992 ?
Assistant: Here's my review of PR #13992:
📋 PR Summary
admin_manual/exapps_management/DeployConfigurations.rst)🔍 Core Changes
This PR adds a new section to
DeployConfigurations.rstdocumenting a 3-host deployment scenario for Nextcloud with HaRP (the AppAPI reverse proxy), specifically covering the case where:This pull request was created from Copilot chat.