|
1 | | -[](https://github.com/owncloud/android/actions/workflows/android-unit-tests.yml) [](https://github.com/owncloud/android/actions/workflows/android-instrumented-data-tests.yml) [](https://github.com/owncloud/android/actions/workflows/detekt.yml) [](https://github.com/owncloud/android/actions/workflows/conventional-commits.yml) |
| 1 | +# ownCloud Android App |
2 | 2 |
|
3 | | -# [ownCloud](https://owncloud.org) Android app |
| 3 | +<!-- OSPO-managed README | Generated: 2026-04-16 | v2 --> |
4 | 4 |
|
5 | | -<a href="https://play.google.com/store/apps/details?id=com.owncloud.android"><img src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png" height="75"></a><a href="https://f-droid.org/packages/com.owncloud.android/"><img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" height="75"></a> |
| 5 | +[](LICENSE.txt) [](https://kiteworks.com/opensource) |
6 | 6 |
|
7 | | -| <img src="docs_resources/filelist_device.png"> | <img src="docs_resources/photos_device.png"> | <img src="docs_resources/share_device.png"> | <img src="docs_resources/spaces_device.png"> | |
8 | | -| ---------------------------------------------- | -------------------------------------------- | ------------------------------------------- | ------------------------------------------- | |
| 7 | +The ownCloud Android app enables users to access, sync, and share files stored on their ownCloud server directly from Android devices. Built with Kotlin, it supports ownCloud Infinite Scale (oCIS) and ownCloud 10 servers, featuring file browsing, photo galleries, Spaces, sharing, passcode lock, and biometric authentication. The app is available on [Google Play](https://play.google.com/store/apps/details?id=com.owncloud.android) and [F-Droid](https://f-droid.org/packages/com.owncloud.android/). |
9 | 8 |
|
10 | | -## Join development! |
| 9 | +## Part of Mobile (Android) |
11 | 10 |
|
12 | | -**Start contributing:** Make sure you read [SETUP.md](https://github.com/owncloud/android/blob/master/SETUP.md) when you start working on this project. Basically: Fork this repository and contribute back using pull requests to the master branch. |
13 | | -Easy starting points are also reviewing [pull requests](https://github.com/owncloud/android/pulls) and working on [contributions are welcome](https://github.com/owncloud/android/issues?q=is%3Aopen+is%3Aissue+label%3A%22Contributions+are+welcome%22). |
| 11 | +This is the official [ownCloud Android app](https://github.com/owncloud/android), the primary mobile client for Android users. It connects to both [ownCloud Infinite Scale (oCIS)](https://github.com/owncloud/ocis) and [ownCloud Server (Classic)](https://github.com/owncloud/core). |
14 | 12 |
|
15 | | -**Forum:** [#Android](https://central.owncloud.org/c/android) |
| 13 | +## Getting Started |
16 | 14 |
|
17 | | -**License:** [GPLv2](https://github.com/owncloud/android/blob/master/LICENSE.txt) |
| 15 | +1. Read [SETUP.md](https://github.com/owncloud/android/blob/master/SETUP.md) for development environment setup |
| 16 | +2. Fork the repository and clone it locally |
| 17 | +3. Open the project in Android Studio |
| 18 | +4. Build and run using `./gradlew assembleDebug` |
18 | 19 |
|
19 | | -## Join testing! |
| 20 | +### Beta Testing |
20 | 21 |
|
21 | | -If you are interested in testing the new features before being released and give us your feedback, please try out our beta channels: |
| 22 | +- **Play Store:** Download the app from Play Store, scroll down to the beta section, and tap "I'm in" |
| 23 | +- **F-Droid:** Open the ownCloud tab in F-Droid and download the latest beta version |
22 | 24 |
|
23 | | -**Play Store** |
| 25 | +## Documentation |
24 | 26 |
|
25 | | -1. Download ownCloud app from Play Store. |
26 | | -2. Go to ownCloud tab in Play Store and scroll down to the end of the view. |
27 | | -3. Press the **I'M IN** button to join the beta program and your final app will be replaced with the beta one. |
| 27 | +- [SETUP.md](https://github.com/owncloud/android/blob/master/SETUP.md) - Development setup guide |
| 28 | +- [CONTRIBUTING.md](CONTRIBUTING.md) - Contribution guidelines |
| 29 | +- [CHANGELOG.md](https://github.com/owncloud/android/blob/master/CHANGELOG.md) - Release history |
| 30 | +- [ownCloud documentation](https://doc.owncloud.com) |
28 | 31 |
|
29 | | -Note: If you want to use the ownCloud production version you have to leave the beta program, uninstall the app, and reinstall the production version. |
| 32 | +## Community & Support |
30 | 33 |
|
31 | | -**F-Droid** |
| 34 | +**[Star](https://github.com/owncloud/android)** this repo and **Watch** for release notifications! |
32 | 35 |
|
33 | | -1. Go to ownCloud tab in F-Droid. |
34 | | -2. Open versions section. |
35 | | -3. Download the latest version that contains beta in the name. |
| 36 | +- [ownCloud Website](https://owncloud.com) |
| 37 | +- [Community Discussions](https://github.com/orgs/owncloud/discussions) |
| 38 | +- [Matrix Chat](https://app.element.io/#/room/#owncloud:matrix.org) |
| 39 | +- [Documentation](https://doc.owncloud.com) |
| 40 | +- [Enterprise Support](https://owncloud.com/contact-us/) |
| 41 | +- [OSPO Home](https://kiteworks.com/opensource) |
| 42 | + |
| 43 | +## Contributing |
| 44 | + |
| 45 | +We welcome contributions! Please read the [Contributing Guidelines](CONTRIBUTING.md) |
| 46 | +and our [Code of Conduct](CODE_OF_CONDUCT.md) before getting started. |
| 47 | + |
| 48 | +### Workflow |
| 49 | + |
| 50 | +- **Rebase Early, Rebase Often!** We use a rebase workflow. Always rebase on the target branch before submitting a PR. |
| 51 | +- **Dependabot**: Automated dependency updates are managed via Dependabot. Review and merge dependency PRs promptly. |
| 52 | +- **Signed Commits**: All commits **must** be PGP/GPG signed. See [GitHub's signing guide](https://docs.github.com/en/authentication/managing-commit-signature-verification). |
| 53 | +- **DCO Sign-off**: Every commit must carry a `Signed-off-by` line: |
| 54 | + ``` |
| 55 | + git commit -s -S -m "your commit message" |
| 56 | + ``` |
| 57 | +- **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. |
| 58 | + |
| 59 | +## Translations |
| 60 | + |
| 61 | +Help translate this project on Transifex: |
| 62 | +**<https://explore.transifex.com/owncloud-org/owncloud-android/>** |
| 63 | + |
| 64 | +Please submit translations via Transifex -- do not open pull requests for translation changes. |
| 65 | + |
| 66 | +## Security |
| 67 | + |
| 68 | +**Do not open a public GitHub issue for security vulnerabilities.** |
| 69 | + |
| 70 | +Report vulnerabilities at **<https://security.owncloud.com>** -- see [SECURITY.md](SECURITY.md). |
| 71 | + |
| 72 | +Bug bounty: [YesWeHack ownCloud Program](https://yeswehack.com/programs/owncloud-bug-bounty-program) |
| 73 | + |
| 74 | +## License |
| 75 | + |
| 76 | +This project is licensed under the [GPL-2.0](LICENSE.txt). |
| 77 | + |
| 78 | +## About the ownCloud OSPO |
| 79 | + |
| 80 | +The [Kiteworks Open Source Program Office](https://kiteworks.com/opensource), operating under |
| 81 | +the [ownCloud](https://owncloud.com) brand, launched on May 5, 2026, to steward the open source |
| 82 | +ecosystem around ownCloud's products. The OSPO ensures transparent governance, license compliance, |
| 83 | +community health, and sustainable collaboration between the open source community and |
| 84 | +[Kiteworks](https://www.kiteworks.com), which acquired ownCloud in 2023. |
| 85 | + |
| 86 | +- **OSPO Home**: <https://kiteworks.com/opensource> |
| 87 | +- **GitHub**: <https://github.com/owncloud> |
| 88 | +- **ownCloud**: <https://owncloud.com> |
| 89 | + |
| 90 | +For questions about the OSPO or licensing, contact ospo@kiteworks.com. |
| 91 | + |
| 92 | +### License Migration to Apache 2.0 |
| 93 | + |
| 94 | +The OSPO is driving a strategic relicensing of ownCloud repositories toward the |
| 95 | +[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0), following |
| 96 | +the [Apache Software Foundation's third-party license policy](https://www.apache.org/legal/resolved.html). |
| 97 | + |
| 98 | +Individual repositories will migrate as their audit is completed. The LICENSE file |
| 99 | +in each repo reflects its **current** license status (not the target). |
| 100 | + |
| 101 | +**Current license: GPL-2.0** (Category X per Apache policy -- cannot be included in Apache-2.0 works). |
| 102 | + |
| 103 | +Migration prerequisites for this repository: |
| 104 | + |
| 105 | +- **CLA/DCO coverage**: All past contributors must have signed agreements permitting relicensing |
| 106 | +- **Copyleft dependency audit**: All GPL dependencies must be replaced or isolated |
| 107 | +- **KDE heritage review**: Any code with KDE-era copyrights requires legal analysis |
| 108 | +- **Complete relicensing**: GPL-2.0 is a strong copyleft license; migration requires full relicensing of all files |
0 commit comments