|
1 | | -guests |
2 | | -======= |
| 1 | +# ownCloud Guests |
3 | 2 |
|
4 | | -[](https://drone.owncloud.com/owncloud/guests) |
5 | | -[](https://sonarcloud.io/dashboard?id=owncloud_guests) |
6 | | -[](https://sonarcloud.io/dashboard?id=owncloud_guests) |
7 | | -[](https://sonarcloud.io/dashboard?id=owncloud_guests) |
| 3 | +<!-- OSPO-managed README | Generated: 2026-04-16 | v2 --> |
8 | 4 |
|
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://kiteworks.com/opensource) [](https://hub.docker.com/r/owncloud/server) |
12 | 6 |
|
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 |
0 commit comments