2022-08-31 06:06:27 +00:00
# KaraDAV - A lightweight WebDAV server, with NextCloud compatibility
2022-10-28 09:53:20 +00:00
This is a simple and lighweight WebDAV server, allowing to easily set up a file sharing server compatible with WebDAV and NextCloud clients. It has no dependencies and good performance.
2022-08-31 06:06:27 +00:00
2022-10-24 23:15:17 +00:00
It is written in PHP (8+). The only dependency is SQLite3 for the database.
2022-08-31 06:06:27 +00:00
2022-10-21 17:22:37 +00:00
Its original purpose was to serve as a demo and test for the KD2 WebDAV library, which we developed for [Paheko ](http://paheko.cloud/ ), our non-profit management solution, but it can also be used as a simple but powerful file sharing server.
2022-08-31 06:06:27 +00:00
2022-10-24 17:10:59 +00:00
2022-10-24 17:06:00 +00:00
2022-10-21 17:22:37 +00:00
## Features
2022-08-31 06:06:27 +00:00
2022-10-21 17:22:37 +00:00
* User-friendly directory listings for file browsing with a web browser, using our [WebDAV Manager.js ](https://github.com/kd2org/webdav-manager.js ) client
* Upload directly from browser, using paste or drag and drop
2022-09-30 17:35:04 +00:00
* Rename
* Delete
2022-10-21 17:22:37 +00:00
* Create and edit text files
* Create directories
2022-09-30 17:35:04 +00:00
* MarkDown live preview
* Preview of images, text, MarkDown and PDF
2022-10-21 17:22:37 +00:00
* Editing of Office files using Collabora or OnlyOffice
2022-09-03 03:08:52 +00:00
* WebDAV class 1, 2, 3 support, support for Etags
2022-10-24 17:06:00 +00:00
* No database server is required (SQLite3 is used)
2022-08-31 06:06:27 +00:00
* Multiple user accounts
2022-10-24 17:06:00 +00:00
* Support for per-user quota
2022-10-21 17:22:37 +00:00
* Share files using WebDAV: delete, create, update, mkdir, get, list
2022-08-31 06:06:27 +00:00
* Compatible with WebDAV clients
2022-10-21 17:22:37 +00:00
* Support for HTTP ranges (partial download of files)
2022-09-30 00:42:21 +00:00
* Support for [RFC 3230 ](https://greenbytes.de/tech/webdav/rfc3230.xhtml ) to get the MD5 digest hash of a file (to check integrity) on `HEAD` requests (only MD5 is supported so far)
* Support for `Content-MD5` with `PUT` requests, see [dCache documentation for details ](https://dcache.org/old/manuals/UserGuide-6.0/webdav.shtml#checksums )
* Support for some of the [Microsoft proprietary properties ](https://greenbytes.de/tech/webdav/webdavfaq.html )
2022-10-21 17:22:37 +00:00
* Passes most of the [Litmus compliance tests ](https://github.com/tolsen/litmus ) (see below)
2022-10-15 00:15:39 +00:00
* Supports WOPI, for editing and viewing of documents using OnlyOffice, Collabora Online or MS Office.
2022-10-24 22:35:52 +00:00
* Support for LDAP
2022-10-24 18:02:46 +00:00
* Good performance!
2022-08-31 06:06:27 +00:00
2022-10-21 17:22:37 +00:00
### NextCloud/ownCloud features
2022-10-25 14:29:42 +00:00
KaraDAV is compatible with ownCloud and NextCloud clients, because on Android there is not much nice WebDAV clients, and on desktop their clients allow for two-way sync, which no other WebDAV client provides.
2022-10-21 17:22:37 +00:00
The following ownCloud/NextCloud specific features are supported:
* [Direct download ](https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-api-overview.html#direct-download )
* [Chunk upload ](https://docs.nextcloud.com/server/latest/developer_manual/client_apis/WebDAV/chunking.html )
* `X-OC-MTime` [header ](https://gitlab.gnome.org/GNOME/gvfs/-/issues/637 ) to set file modification time
* Login via app-specific passwords (necessary for NextCloud desktop and Android clients)
* Thumbnail/preview of images and files
* Workspace notes (`README.md` displayed on top of directory listing on Android app) and workspace notes editing
2022-10-24 17:06:00 +00:00
## Screenshots
2022-10-24 17:10:59 +00:00
### Files management using the Web UI
2022-10-24 17:06:00 +00:00
2022-10-24 17:10:59 +00:00
2022-10-24 17:06:00 +00:00
2022-10-24 17:10:59 +00:00
### Login from NextCloud client
2022-10-24 17:06:00 +00:00
2022-10-24 17:10:59 +00:00
2022-10-24 17:06:00 +00:00
2022-10-02 01:27:19 +00:00
## NextCloud/ownCloud compatibility
2022-09-04 00:27:40 +00:00
2022-10-03 01:03:19 +00:00
This server should be compatible with ownCloud and NextCloud synchronization clients (desktop, mobile, CLI).
2022-10-02 01:27:19 +00:00
It has been tested with:
* ownCloud Desktop 2.5.1 and 2.11.1 (Debian)
* NextCloud Desktop 3.1.1 and 3.6.0 (Debian)
2022-10-03 01:03:19 +00:00
* NextCloud Android app 3.21.0 (F-Droid)
2022-10-03 02:44:20 +00:00
* ownCloud Android app 2.21.2 (F-Droid)
2022-10-02 01:27:19 +00:00
* [NextCloud CLI client ](https://docs.nextcloud.com/desktop/3.5/advancedusage.html ) 3.1.1 (Debian) *-- Note: make sure to pass options before parameters.*
2022-10-03 01:03:19 +00:00
2022-10-24 23:43:23 +00:00
**We recommend the ownCloud apps**, as they are more stable and lighter :)
2022-10-24 23:15:17 +00:00
2022-10-21 17:22:37 +00:00
Note that even though it has been tested with NC/OC clients, KaraDAV might stop working at any time with these clients.
2022-09-04 00:27:40 +00:00
2022-09-29 23:39:24 +00:00
## WebDAV clients compatibility
2022-10-24 23:43:23 +00:00
* [FUSE webdavfs ](https://github.com/miquels/webdavfs ) is **recommended** for Linux
2022-09-29 23:39:24 +00:00
* davfs2 is NOT recommended: it is very slow, and it is using a local cache, meaning changing a file locally may not be synced to the server for a few minutes, leading to things getting out of sync. If you have to use it, at least disable locks, by setting `use_locks=0` in the config.
2022-10-21 15:34:08 +00:00
* Microsoft Windows native webclient (also called 'MiniRedir') is notoriously bad. We tested it successfully on Windows 10, but it is recommended to use [CyberDuck ](https://cyberduck.io/download/ ) or [WinSCP ](https://winscp.net/ ) instead, both are free software.
2022-10-24 23:15:17 +00:00
* Tested with Dolphin (KDE)
* Tested with Thunar (GTK/GNOME)
2022-10-24 23:43:23 +00:00
* Tested with [RCX ](https://f-droid.org/en/packages/io.github.x0b.rcx/ ) on Android ** (recommended)**
2022-09-29 23:39:24 +00:00
2022-10-15 00:15:39 +00:00
## WOPI clients compatibility
2022-10-24 17:10:59 +00:00
* Tested successfully with Collabora Development Edition (see [COLLABORA.md ](doc/COLLABORA.md ))
2022-10-21 17:22:37 +00:00
2022-08-31 06:06:27 +00:00
## Future development
2022-09-03 03:08:52 +00:00
This might get supported in future (maybe):
2022-10-24 17:06:00 +00:00
* Probably: [NextCloud Trashbin ](https://docs.nextcloud.com/server/latest/developer_manual/client_apis/WebDAV/trashbin.html )
* Maybe: [NextCloud sharing ](https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-share-api.html )
* Maybe: NextCloud files versioning (see [API ](https://docs.nextcloud.com/server/latest/developer_manual/client_apis/WebDAV/versions.html ), [versioning pattern ](https://docs.nextcloud.com/server/latest/user_manual/en/files/version_control.html ), [code ](https://github.com/nextcloud/server/blob/master/apps/files_versions/lib/Storage.php ))
2022-10-02 00:41:46 +00:00
This probably won't get supported anytime soon:
* CalDAV/CardDAV support:
* this would require a [bunch of new stuff implemented ](https://evertpot.com/227/ )
* the only CalDAV test suite ([CavDAVtester](https://github.com/apple/ccs-caldavtester)) does not work anymore as it's written for Python 2
* for now the best option is to use [Baikal from Sabre/DAV ](https://sabre.io/baikal/ ) for that
* Nice web clients to add to Baikal are [AgenDAV ](https://github.com/agendav/agendav ) and [InfCloud ](https://inf-it.com/open-source/clients/infcloud/ )
2022-10-02 01:27:19 +00:00
* [Extended MKCOL ](https://www.rfc-editor.org/rfc/rfc5689 ) required only if CalDAV support is implemented
2022-10-24 17:06:00 +00:00
* [Partial upload via PATCH ](https://github.com/miquels/webdav-handler-rs/blob/master/doc/SABREDAV-partialupdate.md )
* [Resumable upload via TUS ](https://tus.io/protocols/resumable-upload.html )
* [WebDAV sharing if it ever becomes a spec? ](https://evertpot.com/webdav-caldav-carddav-sharing/ )
2022-08-31 06:06:27 +00:00
2022-10-24 17:10:59 +00:00
## Install instructions
See [specific install documentation ](doc/INSTALL.md ).
2022-08-31 06:06:27 +00:00
## Dependencies
This depends on the KD2\WebDAV and KD2\WebDAV_NextCloud classes from the [KD2FW package ](https://fossil.kd2.org/kd2fw/ ), which are packaged in this repository.
2022-10-24 17:06:00 +00:00
They are lightweight and easy to use in your own software to add support for WebDAV and NextCloud clients to your software. Contact us for a commercial license.
2022-08-31 06:06:27 +00:00
2022-10-21 17:22:37 +00:00
## Similar software
* [Davros ](https://github.com/mnutt/davros/ ) used to be compatible with NextCloud client [before version 2.5.0 ](https://github.com/owncloud/client/issues/6775 )
* [FileRun ](https://filerun.com ) is a proprietary solution compatible with the NextCloud Android app
2022-10-24 23:15:17 +00:00
Might also be useful:
* [DrivinCloudOpen ](https://github.com/bohwaz/drivinCloudOpen ) is a defunct open-source Android WebDAV client that is easy to use
2022-10-24 18:02:46 +00:00
## Performance
I created 300 small random files, totalling 5.5 MB.
Then I timed KaraDAV, mod_dav and NextCloud (24) (all installed on my laptop, with Apache 2.4) with various WebDAV clients doing those tasks:
* Copy 300 small files to the WebDAV share
* Refresh the directory (press F5)
* Delete all 300 selected files
KaraDAV performance was very close to mod_dav, and NextCloud performance was incredibly poor.
| Client | KaraDAV | NextCloud | mod_dav |
| --- | --- | --- | --- |
| Dolphin (KDE) | 5 seconds | 1 minute 15 seconds | 3 seconds |
| Thunar (GTK) | 5 seconds | 1 minute 50 seconds | 5 seconds |
| WebDAV Manager.js | 4 seconds (no delete) | -- | -- |
At the time of this test, WebDAV Manager.js didn't have the ability to select and delete multiple files at once, so the time shown is only for copy and refresh.
2022-09-30 17:35:04 +00:00
## Litmus compliance tests
2022-09-30 23:37:03 +00:00
Tests were performed using litmus source code as of December 13, 2017 from [the Github repo ](https://github.com/tolsen/litmus ).
2022-10-21 17:22:37 +00:00
We are not aiming at 100% pass, as we are mainly targeting file sharing, so we are not currently trying to fix rare `PROPPATCH` issues, but pull requests are welcome.
2022-09-30 17:35:04 +00:00
```
2022-09-30 23:37:03 +00:00
-> running `http':
0. init.................. pass
1. begin................. pass
2. expect100............. pass
3. finish................ pass
< - summary for ` http ' : of 4 tests run: 4 passed , 0 failed . 100 . 0 %
-> running `basic':
2022-09-30 17:35:04 +00:00
0. init.................. pass
1. begin................. pass
2. options............... pass
3. put_get............... pass
4. put_get_utf8_segment.. pass
2022-09-30 23:37:03 +00:00
5. mkcol_over_plain...... pass
6. delete................ pass
7. delete_null........... pass
8. delete_fragment....... pass
9. mkcol................. pass
10. mkcol_percent_encoded. pass
2022-09-30 17:35:04 +00:00
11. mkcol_again........... pass
12. delete_coll........... pass
13. mkcol_no_parent....... pass
14. mkcol_with_body....... pass
2022-09-30 23:37:03 +00:00
15. mkcol_forbidden....... pass
16. chk_ETag.............. pass
17. finish................ pass
< - summary for ` basic ' : of 18 tests run: 18 passed , 0 failed . 100 . 0 %
2022-09-30 17:35:04 +00:00
-> running `copymove':
0. init.................. pass
1. begin................. pass
2. copy_init............. pass
3. copy_simple........... pass
4. copy_overwrite........ pass
5. copy_nodestcoll....... pass
6. copy_cleanup.......... pass
2022-09-30 23:37:03 +00:00
7. copy_content_check.... pass
8. copy_coll_depth....... pass
9. copy_coll............. pass
10. depth_zero_copy....... pass
11. copy_med_on_coll...... pass
12. move.................. pass
13. move_coll............. pass
14. move_cleanup.......... pass
15. move_content_check.... pass
16. move_collection_check. pass
17. finish................ pass
< - summary for ` copymove ' : of 18 tests run: 18 passed , 0 failed . 100 . 0 %
```
With this litmus version, `props` and `locks` tests currently fail.
But they mostly pass with litmus 0.13-3 supplied by Debian:
```
2022-09-30 17:35:04 +00:00
-> running `props':
0. init.................. pass
1. begin................. pass
2. propfind_invalid...... pass
3. propfind_invalid2..... pass
4. propfind_d0........... pass
5. propinit.............. pass
6. propset............... pass
7. propget............... pass
8. propextended.......... pass
9. propmove.............. pass
10. propget............... pass
11. propdeletes........... pass
12. propget............... pass
13. propreplace........... pass
14. propget............... pass
15. propnullns............ pass
16. propget............... pass
17. prophighunicode....... pass
18. propget............... pass
19. propremoveset......... pass
20. propget............... pass
21. propsetremove......... pass
22. propget............... pass
23. propvalnspace......... pass
24. propwformed........... pass
25. propinit.............. pass
26. propmanyns............ pass
27. propget............... pass
28. propcleanup........... pass
29. finish................ pass
< - summary for ` props ' : of 30 tests run: 30 passed , 0 failed . 100 . 0 %
2022-09-30 23:37:03 +00:00
-> running `locks':
0. init.................. pass
1. begin................. pass
2. options............... pass
3. precond............... pass
4. init_locks............ pass
5. put................... pass
6. lock_excl............. pass
7. discover.............. pass
8. refresh............... pass
9. notowner_modify....... pass
10. notowner_lock......... pass
11. owner_modify.......... pass
12. notowner_modify....... pass
13. notowner_lock......... pass
14. copy.................. pass
15. cond_put.............. pass
16. fail_cond_put......... pass
17. cond_put_with_not..... pass
18. cond_put_corrupt_token WARNING: PUT failed with 400 not 423
...................... pass (with 1 warning)
19. complex_cond_put...... pass
20. fail_complex_cond_put. pass
21. unlock................ pass
22. fail_cond_put_unlocked pass
23. lock_shared........... pass
24. notowner_modify....... pass
25. notowner_lock......... FAIL (LOCK on locked resource)
26. owner_modify.......... pass
27. double_sharedlock..... FAIL (shared LOCK on locked resource:
423 Locked)
28. notowner_modify....... pass
29. notowner_lock......... pass
30. unlock................ pass
31. prep_collection....... pass
32. lock_collection....... pass
33. owner_modify.......... FAIL (PROPPATCH on locked resouce on `/files/demo/litmus/lockcoll/lockme.txt': 423 Locked)
34. notowner_modify....... pass
35. refresh............... pass
36. indirect_refresh...... pass
37. unlock................ pass
38. unmapped_lock......... WARNING: LOCK on unmapped url returned 200 not 201 (RFC4918:S7.3)
...................... pass (with 1 warning)
39. unlock................ pass
40. finish................ pass
< - summary for ` locks ' : of 41 tests run: 38 passed , 3 failed . 92 . 7 %
-> 2 warnings were issued.
2022-10-21 17:22:37 +00:00
```
2022-08-31 06:06:27 +00:00
## Author
2022-10-24 17:06:00 +00:00
Paheko.cloud / BohwaZ. Contact me on: IRC = bohwaz@irc.libera.chat / Mastodon = https://mamot.fr/@bohwaz / Twitter = @bohwaz
2022-08-31 06:06:27 +00:00
##
This software and its dependencies are available in open source with the AGPL v3 license. This requires you to share all your source code if you include this in your software. This is voluntary.
For entities wishing to use this software or libraries in a project where you don't want to have to publish all your source code, we can also sell this software with a commercial license, contact me at bohwaz /at/ kd2 /dot/ org. We can do that as we have wrote and own 100% of the source code, dependencies included, there is no third-party code here.
