swd - The simple webdav server

swd is a simple webdav server that provides the following features:

• Single binary that runs under Windows, Linux and OSX.
• Authentication via HTTP-Basic.
• TLS support - if needed.
• A simple user management which allows user-directory-jails as well as full admin access to all subdirectories.
• Live config reload to allow editing of users without downtime.
• A cli tool to generate BCrypt password hashes.

It perfectly fits if you would like to give some people the possibility to upload, download or share files with common tools like the OSX Finder, Windows Explorer or Nautilus under Linux (or many other tools).

Table of Contents

• Configuration
  • First steps
  • TLS
  • User management
  • Live reload
• Installation
  • Binary-Installation
  • Build from sources
  • Build with docker
• Connecting
• Contributing
• License

Configuration

The configuration is done in form of a yaml file. swd will scan the following locations for the presence of a config.yaml in the following order:

• The directory ./config
• The directory $HOME/.swd
• The current working directory .

First steps

Here an example of a very simple but functional configuration:

	address: "127.0.0.1"    # the bind address
	port: "8000"            # the listening port
	dir: "/home/webdav"     # the provided base dir
	users:
	  user:                 # with password 'foo' and jailed access to '/home/webdav/user'
	    password: "$2a$10$yITzSSNJZAdDZs8iVBQzkuZCzZ49PyjTiPIrmBUKUpB0pwX7eySvW"
	    subdir: "/user"
	  admin:                # with password 'foo' and access to '/home/webdav'
	    password: "$2a$10$DaWhagZaxWnWAOXY0a55.eaYccgtMOL3lGlqI3spqIBGyM0MD.EN6"

TLS

At first, use your favorite toolchain to obtain a SSL certificate and keyfile (if you don't already have some).

Here an example with openssl:

	# Generate a keypair
	openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days 365
	# Remove the passphrase from the key file
	openssl rsa -in key.pem -out clean_key.pem

Now you can reference your keypair in the configuration via:

	address: "127.0.0.1"    # the bind address
	port: "8000"            # the listening port
	dir: "/home/webdav"     # the provided base directory
	tls:
	  keyFile: clean_key.pem
	  certFile: cert.pem
	users:
	...

The presence of the tls section is completely enough to let the server start with a TLS secured https connection.

In the current release version you must take care, that the private key doesn't need a passphrase. Otherwise starting the server will fail.

User management

User management in swd is very simple. Each user in the config.yaml MUST have a password and CAN have a subdirectory.

The password must be in form of an BCrypt hash. You can generate one calling the shipped cli tool swdcli passwd.

If an subdirectory is configured for an user, the user is jailed within it and can't see anything that exists outside of this directory. If no subdirectory is configured for an user, the user can see and modify all files within the base directory.

Live reload

If you're editing the user section of the configuration to:

• Remove an user
• Add an user
• Add, remove or change an user's subdirectory
• Update an users password

There is no need to restart the server itself. The config file will be re-read and the application will update it's own configuration silently in background.

Installation

Binary installation

You can check out the releases page for the latest binaries or simply execute go get -u github.com/micromata/swd to install the binaries into your $GOPATH/bin directory.

Build from sources

At first you have to clone the repository with:

	git clone git@github.com:micromata/swd.git

To build and install from sources you have two major possibilites:

go install

You can use the plain go toolchain and install the project to your $GOPATH via: go install ./....

magefile

You can also use mage to build the project.

Please ensure you've got mage installed. This can be done with the following steps:

	go get -u -d github.com/magefile/mage
	cd $GOPATH/src/github.com/magefile/mage
	go run bootstrap.go

Now you can call mage install to build and install the binaries. If you just call mage, you'll get a list of possible targets:

	Targets:
	  build            Builds swd and swdcli and moves it to the dist directory
	  buildReleases    Builds swd and swdcli for different OS and package them to a zip file for each os
	  check            Runs golint and go tool vet on each .go file.
	  clean            Removes the dist directory
	  fmt              Formats the code via gofmt
	  install          Installs swd and swdcli to your $GOPATH/bin folder
	  installDeps      Runs dep ensure and installs additional dependencies.

Connecting

You could simply connect to the webdav server with a http(s) connection and a tool that allows the webdav protocol.

For example: Under OSX you can use the default file management tool Finder. Press CMD+K, enter the server address (e.g. http://localhost:8000) and choose connect.

Contributing

Everyone is welcome to create pull requests for this project. If you're new to github, take a look here to get an idea of it.

If you'd like to contribute, please make sure to use the magefile and execute and check the following commands before starting a PR:

	mage fmt
	mage check

If you've got an idea of a function that should find it's way into this project, but you won't implement it by yourself, please create a new issue.

License

Please be aware of the licenses of the components we use in this project. Everything else that has been developed by the contributions to this project is under Apache 2 License.