Nephele: A pluggable WebDAV (and soon CardDAV and CalDAV) server for Node.js and Express.
If you are looking for a ready-to-run dedicated WebDAV server, check out the nephele-serve package on NPM or the Nephele Docker image on Docker Hub.
If you're looking for an easy to use desktop app for local file transfers, check out QuickDAV for Windows, macOS, and Linux.
WebDAV (Web Distributed Authoring and Versioning) is a protocol that allows users to access and manage files stored on a remote server. It is commonly used for web-based file sharing and collaboration, as it allows users to upload, download, and manage files directly from a web browser or file manager.
WebDAV is based on HTTP (Hypertext Transfer Protocol) and uses the same basic communication methods, but adds additional features and functionality specifically designed for file management. These features include support for file locking, collections, and metadata.
Nephele focuses on strict compliance with the implemented protocols. The specifications (RFCs) include keywords which determine what behavior is required to be fully compliant. Nephele follows all behaviors described as "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", and "NOT RECOMMENDED". Unless otherwise stated in an adapter's or authenticator's readme, the official adapters and authenticators also follow these behaviors.
If you find behavior in Nephele or the official adapters/authenticators that does not align with behavior described in the spec using the aforementioned keywords, this should be considered a bug, and a bug report in this repository would be greatly appreciated.
Nephele also prioritizes performance and stability. Nephele aims to minimize disk IO and memory usage. Nephele is already production ready, and aims to perform as well as or better than any other WebDAV server.
Nephele is currently a work in progress. You can install and run it, but building adapters and authenticators for it is not recommended yet, because the API may significantly change before the 1.0 release.
It is being actively developed by SciActive Inc for use in Port87.
Nephele will hopefully eventually support the following RFCs. I've included how likely version 1.0 is to support each RFC.
- Web Distributed Authoring and Versioning (WebDAV) Access Control Protocol (in progress)
- WebDAV Current Principal Extension (definitely)
- Extended MKCOL for Web Distributed Authoring and Versioning (WebDAV) (definitely)
- Web Distributed Authoring and Versioning (WebDAV) SEARCH (probably not)
- Calendaring Extensions to WebDAV (CalDAV) (maybe)
- Scheduling Extensions to CalDAV (probably not)
- Calendaring Extensions to WebDAV (CalDAV): Time Zones by Reference (probably not)
- Calendar Availability (probably not)
Once CardDAV and CalDAV are implemented, you should read and follow this RFC to make your server work well with CardDAV and CalDAV clients:
To bring up the testing server, run the testserver.ts file, like this.
mkdir testroot
env DEBUG="nephele:*" NODE_OPTIONS='--experimental-specifier-resolution=node' npx tsx testserver.ts testroot
If you want to run it without PAM authentication (allow unrestricted access to any user who can reach your host on the network), set the NOPAM env var, like this.
env NOPAM=true DEBUG="nephele:*" NODE_OPTIONS='--experimental-specifier-resolution=node' npx tsx testserver.ts testroot
You can also run the nephele-serve script like this.
./packages/nephele-serve/nephele-serve.cjs --no-auth -p 8080 ./testroot/
Nephele uses the MinIO S3 compatible object storage server for testing. To bring it up with Docker, run this.
docker compose -f testserver-docker-compose.yml up -d
Then use the MinIO console at http://127.0.0.1:9001 to create a bucket called "nephele". The username and password are both "minioadmin".
Then bring up the Nephele test server like this.
env S3ENDPOINT="http://127.0.0.1:8081" S3ACCESSKEY="minioadmin" S3SECRETKEY="minioadmin" S3BUCKET="nephele" NOPAM=true USERNAME="admin" PASSWORD="password" DEBUG="nephele:*" NODE_OPTIONS='--experimental-specifier-resolution=node' npx tsx testserver.ts
Nephele can use MySQL to run the Nymph adapter. To bring it up with Docker, run this.
docker compose -f testserver-docker-compose.yml up -d
Then bring up the Nephele server like this.
./packages/nephele-serve/nephele-serve.cjs -p 8080 --serve-listings --nymph --nymph-jwt-secret ff8ebb7d-5745-4cbd-b21d-0c5216597557 --nymph-db-driver mysql --nymph-mysql-username nephele --nymph-mysql-password nephele --nymph-mysql-database nephele ./testroot/
Copyright 2022-2024 SciActive Inc
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.