Improve app install and config guide - #1077
Draft
JammingBen wants to merge 1 commit into
Draft
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Clarifies the OpenCloud Web Apps admin documentation around where to install web apps and how to provide app-specific configuration (including a recommended global apps.yaml approach).
Changes:
- Rewords the “Extract and copy” section to describe the app installation directory and opencloud-compose placement.
- Adds a recommended configuration method using
apps.yaml, plus an alternativeconfig.jsonexample. - Applies the same documentation updates across the unversioned docs and two versioned doc sets (4.0 and 7.2).
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/admin/configuration/web-applications.md | Updates installation path guidance and adds apps.yaml-based configuration example. |
| versioned_docs/version-7.2/admin/configuration/web-applications.md | Mirrors the same install/config documentation improvements for v7.2 docs. |
| versioned_docs/version-4.0/admin/configuration/web-applications.md | Mirrors the same install/config documentation improvements for v4.0 docs. |
Suppressed comments (3)
docs/admin/configuration/web-applications.md:51
apps.yamlis documented elsewhere as living under the base data path ($OC_BASE_DATA_PATH/config/apps.yaml), not under$OC_CONFIG_DIR/apps.yaml. Pointing to$OC_CONFIG_DIRhere is likely incorrect and will send admins to the wrong directory.
The recommended way to configure such apps is via the `apps.yaml` configuration file located under `$OC_CONFIG_DIR/apps.yaml`. That way, you ensure a consistent config that doesn't get overwritten when updating apps.
versioned_docs/version-7.2/admin/configuration/web-applications.md:51
apps.yamlis documented elsewhere as living under the base data path ($OC_BASE_DATA_PATH/config/apps.yaml), not under$OC_CONFIG_DIR/apps.yaml. Pointing to$OC_CONFIG_DIRhere is likely incorrect and will send admins to the wrong directory.
The recommended way to configure such apps is via the `apps.yaml` configuration file located under `$OC_CONFIG_DIR/apps.yaml`. That way, you ensure a consistent config that doesn't get overwritten when updating apps.
versioned_docs/version-4.0/admin/configuration/web-applications.md:51
apps.yamlis documented elsewhere as living under the base data path ($OC_BASE_DATA_PATH/config/apps.yaml), not under$OC_CONFIG_DIR/apps.yaml. Pointing to$OC_CONFIG_DIRhere is likely incorrect and will send admins to the wrong directory.
The recommended way to configure such apps is via the `apps.yaml` configuration file located under `$OC_CONFIG_DIR/apps.yaml`. That way, you ensure a consistent config that doesn't get overwritten when updating apps.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
JammingBen
marked this pull request as draft
July 31, 2026 07:11
JammingBen
commented
Jul 31, 2026
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.
I think this makes it a bit more clear how to install and especially configure apps, since we often get questions about it.