|
| 1 | +# davclient.js |
| 2 | + |
| 3 | +<!-- OSPO-managed README | Generated: 2026-04-16 | v2 --> |
| 4 | + |
| 5 | +[](LICENSE) [](https://kiteworks.com/opensource) |
| 6 | + |
| 7 | +davclient.js is a JavaScript client library for WebDAV, CalDAV, and CardDAV protocols. It provides a lightweight API for performing DAV operations (PROPFIND, PROPPATCH, MKCOL, MOVE, COPY, DELETE, LOCK, UNLOCK, REPORT) from browser-based applications. The library is used by ownCloud's web frontend to communicate with the server's DAV endpoints. |
| 8 | + |
| 9 | +> **Note:** This repository is in maintenance/legacy mode and is no longer actively developed. |
| 10 | +
|
| 11 | +## Part of Infrastructure / Tooling |
| 12 | + |
| 13 | +This library is a shared JavaScript dependency used by ownCloud's web-based components to interact with DAV (WebDAV, CalDAV, CardDAV) servers. It supports the [ownCloud Server (Classic)](https://github.com/owncloud/core) web interface. |
| 14 | + |
| 15 | +> **Note:** This repository is currently in Archived/Legacy mode. It is no longer actively maintained. |
| 16 | +
|
| 17 | +## Getting Started |
| 18 | + |
| 19 | +Follow the steps below to install and use the library. |
| 20 | + |
| 21 | +### Installation |
| 22 | + |
| 23 | +Via npm: |
| 24 | +```bash |
| 25 | +npm install davclient.js |
| 26 | +``` |
| 27 | + |
| 28 | +Or via Bower: |
| 29 | +```bash |
| 30 | +bower install davclient.js |
| 31 | +``` |
| 32 | + |
| 33 | +### Running Tests |
| 34 | + |
| 35 | +```bash |
| 36 | +npm test |
| 37 | +``` |
| 38 | + |
| 39 | +## Documentation |
| 40 | + |
| 41 | +- See the source code in `lib/` for the API |
| 42 | +- The `index.html` file provides a usage example |
| 43 | + |
| 44 | +## Community & Support |
| 45 | + |
| 46 | +**[Star](https://github.com/owncloud/davclient.js)** this repo and **Watch** for release notifications! |
| 47 | + |
| 48 | +- [ownCloud Website](https://owncloud.com) |
| 49 | +- [Community Discussions](https://github.com/orgs/owncloud/discussions) |
| 50 | +- [Matrix Chat](https://app.element.io/#/room/#owncloud:matrix.org) |
| 51 | +- [Documentation](https://doc.owncloud.com) |
| 52 | +- [Enterprise Support](https://owncloud.com/contact-us/) |
| 53 | +- [OSPO Home](https://kiteworks.com/opensource) |
| 54 | + |
| 55 | +## Contributing |
| 56 | + |
| 57 | +We welcome contributions! Please read the [Contributing Guidelines](CONTRIBUTING.md) |
| 58 | +and our [Code of Conduct](CODE_OF_CONDUCT.md) before getting started. |
| 59 | + |
| 60 | +### Workflow |
| 61 | + |
| 62 | +- **Rebase Early, Rebase Often!** We use a rebase workflow. Always rebase on the target branch before submitting a PR. |
| 63 | +- **Dependabot**: Automated dependency updates are managed via Dependabot. Review and merge dependency PRs promptly. |
| 64 | +- **Signed Commits**: All commits **must** be PGP/GPG signed. See [GitHub's signing guide](https://docs.github.com/en/authentication/managing-commit-signature-verification). |
| 65 | +- **DCO Sign-off**: Every commit must carry a `Signed-off-by` line: |
| 66 | + ``` |
| 67 | + git commit -s -S -m "your commit message" |
| 68 | + ``` |
| 69 | +- **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. |
| 70 | + |
| 71 | +## Security |
| 72 | + |
| 73 | +**Do not open a public GitHub issue for security vulnerabilities.** |
| 74 | + |
| 75 | +Report vulnerabilities at **<https://security.owncloud.com>** -- see [SECURITY.md](SECURITY.md). |
| 76 | + |
| 77 | +Bug bounty: [YesWeHack ownCloud Program](https://yeswehack.com/programs/owncloud-bug-bounty-program) |
| 78 | + |
| 79 | +## License |
| 80 | + |
| 81 | +This project is licensed under the [BSD-3-Clause](LICENSE). |
| 82 | + |
| 83 | +## About the ownCloud OSPO |
| 84 | + |
| 85 | +The [Kiteworks Open Source Program Office](https://kiteworks.com/opensource), operating under |
| 86 | +the [ownCloud](https://owncloud.com) brand, launched on May 5, 2026, to steward the open source |
| 87 | +ecosystem around ownCloud's products. The OSPO ensures transparent governance, license compliance, |
| 88 | +community health, and sustainable collaboration between the open source community and |
| 89 | +[Kiteworks](https://www.kiteworks.com), which acquired ownCloud in 2023. |
| 90 | + |
| 91 | +- **OSPO Home**: <https://kiteworks.com/opensource> |
| 92 | +- **GitHub**: <https://github.com/owncloud> |
| 93 | +- **ownCloud**: <https://owncloud.com> |
| 94 | + |
| 95 | +For questions about the OSPO or licensing, contact ospo@kiteworks.com. |
| 96 | + |
| 97 | +### License Migration to Apache 2.0 |
| 98 | + |
| 99 | +The OSPO is driving a strategic relicensing of ownCloud repositories toward the |
| 100 | +[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0), following |
| 101 | +the [Apache Software Foundation's third-party license policy](https://www.apache.org/legal/resolved.html). |
| 102 | + |
| 103 | +Individual repositories will migrate as their audit is completed. The LICENSE file |
| 104 | +in each repo reflects its **current** license status (not the target). |
| 105 | + |
| 106 | +**Current license: BSD-3-Clause** (Category A per Apache policy -- permissive, compatible with Apache-2.0). |
| 107 | + |
| 108 | +Migration prerequisites for this repository: |
| 109 | + |
| 110 | +- **CLA/DCO coverage**: All past contributors must have signed agreements permitting relicensing |
| 111 | +- **Header updates**: All source file headers must be updated to Apache-2.0 notice |
| 112 | +- **Dependency audit**: Verify no incompatible transitive dependencies |
0 commit comments