Skip to content

Commit 93ac59f

Browse files
committed
docs(ospo): community health rollout v2 — README, agents.md, health files
Introduced by the Kiteworks Open Source Program Office (OSPO) on May 5, 2026. Changes: - README.md: rewritten with OSPO v2 template — license-specific migration guidance, Community & Support section, Contributing workflow, Security section pointing to security.owncloud.com + YesWeHack bug bounty - agents.md: AI agent context file with architecture, build commands, and OSPO Policy Constraints (GitHub Actions, Dependabot, Git Workflow) - CODE_OF_CONDUCT.md: redirect to https://owncloud.com/contribute/code-of-conduct/ - CONTRIBUTING.md: redirect to https://owncloud.com/contribute/ - SECURITY.md: redirect to https://security.owncloud.com + YesWeHack - SUPPORT.md: redirect to https://owncloud.com/contact-us/ + channels OSPO: https://kiteworks.com/opensource Signed-off-by: David Walter <david.walter@kiteworks.com>
1 parent 802c4fb commit 93ac59f

6 files changed

Lines changed: 207 additions & 11 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Code of Conduct
2+
3+
This project follows the ownCloud Code of Conduct.
4+
5+
Please read the full Code of Conduct at:
6+
**<https://owncloud.com/contribute/code-of-conduct/>**
7+
8+
By participating in this project, you agree to abide by its terms.

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to this project!
4+
5+
Please read the full contributing guidelines at:
6+
**<https://owncloud.com/contribute/>**
7+
8+
For development setup, coding standards, and pull request process,
9+
see the README in this repository.

README.md

Lines changed: 100 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,103 @@
1-
guests
2-
=======
1+
# ownCloud Guests
32

4-
[![Build Status](https://drone.owncloud.com/api/badges/owncloud/guests/status.svg?branch=master)](https://drone.owncloud.com/owncloud/guests)
5-
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=owncloud_guests&metric=alert_status)](https://sonarcloud.io/dashboard?id=owncloud_guests)
6-
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=owncloud_guests&metric=security_rating)](https://sonarcloud.io/dashboard?id=owncloud_guests)
7-
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=owncloud_guests&metric=coverage)](https://sonarcloud.io/dashboard?id=owncloud_guests)
3+
<!-- OSPO-managed README | Generated: 2026-04-16 | v2 -->
84

9-
Create a guest user by typing his email address in to the sharing dialog. The guest
10-
will receive an email invite with a link to create an account. He has only access
11-
to files which are shared with him.
5+
[![License](https://img.shields.io/badge/License-GPL--2.0-blue.svg)](LICENSE) [![ownCloud OSPO](https://img.shields.io/badge/OSPO-ownCloud-blue)](https://kiteworks.com/opensource) [![Docker Hub](https://img.shields.io/docker/pulls/owncloud)](https://hub.docker.com/r/owncloud/server)
126

13-
Furthermore, the administrator has to whitelist the applications that guests can use.
14-
By default settings, avatar, files_external, files_trashbin, files_versions, files_sharing, files_texteditor, activity, firstrunwizard, gallery, notifications, password_policy and oauth2 are allowed.
7+
An ownCloud Classic (OC10) app that enables sharing files with external users via email address. When a file is shared with a guest, they receive an email invitation with a link to create an account. Guest users have access only to files shared with them and can use a configurable whitelist of allowed apps (such as file viewers, text editors, and activity tracking).
8+
9+
## Getting Started
10+
11+
Enable the app in the ownCloud admin panel:
12+
13+
```bash
14+
sudo -u www-data php occ app:enable guests
15+
```
16+
17+
To invite a guest, type their email address in the sharing dialog. The guest receives an email with instructions to create an account. Administrators can configure the allowed apps for guest users in the admin settings.
18+
19+
## Documentation
20+
21+
- [ownCloud Server Admin Manual](https://doc.owncloud.com/server/latest/admin_manual/)
22+
23+
## Part of ownCloud Classic (OC10)
24+
25+
This app extends [ownCloud Server](https://github.com/owncloud/core) with guest user capabilities. It is shipped as part of the [ownCloud Server Docker image](https://hub.docker.com/r/owncloud/server).
26+
27+
## Community & Support
28+
29+
**[Star](https://github.com/owncloud/guests)** this repo and **Watch** for release notifications!
30+
31+
- [ownCloud Website](https://owncloud.com)
32+
- [Community Discussions](https://github.com/orgs/owncloud/discussions)
33+
- [Matrix Chat](https://app.element.io/#/room/#owncloud:matrix.org)
34+
- [Documentation](https://doc.owncloud.com)
35+
- [Enterprise Support](https://owncloud.com/contact-us/)
36+
- [OSPO Home](https://kiteworks.com/opensource)
37+
38+
## Contributing
39+
40+
We welcome contributions! Please read the [Contributing Guidelines](CONTRIBUTING.md)
41+
and our [Code of Conduct](CODE_OF_CONDUCT.md) before getting started.
42+
43+
### Workflow
44+
45+
- **Rebase Early, Rebase Often!** We use a rebase workflow. Always rebase on the target branch before submitting a PR.
46+
- **Dependabot**: Automated dependency updates are managed via Dependabot. Review and merge dependency PRs promptly.
47+
- **Signed Commits**: All commits **must** be PGP/GPG signed. See [GitHub's signing guide](https://docs.github.com/en/authentication/managing-commit-signature-verification).
48+
- **DCO Sign-off**: Every commit must carry a `Signed-off-by` line:
49+
```
50+
git commit -s -S -m "your commit message"
51+
```
52+
- **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.
53+
54+
## Translations
55+
56+
Help translate this project on Transifex:
57+
**<https://explore.transifex.com/owncloud-org/owncloud/>**
58+
59+
Please submit translations via Transifex -- do not open pull requests for translation changes.
60+
61+
## Security
62+
63+
**Do not open a public GitHub issue for security vulnerabilities.**
64+
65+
Report vulnerabilities at **<https://security.owncloud.com>** -- see [SECURITY.md](SECURITY.md).
66+
67+
Bug bounty: [YesWeHack ownCloud Program](https://yeswehack.com/programs/owncloud-bug-bounty-program)
68+
69+
## License
70+
71+
This project is licensed under the [GPL-2.0](LICENSE).
72+
73+
## About the ownCloud OSPO
74+
75+
The [Kiteworks Open Source Program Office](https://kiteworks.com/opensource), operating under
76+
the [ownCloud](https://owncloud.com) brand, launched on May 5, 2026, to steward the open source
77+
ecosystem around ownCloud's products. The OSPO ensures transparent governance, license compliance,
78+
community health, and sustainable collaboration between the open source community and
79+
[Kiteworks](https://www.kiteworks.com), which acquired ownCloud in 2023.
80+
81+
- **OSPO Home**: <https://kiteworks.com/opensource>
82+
- **GitHub**: <https://github.com/owncloud>
83+
- **ownCloud**: <https://owncloud.com>
84+
85+
For questions about the OSPO or licensing, contact ospo@kiteworks.com.
86+
87+
### License Migration to Apache 2.0
88+
89+
The OSPO is driving a strategic relicensing of ownCloud repositories toward the
90+
[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0), following
91+
the [Apache Software Foundation's third-party license policy](https://www.apache.org/legal/resolved.html).
92+
93+
Individual repositories will migrate as their audit is completed. The LICENSE file
94+
in each repo reflects its **current** license status (not the target).
95+
96+
**Current license: GPL-2.0** (Category X per Apache policy -- cannot be included in Apache-2.0 works).
97+
98+
Migration prerequisites for this repository:
99+
100+
- **CLA/DCO coverage**: All past contributors must have signed agreements permitting relicensing
101+
- **Copyleft dependency audit**: All GPL dependencies must be replaced or isolated
102+
- **KDE heritage review**: Any code with KDE-era copyrights requires legal analysis
103+
- **Complete relicensing**: GPL-2.0 is a strong copyleft license; migration requires full relicensing of all files

SECURITY.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
**Do NOT open a public GitHub issue for security vulnerabilities.**
6+
7+
Please report security issues responsibly via:
8+
**<https://security.owncloud.com>**
9+
10+
You can also report vulnerabilities through our YesWeHack bug bounty program:
11+
**<https://yeswehack.com/programs/owncloud-bug-bounty-program>**

SUPPORT.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Support
2+
3+
For support with this project, please use the following channels:
4+
5+
- **Enterprise Support**: <https://owncloud.com/contact-us/>
6+
- **Community discussions**: https://github.com/orgs/owncloud/discussions
7+
- **Matrix Chat**: <https://app.element.io/#/room/#owncloud:matrix.org>
8+
- **Documentation**: <https://doc.owncloud.com>
9+
10+
Please do not use GitHub issues for general support questions.

agents.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# AI Agent Guidelines for ownCloud Guests
2+
3+
This file provides context for AI coding agents (Claude Code, GitHub Copilot, Cursor, etc.) working in this repository.
4+
5+
## Repository Overview
6+
- **Product family:** Classic (OC10)
7+
- **Primary language(s):** JavaScript
8+
- **Build system:** Make + Composer + Yarn
9+
- **Test framework:** PHPUnit
10+
- **CI system:** GitHub Actions
11+
12+
## Architecture & Key Paths
13+
14+
- `appinfo/` -- App metadata and registration
15+
- `lib/` -- PHP application logic (guest user management)
16+
- `js/` -- Frontend JavaScript
17+
- `css/` -- Stylesheets
18+
- `templates/` -- PHP templates
19+
- `l10n/` -- Translations
20+
- `tests/` -- PHPUnit and acceptance tests
21+
- `Makefile` -- Build and test targets
22+
23+
## Development Conventions
24+
- **Branching:** master
25+
- **Commit messages:** DCO sign-off required (`git commit -s`)
26+
- **Code style:** PHP-CS-Fixer and PHP_CodeSniffer (`phpcs.xml`, `vendor-bin/owncloud-codestyle`)
27+
- **PR process:** Open a PR against `master`. All CI checks must pass.
28+
29+
## Build & Test Commands
30+
```bash
31+
# Build
32+
make dist
33+
34+
# Test
35+
make test
36+
37+
# Lint
38+
make test-php-style
39+
```
40+
41+
## Important Constraints
42+
- All code contributions must be compatible with the **GPL-2.0** license
43+
- Do not introduce new **copyleft-licensed dependencies** (GPL, AGPL, LGPL, MPL) without explicit discussion in an issue first. This is especially important for repos migrating to Apache 2.0.
44+
- Do not introduce new dependencies without discussion in an issue first
45+
46+
47+
## OSPO Policy Constraints
48+
49+
### GitHub Actions
50+
- **Only** use actions owned by `owncloud`, created by GitHub (`actions/*`), verified on the GitHub Marketplace, or verified by the ownCloud Maintainers.
51+
- Pin all actions to their full commit SHA (not tags): `uses: actions/checkout@<SHA> # vX.Y.Z`
52+
- Never introduce actions from unverified third parties.
53+
54+
### Dependency Management
55+
- Dependabot is configured for automated dependency updates.
56+
- Review and merge Dependabot PRs as part of regular maintenance.
57+
- Do not introduce new dependencies without discussion in an issue first.
58+
59+
### Git Workflow
60+
- **Rebase policy**: Always rebase; never create merge commits. Use `git pull --rebase` and `git rebase` before pushing.
61+
- **Signed commits**: All commits **must** be PGP/GPG signed (`git commit -S -s`).
62+
- **DCO sign-off**: Every commit needs a `Signed-off-by` line (`git commit -s`).
63+
- **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.
64+
65+
## Context for AI Agents
66+
- Match existing code style
67+
- Do not refactor unrelated code in the same PR
68+
- Write tests for new functionality
69+
- Keep PRs focused and atomic

0 commit comments

Comments
 (0)