Repository navigation
docs: shorten the README - #153
Conversation
Signed-off-by: Oleksandr Piskun <oleksandr2088@icloud.com>
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 39 minutes. View limit details
Walkthrough
Priority: Merge Risk:
 |
| Check name | Status | Explanation |
|---|---|---|
| Title check |  |
The title "docs: shorten the README" matches the main change. The README is reduced from about 7,400 words to about 4,000 by moving repeated admin and developer manual content into links. The raw summ… |
| Description check | |
The description states the PR's purpose: the README grew to about 7,400 words, and repeated admin and developer manual content was cut to about 4,000 words. It lists the retained sections, the upgrade… |
| Docstring Coverage | |
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within survi… |
| Linked Issues check | |
Check skipped because no linked issues were found for this pull request. |
| Out of Scope Changes check | |
Check skipped because no linked issues were found for this pull request. |
Full details: Title check
-
Explanation
The title "docs: shorten the README" matches the main change. The README is reduced from about 7,400 words to about 4,000 by moving repeated admin and developer manual content into links. The raw summary confirms the README was reorganized into shorter sections. The title is specific and concise and follows a conventional commit prefix.
Full details: Description check
-
Explanation
The description states the PR's purpose: the README grew to about 7,400 words, and repeated admin and developer manual content was cut to about 4,000 words. It lists the retained sections, the upgrade-note changes, and several corrections. These match the raw summary, which reports reorganized setup guidance, removed deployment examples, and removed Kubernetes RBAC explanations and ExApp integration instructions.
Full details: Docstring Coverage
-
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
-
-
- Source mode: Auto
- Repository: Unavailable
- Branch: Unavailable
- File: No configuration file from this repository applied
- Commit: Unavailable
- Layers: Organization UI
- Review profile: CHILL
- Plan: Advanced
- Run ID:
1d080be0-3e35-4994-bf47-9ab1fbf8a12b
-
README.md
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.
-
Signed-off-by: Oleksandr Piskun <oleksandr2088@icloud.com>
| docker build -t nextcloud-appapi-harp:local . | ||
| ``` | ||
|
|
||
| ### Deploy HaRP Using the Locally Built Image | ||
|
|
||
| ```bash | ||
| docker run \ | ||
| -e HP_SHARED_KEY="some_very_secure_password" \ | ||
| -e NC_INSTANCE_URL="http://nextcloud.local" \ | ||
| -e HP_LOG_LEVEL="debug" \ | ||
| -e HP_VERBOSE_START="1" \ |
There was a problem hiding this comment.
maybe good to leave the verbose start on since it's a local setup
| 1. **Install HaRP** on the same Docker Engine that you were using for DSP. | ||
| 2. **Test Deployment on HaRP** with usual `TestDeploy` button. | ||
| 3. **Set HaRP as the default deployment daemon** for ExApps. | ||
| 4. **Remove the ExApps without deleting their data volumes**: | ||
| - **Terminal**: Do not use the `--rm-data` option when removing the app. | ||
| - **From UI**: Do not use the "Delete data when removing" checkbox. | ||
| 5. **Install the ExApp**: Install removed ExApps, now they will be installed on `HaRP`. | ||
| 6. **Remove DSP**: Now DSP (Docker Socket Proxy) can be safely removed. | ||
| 1. Install HaRP on the Docker Engine that DSP uses, and check it with "Test deploy". | ||
| 2. Set HaRP as the default deploy daemon. | ||
| 3. Remove the ExApps but keep their data: no `--rm-data` in the terminal, no "Delete data when removing" in the web interface. | ||
| 4. Install the ExApps again; they are now deployed through HaRP. | ||
| 5. Remove DSP. |
There was a problem hiding this comment.
previous instructions looked better I think
| The developer manual describes how to [adapt an ExApp to HaRP](https://docs.nextcloud.com/server/latest/developer_manual/exapp_development/development_overview/ExAppHarpIntegration.html): the `start.sh` entrypoint from `exapps_dev` and the FRP client in the image. DSP is deprecated and will be removed in Nextcloud 35; an ExApp with HaRP support still works with DSP, so one release serves both. For the routes in your `info.xml`: | ||
|
|
||
| ## Nextcloud 32: Migrating Existing ExApps from DSP to HaRP | ||
| 1. List in the `<verb>` of each route every HTTP method it serves, e.g. `GET,POST`. The first route whose URL and verb match a request decides its access level, `HEAD` is allowed wherever `GET` is, and a method that no route of the path lists gets `405 Method Not Allowed`. HaRP 0.4.7 and older, and HaRP with an AppAPI that does not send the verbs, match by URL only, so use different URLs where methods need different access levels. |
There was a problem hiding this comment.
and HaRP with an AppAPI that does not send the verbs
maybe AppAPI's version can be listed here too
There was a problem hiding this comment.
Added in #155: AppAPI sends them from Nextcloud 33.0.11, 34.0.6 and 35.0.3.
The README had grown to about 7,400 words. Large parts repeated the Nextcloud admin manual (the three-host deployment, the daemon registration and its tests) and the developer manual (the ExApp
start.shand FRP steps), and the upgrade notes of 0.4.6 repeated its release notes. It is now about 4,000 words.Changes
HP_SHARED_KEYandHP_EXAPP_BIND_MOUNTS_*keep the recovery steps and link to the 0.4.6 release notes.^/x(/.*)?$also covers/x.bruteforce_protection;HP_SHARED_KEYmay not contain"or\; a fixed--k8s_upstream_hostskips the node lookup only when an ExApp is exposed; the Cloudflare route isexapps/*.