Skip to content

Improve app install and config guide - #1077

Draft
JammingBen wants to merge 1 commit into
mainfrom
docs/improve-app-installation-guidelines
Draft

Improve app install and config guide#1077
JammingBen wants to merge 1 commit into
mainfrom
docs/improve-app-installation-guidelines

Conversation

@JammingBen

Copy link
Copy Markdown
Member

I think this makes it a bit more clear how to install and especially configure apps, since we often get questions about it.

@JammingBen JammingBen self-assigned this Jul 31, 2026
Copilot AI review requested due to automatic review settings July 31, 2026 06:59

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 alternative config.json example.
  • 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.yaml is 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_DIR here 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.yaml is 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_DIR here 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.yaml is 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_DIR here 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.

Comment thread docs/admin/configuration/web-applications.md
Comment thread versioned_docs/version-7.2/admin/configuration/web-applications.md
Comment thread versioned_docs/version-4.0/admin/configuration/web-applications.md
@JammingBen
JammingBen marked this pull request as draft July 31, 2026 07:11
Comment thread docs/admin/configuration/web-applications.md

@Heiko-Pohl Heiko-Pohl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants