feat(nextcloud): add optional HaRP sidecar for AppAPI support#4727
Draft
blastik wants to merge 7 commits intotruenas:masterfrom
Draft
feat(nextcloud): add optional HaRP sidecar for AppAPI support#4727blastik wants to merge 7 commits intotruenas:masterfrom
blastik wants to merge 7 commits intotruenas:masterfrom
Conversation
Add HaRP (HAProxy Reverse Proxy) as an opt-in sidecar container within the Nextcloud app, enabling Nextcloud AppAPI for External Apps (ExApps). - HaRP container with Docker socket access, configurable port and shared key - Nginx `/exapps/` reverse proxy location when HTTPS is enabled - Auto-install app_api and register HaRP deploy daemon via before-starting hook - Docker network name derived from ix_context.app_name at runtime - Security warning note when HaRP is enabled - Test values for both HTTP and HTTPS configurations - Backward compatible: disabled by default, existing installs unaffected Closes truenas#3417
The generate_metadata.py script expects all containers (including conditional ones) to appear in the labels section. HaRP was already listed in the networks enum but missing from labels.
3 tasks
Contributor
|
Due to how nextcloud works and the reliance of our side to create custom scripts to make it work, this type of additions are only accepted on the nextcloud app in the test train that utilizes our custom image. This requires changes in the https://github.com/truenas/containers repo first. Which has to handle both setup and cleanup. |
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.
Summary
Adds HaRP (HAProxy Reverse Proxy) as an opt-in sidecar container within the Nextcloud app, enabling Nextcloud AppAPI for External Apps (ExApps). This eliminates the need for users to manually deploy HaRP as a separate Custom App.
ghcr.io/nextcloud/nextcloud-appapi-harp:releasewith Docker socket access, configurable port and shared key/exapps/reverse proxy location when HTTPS/nginx is enabledbefore-startinghook auto-installsapp_apiand registers the HaRP deploy daemon viaocc app_api:daemon:register, with Docker network name derived fromix_context.app_nameFiles changed (12)
app.yamlix_values.yamlharp_image,harp_container_name,harp_portquestions.yamlharpconfig section (enabled, shared_key, port)templates/docker-compose.yamltemplates/macros/nc.jinja.conf/exapps/nginx location blocktemplates/macros/nc.jinja.shharp_daemon_registermacrotemplates/test_values/harp-values.yamltemplates/test_values/harp-https-values.yamltemplates/test_values/{basic,https,imaginary,no-cron}-values.yamlharp: enabled: falseCloses #3417
Test plan
harp-values.yaml(HTTP) — verify HaRP container and daemon registration hookharp-https-values.yaml(HTTPS) — verify nginx/exapps/location blockbasic-values.yaml— verify no HaRP artifacts when disabled