*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](https://en.wikipedia.org/wiki/Comparison_of_WebDAV_software#WebDAV_clients)).
If you'd like to move your setup behind a proxy / gateway under a specific path, you can set the config variable `prefix` to match the url-prefix of your proxy configuration.
For example: If you have a rule that proxies all requests of `https://domain.com/webdav` to `https://localhost:8000`, you have to set the prefix to `/webdav`.
address: "127.0.0.1" # the bind address
port: "8000" # the listening port
prefix: "/webdav" # the url-prefix of the original url
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.
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 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](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
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).
