docs(ospo): community health rollout v2 — README, agents.md, health files #601
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # Code of Conduct | ||
|
|
||
| This project follows the ownCloud Code of Conduct. | ||
|
|
||
| Please read the full Code of Conduct at: | ||
| **<https://owncloud.com/contribute/code-of-conduct/>** | ||
|
|
||
| By participating in this project, you agree to abide by its terms. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,9 @@ | ||
| # Contributing | ||
|
|
||
| Thank you for your interest in contributing to this project! | ||
|
|
||
| Please read the full contributing guidelines at: | ||
| **<https://owncloud.com/contribute/>** | ||
|
|
||
| For development setup, coding standards, and pull request process, | ||
| see the README in this repository. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,81 +1,138 @@ | ||
| # Richdocuments (Collabora Online for ownCloud) | ||
|
|
||
| <!-- OSPO-managed README | Generated: 2026-04-16 | v2 --> | ||
|
|
||
| [](LICENSE) [](https://kiteworks.com/opensource) [](https://hub.docker.com/r/owncloud/server) | ||
|
|
||
| Richdocuments integrates Collabora Online with ownCloud Server, enabling real-time collaborative editing of documents, spreadsheets and presentations directly within the ownCloud web interface. The app uses the WOPI (Web Application Open Platform Interface) protocol to bridge ownCloud's file storage with the Collabora Online document editing server. | ||
|
|
||
| ## Part of Classic (OC10) | ||
|
|
||
| This app is part of the [ownCloud Server (OC10)](https://github.com/owncloud/core) ecosystem, providing online document editing capabilities through the Collabora Online integration. It is available on the [ownCloud Marketplace](https://marketplace.owncloud.com/apps/richdocuments). | ||
|
|
||
| The ownCloud Server is available on [Docker Hub](https://hub.docker.com/r/owncloud/server). | ||
|
|
||
| ## Getting Started | ||
|
|
||
| Follow the steps below to install and configure Collabora Online integration. | ||
|
|
||
| ### Installation | ||
|
|
||
| Install from the [ownCloud Marketplace](https://marketplace.owncloud.com/apps/richdocuments), or manually: | ||
|
|
||
| ```bash | ||
| cd apps | ||
| git clone https://github.com/owncloud/richdocuments.git | ||
| php occ app:enable richdocuments | ||
| ``` | ||
|
|
||
| ### Configuration | ||
|
|
||
| Set the WOPI server URL: | ||
|
|
||
| ```bash | ||
| occ config:app:set richdocuments wopi_url --value [your-host-public-ip]:8098 | ||
| ``` | ||
|
|
||
| Enable Secure View: | ||
|
|
||
| ```bash | ||
| occ config:app:set richdocuments secure_view_option --value true | ||
| occ config:app:set richdocuments watermark_text --value "Restricted to {viewer-email}" | ||
| occ config:app:set richdocuments secure_view_open_action_default --value true | ||
| ``` | ||
|
|
||
| ### Development | ||
|
|
||
| Start a Collabora server for development (SSL disabled): | ||
|
|
||
| ```bash | ||
| docker run -t -d -p 9980:9980 -e "extra_params=--o:ssl.enable=false" \ | ||
| -e "username=admin" -e "password=admin" \ | ||
| --name collabora --cap-add MKNOD collabora/code:6.4.8.6 | ||
| ``` | ||
|
|
||
| Build the ownCloud Web connector: | ||
|
|
||
| ```bash | ||
| pnpm install | ||
| pnpm build | ||
| ``` | ||
|
|
||
| ## Documentation | ||
|
|
||
| - [Collabora Online for ownCloud](https://owncloud.com/collabora/collaborative-editing/) | ||
| - [ownCloud Server Admin Manual](https://doc.owncloud.com/server/latest/admin_manual/) | ||
|
|
||
| ## Community & Support | ||
|
|
||
| **[Star](https://github.com/owncloud/richdocuments)** this repo and **Watch** for release notifications! | ||
|
|
||
| - [ownCloud Website](https://owncloud.com) | ||
| - [Community Discussions](https://github.com/orgs/owncloud/discussions) | ||
| - [Matrix Chat](https://app.element.io/#/room/#owncloud:matrix.org) | ||
| - [Documentation](https://doc.owncloud.com) | ||
| - [Enterprise Support](https://owncloud.com/contact-us/) | ||
| - [OSPO Home](https://kiteworks.com/opensource) | ||
|
|
||
| ## Contributing | ||
|
|
||
| We welcome contributions! Please read the [Contributing Guidelines](CONTRIBUTING.md) | ||
| and our [Code of Conduct](CODE_OF_CONDUCT.md) before getting started. | ||
|
|
||
| ### Workflow | ||
|
|
||
| - **Rebase Early, Rebase Often!** We use a rebase workflow. Always rebase on the target branch before submitting a PR. | ||
| - **Dependabot**: Automated dependency updates are managed via Dependabot. Review and merge dependency PRs promptly. | ||
| - **Signed Commits**: All commits **must** be PGP/GPG signed. See [GitHub's signing guide](https://docs.github.com/en/authentication/managing-commit-signature-verification). | ||
| - **DCO Sign-off**: Every commit must carry a `Signed-off-by` line: | ||
| ``` | ||
| git commit -s -S -m "your commit message" | ||
| ``` | ||
| - **GitHub Actions Policy**: Workflows may only use actions that are (a) owned by `owncloud`, (b) created by GitHub (`actions/*`), or (c) verified in the GitHub Marketplace. | ||
|
|
||
| ## Translations | ||
|
|
||
| Help translate this project on Transifex: | ||
| **<https://explore.transifex.com/owncloud-org/owncloud/>** | ||
|
|
||
| Please submit translations via Transifex -- do not open pull requests for translation changes. | ||
|
|
||
| ## Security | ||
|
|
||
| **Do not open a public GitHub issue for security vulnerabilities.** | ||
|
|
||
| Report vulnerabilities at **<https://security.owncloud.com>** -- see [SECURITY.md](SECURITY.md). | ||
|
|
||
| Bug bounty: [YesWeHack ownCloud Program](https://yeswehack.com/programs/owncloud-bug-bounty-program) | ||
|
|
||
| ## License | ||
|
|
||
| See [LICENSE](LICENSE) for license details. | ||
|
|
||
| ## About the ownCloud OSPO | ||
|
|
||
| The [Kiteworks Open Source Program Office](https://kiteworks.com/opensource), operating under | ||
| the [ownCloud](https://owncloud.com) brand, launched on May 5, 2026, to steward the open source | ||
| ecosystem around ownCloud's products. The OSPO ensures transparent governance, license compliance, | ||
| community health, and sustainable collaboration between the open source community and | ||
| [Kiteworks](https://www.kiteworks.com), which acquired ownCloud in 2023. | ||
|
|
||
| - **OSPO Home**: <https://kiteworks.com/opensource> | ||
| - **GitHub**: <https://github.com/owncloud> | ||
| - **ownCloud**: <https://owncloud.com> | ||
|
|
||
| For questions about the OSPO or licensing, contact ospo@kiteworks.com. | ||
|
|
||
| ### License Migration to Apache 2.0 | ||
|
|
||
| The OSPO is driving a strategic relicensing of ownCloud repositories toward the | ||
| [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0), following | ||
| the [Apache Software Foundation's third-party license policy](https://www.apache.org/legal/resolved.html). | ||
|
|
||
| Individual repositories will migrate as their audit is completed. The LICENSE file | ||
| in each repo reflects its **current** license status (not the target). | ||
|
|
||
| **Current license: Not detected.** The OSPO will determine the current license status of this | ||
| repository before planning any migration steps. If you know the intended license, please open an | ||
| issue or contact ospo@kiteworks.com. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Security Policy | ||
|
|
||
| ## Reporting a Vulnerability | ||
|
|
||
| **Do NOT open a public GitHub issue for security vulnerabilities.** | ||
|
|
||
| Please report security issues responsibly via: | ||
| **<https://security.owncloud.com>** | ||
|
|
||
| You can also report vulnerabilities through our YesWeHack bug bounty program: | ||
| **<https://yeswehack.com/programs/owncloud-bug-bounty-program>** |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # Support | ||
|
|
||
| For support with this project, please use the following channels: | ||
|
|
||
| - **Enterprise Support**: <https://owncloud.com/contact-us/> | ||
| - **Community discussions**: https://github.com/orgs/owncloud/discussions | ||
| - **Matrix Chat**: <https://app.element.io/#/room/#owncloud:matrix.org> | ||
| - **Documentation**: <https://doc.owncloud.com> | ||
|
|
||
| Please do not use GitHub issues for general support questions. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| # agents.md — richdocuments | ||
|
|
||
| ## Repository Overview | ||
|
|
||
| Richdocuments is an ownCloud Server (OC10) app that integrates Collabora Online for real-time collaborative editing of office documents. It uses the WOPI protocol to connect ownCloud's file storage with the Collabora Online editing server, supporting documents, spreadsheets and presentations. | ||
|
|
||
| - **Classification:** Classic (OC10) | ||
| - **Activity Status:** Active | ||
| - **License:** No license detected (pending OSPO audit) | ||
| - **Language:** JavaScript, PHP | ||
|
|
||
| ## Architecture & Key Paths | ||
|
|
||
| - `appinfo/` — ownCloud app metadata (info.xml, routes, etc.) | ||
| - `lib/` — PHP backend logic (WOPI integration, controllers) | ||
| - `src/` — TypeScript/JavaScript frontend source (ownCloud Web connector) | ||
| - `js/` — Compiled JavaScript output | ||
| - `css/` — Stylesheets | ||
| - `templates/` — PHP templates for server-side rendering | ||
| - `l10n/` — Localization/translation files | ||
| - `tests/` — PHPUnit and integration tests | ||
| - `admin.php` / `settings.php` — Admin settings UI | ||
| - `Makefile` — Build orchestration | ||
| - `composer.json` — PHP dependencies | ||
| - `package.json` — JavaScript dependencies | ||
| - `vite.config.ts` — Vite build configuration for Web connector | ||
|
|
||
| ## Development Conventions | ||
|
|
||
| - PHP backend follows ownCloud app structure (`appinfo/info.xml`, `lib/`) | ||
| - JavaScript/TypeScript frontend built with Vite | ||
| - Code style enforced by phpcs (`phpcs.xml`) and Prettier | ||
| - `CONTRIBUTING.md` present at repo root | ||
| - SonarCloud used for quality analysis | ||
|
|
||
| ## Build & Test Commands | ||
|
|
||
| ```bash | ||
| make appstore # Build for marketplace distribution | ||
| pnpm install # Install JavaScript dependencies | ||
| pnpm build # Build ownCloud Web connector | ||
| composer install # Install PHP dependencies | ||
| phpunit -c phpunit.xml # Run PHP unit tests | ||
|
Contributor
There was a problem hiding this comment. Should we list the |
||
| ``` | ||
|
|
||
| ## Important Constraints | ||
|
|
||
| - **No license file detected:** This repository currently lacks a formal LICENSE file. The OSPO is working on the license audit as part of the Apache 2.0 migration strategy. | ||
| - **Copyleft + Apache 2.0 migration:** The broader ownCloud organization is migrating repositories to Apache 2.0. Copyleft dependencies must be audited before migration. | ||
| - **WOPI dependency:** Requires a running Collabora Online server reachable from the ownCloud server, and vice versa. | ||
| - **Dual frontend:** Has both a classic OC10 frontend (`js/`) and an ownCloud Web connector (`src/` built with Vite). | ||
|
|
||
|
|
||
| ## OSPO Policy Constraints | ||
|
|
||
| ### GitHub Actions | ||
| - **Only** use actions owned by `owncloud`, created by GitHub (`actions/*`), verified on the GitHub Marketplace, or verified by the ownCloud Maintainers. | ||
| - Pin all actions to their full commit SHA (not tags): `uses: actions/checkout@<SHA> # vX.Y.Z` | ||
| - Never introduce actions from unverified third parties. | ||
|
|
||
| ### Dependency Management | ||
| - Dependabot is configured for automated dependency updates. | ||
| - Review and merge Dependabot PRs as part of regular maintenance. | ||
| - Do not introduce new dependencies without discussion in an issue first. | ||
|
|
||
| ### Git Workflow | ||
| - **Rebase policy**: Always rebase; never create merge commits. Use `git pull --rebase` and `git rebase` before pushing. | ||
| - **Signed commits**: All commits **must** be PGP/GPG signed (`git commit -S -s`). | ||
| - **DCO sign-off**: Every commit needs a `Signed-off-by` line (`git commit -s`). | ||
| - **Conventional Commits & Squash Merge**: Use the [Conventional Commits](https://www.conventionalcommits.org/) format where the repository enforces it. Many repos use squash merge, where the PR title becomes the commit message on the default branch — apply Conventional Commits format to PR titles as well. A reusable GitHub Actions workflow enforces this. | ||
|
|
||
| ## Context for AI Agents | ||
|
|
||
| - This is an ownCloud Server (OC10) app, not an oCIS extension. | ||
| - The PHP backend handles WOPI protocol communication with Collabora Online. | ||
| - The `src/` directory contains a Vite-based TypeScript frontend for the ownCloud Web connector. | ||
| - Configuration is done via `occ config:app:set` commands. | ||
| - The app has both SonarCloud and phpcs integration for code quality. | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.