dave/Readme.md

[![Build Status](https://travis-ci.org/micromata/dave.svg?branch=master)](https://travis-ci.org/micromata/dave)
[![Go Report](https://goreportcard.com/badge/github.com/micromata/dave)](https://goreportcard.com/report/github.com/micromata/dave)

# dave - The simple webdav server

_dave_ 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](https://en.wikipedia.org/wiki/Comparison_of_WebDAV_software#WebDAV_clients)).

The project name _dave_ is an abbreviation for: **D**istributed **A**uthoring and **V**ersioning made **e**asy.

## Table of Contents

- [Configuration](#configuration)
  * [First steps](#first-steps)
  * [TLS](#tls)
  * [Behind a proxy](#behind-a-proxy)
  * [User management](#user-management)
  * [Logging](#logging)
  * [Live reload](#live-reload)
- [Installation](#installation)
  * [Binary-Installation](#binary-installation)
  * [Build from sources](#build-from-sources)
  * [Build and run with Docker](#build-and-run-with-docker)
- [Connecting](#connecting)
- [Contributing](#contributing)
- [License](#license)

## Configuration

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

- The directory `./config`
- The directory `$HOME/.swd` (swd was the initial project name of dave)
- The directory `$HOME/.dave`
- 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
	prefix: "/webdav"       # the url-prefix of the original url
	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"

With this configuration you'll grant access for two users and the webdav
server is available under `http://127.0.0.1:8000/webdav`.

### 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.

### Behind a proxy

_dave_ will also work behind a reverse proxy. Here is an example
configuration with `apache2 httpd`'s `mod_proxy`:

    <Location /webdav>
      ProxyPass           https://webdav-host:8000/
      ProxyPassReverse    https://webdav-host:8000/
    </Location>

### User management

User management in _dave_ 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 a BCrypt hash. You can generate one calling the shipped cli tool `davecli passwd`.

If a subdirectory is configured for a 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.

### Logging

You can enable / disable logging for the following operations:

- **C**reation of files or directories
- **R**eading of files or directories
- **U**pdating of files or directories
- **D**eletion of files or directories

You can also enable or disable the error log.

All file-operation logs are disabled per default until you will turn it on via the following config entries:

```yaml
address: "127.0.0.1"    # the bind address
port: "8000"            # the listening port
dir: "/home/webdav"     # the provided base directory
log:
  error: true
  create: true
  read: true
  update: true
  delete: true
...
```

Be aware, that the log pattern of an attached tty differs from the log pattern of a detached tty.

Example of an attached tty:

	INFO[0000] Server is starting and listening              address=0.0.0.0 port=8000 security=none

Example of a detached tty:

	time="2018-04-14T20:46:00+02:00" level=info msg="Server is starting and listening" address=0.0.0.0 port=8000 security=none

### Live reload

There is no need to restart the server itself, if you're editing the user or log section of the configuration. 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](https://github.com/micromata/dave/releases) for the latest precompiled binaries.

Otherwise you can use the binary installation via go get:

```
go get github.com/micromata/dave/cmd/...
```

### Build from sources

#### Setup

1. Ensure you've setup _go_ Take a look at the [installation guide](https://golang.org/doc/install) and how you [setup your path](https://github.com/golang/go/wiki/SettingGOPATH)
2. Create a source directory and change your working directory

```
mkdir -p $GOPATH/src/github.com/micromata/ && cd $GOPATH/src/github.com/micromata
```

3. Clone the repository (or your fork)

```
git clone git@github.com:micromata/dave.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:

```
cd $GOPATH/src/github.com/micromata/dave && go install ./...
```

#### magefile

You can also use mage to build the project.

Please ensure you've got [mage](https://magefile.org) 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 dave and davecli and moves it to the dist directory
	  buildReleases    Builds dave and davecli 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 dave and davecli to your $GOPATH/bin folder
	  installDeps      Runs dep ensure and installs additional dependencies.

### Build and run with Docker

Building dave with Docker is simple

	git clone git@github.com:micromata/dave.git
	cd dave
	docker build -t dave .

Let dave run
    
	# create webdav home
	mkdir webdav-home
	
	docker run -d \
		-p 8000:8000 \
		-v $(pwd)/examples/config-sample.yaml:/config.yaml:ro \
		-v $(pwd)/webdav-home:/tmp:rw \
		dave

To export the static binary simply run

    docker run --rm --entrypoint="" dave cat /usr/local/bin/dave > dave
    chmod u+x dave

## 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](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/)
to get an idea of it.

If you'd like to contribute, please make sure to use the [magefile](#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](LICENSE.txt).