webdav

go-webdav

A WebDAV server implementation in Go with support for multiple storage backends and flexible authorization rules.

⚠️ Disclaimer

This project is currently under active development and should be considered a work in progress. The API is in a preliminary stage and may not be stable. Please be aware that changes, including modifications, updates, or deprecations, can occur at any time without prior notice.

Features

• Multiple filesystem backends (Local, S3, SQLite)
• Dead properties support
• WebDAV locking support
• Configurable via JSON file and environment variables
• Can be used as a library

Usage

As a library

package main

import (
  "github.com/bornholm/go-webdav/handler"
  "github.com/bornholm/go-webdav/filesystem/local"
)

fs := local.NewFileSystem("my/dir")

h := handler.New(fs)

if err := http.ListenAndServe(":8080", handler); err != nil {
  panic(err)
}

As a server

Installation

go install github.com/bornholm/go-webdav/cmd/server@latest

Or build from source:

git clone https://github.com/bornholm/go-webdav.git
cd go-webdav
go build -o bin/server ./cmd/server

Usage

server [flags]

# Start server  with custom config file
./server -config ./config.json

# Start server on custom port with debug logging
./server -address :8080 -log-level DEBUG -config ./config.json

Configuration

The server can be configured via a JSON configuration file and/or environment variables (prefixed with GOWEBDAV_).

{
  "filesystem": {
    "type": "local",
    "options": {
      "dir": "/data/webdav"
    }
  },
  "cache": {
    "enabled": true,
    "ttl": "1h"
  },
  "mdns": {
    "enabled": true
  },
  "auth": {
    "enabled": true,
    "users": {
      "username_1": "password_1",
      "username_2": "password_2"
    }
  }
}

Filesystem backends

Stores files directly on the local filesystem.

{
  "filesystem": {
    "type": "local",
    "options": {
      "dir": "/path/to/webdav/root"
    }
  }
}

Stores files in an S3-compatible object storage service.

{
  "filesystem": {
    "type": "s3",
    "options": {
      "endpoint": "s3.amazonaws.com",
      "bucket": "my-webdav-bucket",
      "user": "ACCESS_KEY_ID",
      "secret": "SECRET_ACCESS_KEY",
      "secure": true,
      "region": "us-east-1",
      "bucketLookup": "dns"
    }
  }
}

Stores files in a SQLite database. Useful for embedded deployments or when a single-file storage is preferred.

{
  "filesystem": {
    "type": "sqlite",
    "options": {
      "path": "/data/webdav.db"
    }
  }
}

Environment Variables

Some configuration options can be set via environment variables with the GOWEBDAV_ prefix. Nested options use underscores as separators.

Examples:

• GOWEBDAV_FILESYSTEM_TYPE=local
• GOWEBDAV_FILESYSTEM_OPTIONS='{"dir":"/dir/path"}'

See ./cmd/server/config.go for more informations.

Development

Running Tests

go test ./...

Running Benchmarks

make benchmark

License

See LICENSE file for details.