WSGI WebDAV Server

4.3.3 · active · verified Fri Apr 17

WsgiDAV is a generic and extensible WebDAV server implementation based on WSGI. It allows access to file systems or other storage backends via HTTP, supporting features like locking, versioning, and properties. Currently at version 4.3.3, it receives frequent minor updates with a focus on stability and compatibility.

Common errors

```
ModuleNotFoundError: No module named 'wsgidav.dir_browser'
```
cause This import path was deprecated and moved in WsgiDAV v4.0.0.

fix Update your import statement from `from wsgidav import dir_browser` or similar to `from wsgidav.frontend import dir_browser`.
```
TypeError: WsgiDAVApp() got an unexpected keyword argument 'verbose'
```
cause Configuration option names changed in v4.0.0.

fix The `verbose` option was renamed. Replace `verbose` with `debug_info` in your configuration dictionary (e.g., `"debug_info": True`). Refer to the v4 documentation for current configuration options.
```
FileNotFoundError: [Errno 2] No such file or directory: 'some_path'
```
cause This typically occurs when `FileSystemProvider` is configured with a path that doesn't exist or isn't accessible to the WsgiDAV process.

fix Ensure the directory specified for `FileSystemProvider` (e.g., in `provider_mapping`) exists and the user running WsgiDAV has read/write permissions to it. Create the directory if it's missing.

Warnings

breaking WsgiDAV v4.0.0 introduced significant breaking changes, dropping Python 2 support and requiring Python 3.6+ (now 3.8+).
Fix: Upgrade your Python environment to 3.8+. Review the v4.0.0 changelog for necessary code migrations, especially around configuration, imports, and authentication. Many internal modules were moved or renamed.
breaking The configuration format changed significantly in v4.0.0, with many options renamed or restructured (e.g., `provider_mapping` to `roots` in some contexts, `verbose` to `debug_info`).
Fix: If upgrading from pre-v4, re-write your `config` dictionary based on the v4 documentation and examples. Pay close attention to `provider_mapping`, `http_authenticator`, and `dir_browser` sections.
gotcha By default, `wsgidav` expects a WSGI server to run it. While `wsgidav.server.run_server` provides a simple built-in server (Cheroot), it's not recommended for production.
Fix: For production deployments, pass the `WsgiDAVApp` instance to a robust WSGI server like Gunicorn, uWSGI, or mod_wsgi. E.g., `gunicorn 'wsgidav.wsgidav_app:WsgiDAVApp(config)'` (adjusting config loading).
deprecated The `wsgidav.dir_browser` module was deprecated and moved to `wsgidav.frontend.dir_browser` in v4.0.0.
Fix: Update any direct imports or references to `wsgidav.dir_browser` to `wsgidav.frontend.dir_browser`.

Install

pip install wsgidav Install core library
pip install wsgidav[server] Install with default server (Cheroot)
pip install wsgidav[yaml] Install with YAML config support

Imports

WsgiDAVApp
wrong:
```
from wsgidav import WsgiDAVApp
```
correct:
```
from wsgidav.wsgidav_app import WsgiDAVApp
```
The main WSGI application class was moved to a submodule in v4.0.0.

FileSystemProvider

from wsgidav.fs_dav_provider import FileSystemProvider

run_server
wrong:
```
from wsgidav.wsgidav_app import run_server
```
correct:
```
from wsgidav.server import run_server
```
The server running utility was moved to its own submodule in v4.0.0.

Quickstart

This quickstart demonstrates how to set up a basic, anonymous WebDAV server serving a local directory using WsgiDAV programmatically. It creates a temporary directory and a sample file, then starts the server on `http://127.0.0.1:8080`. For production deployments, `WsgiDAVApp` should be integrated with a robust WSGI server like Gunicorn or uWSGI, and authentication should be configured.

import os
from wsgidav.wsgidav_app import WsgiDAVApp
from wsgidav.fs_dav_provider import FileSystemProvider
from wsgidav.server import run_server

# Create a temporary directory for the WebDAV root
dav_root = os.path.join(os.getcwd(), 'my_webdav_root')
os.makedirs(dav_root, exist_ok=True)

# Create a simple file inside the root
with open(os.path.join(dav_root, 'hello.txt'), 'w') as f:
    f.write('Hello, WebDAV!')

config = {
    "host": "127.0.0.1",
    "port": 8080,
    "provider_mapping": {
        "/": FileSystemProvider(dav_root)
    },
    "http_authenticator": {
        "domain_controller": None, # No authentication
        "accept_anonymous": True
    },
    "verbose": 1,
    "dir_browser": {
        "enable": True,
        "remotefs": {
            "enable": True,
            "mount_url": "/",
        }
    }
}

print(f"Starting WsgiDAV server on http://{config['host']}:{config['port']}")
print(f"Serving files from: {dav_root}")
print("Open http://127.0.0.1:8080/ in your browser to test.")

# Run the server. This is a blocking call.
# For production, integrate WsgiDAVApp with a full WSGI server like Gunicorn or uWSGI.
run_server(config)

view raw JSON →