hosted
/
webdav-docker
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Format README.md for Docker Hub

Browse Source
master
Jamie Nguyen 6 years ago
parent 80ec02e320
commit a0f0dbb636
1 changed files with 19 additions and 52 deletions
Show Stats Download Patch File Download Diff File

71
README.md
Unescape View File

@ -6,8 +6,7 @@
This image runs an easily configurable WebDAV server with Apache. This image runs an easily configurable WebDAV server with Apache.
You can configure the authentication type, the authentication of multiple You can configure the authentication type, the authentication of multiple users, or to run with a self-signed SSL certificate.
users, or to run with a self-signed SSL certificate.
* **Code repository:** * **Code repository:**
https://github.com/BytemarkHosting/docker-webdav https://github.com/BytemarkHosting/docker-webdav
@ -22,15 +21,11 @@ users, or to run with a self-signed SSL certificate.
### Basic WebDAV server ### Basic WebDAV server
This example starts a WebDAV server on port 80. It can only be accessed by This example starts a WebDAV server on port 80. It can only be accessed with a single username and password.
a single username and password.
When using unencrypted HTTP, use `Digest` authentication (instead of `Basic`) When using unencrypted HTTP, use `Digest` authentication (instead of `Basic`) to avoid sending plaintext passwords in the clear.
to avoid sending plaintext passwords in the clear.
To make sure your data doesn't get deleted, you'll probably want to create a To make sure your data doesn't get deleted, you'll probably want to create a persistent storage volume (`-v vol-webdav:/var/lib/dav`) or bind mount a directory (`-v /path/to/directory:/var/lib/dav`):
persistent storage volume (`-v vol-webdav:/var/lib/dav`) or bind mount a
directory (`-v /path/to/directory:/var/lib/dav`):
``` ```
docker run --restart always -v /srv/dav:/var/lib/dav \ docker run --restart always -v /srv/dav:/var/lib/dav \
@ -61,8 +56,7 @@ services:
We recommend you use a reverse proxy (eg, Traefik) to handle SSL certificates. We recommend you use a reverse proxy (eg, Traefik) to handle SSL certificates.
If you're happy with a self-signed SSL certificate, specify `-e If you're happy with a self-signed SSL certificate, specify `-e SSL_CERT=selfsigned` and the container will generate one for you.
SSL_CERT=selfsigned` and the container will generate one for you.
``` ```
docker run --restart always -v /srv/dav:/var/lib/dav \ docker run --restart always -v /srv/dav:/var/lib/dav \
@ -71,14 +65,11 @@ docker run --restart always -v /srv/dav:/var/lib/dav \
``` ```
If you bind mount a certificate chain to `/cert.pem` and a private key to If you bind mount a certificate chain to `/cert.pem` and a private key to `/privkey.pem`, the container will use that instead!
`/privkey.pem`, the container will use that instead!
### Authenticate multiple clients ### Authenticate multiple clients
Specifying `USERNAME` and `PASSWORD` only supports a single user. If you want Specifying `USERNAME` and `PASSWORD` only supports a single user. If you want to have lots of different logins for various users, bind mount your own file to `/user.passwd` and the container will use that instead.
to have lots of different logins for various users, bind mount your own file to
`/user.passwd` and the container will use that instead.
If using `Basic` authentication, run the following commands: If using `Basic` authentication, run the following commands:
@ -89,9 +80,7 @@ htpasswd -B user.passwd bob
``` ```
If using `Digest` authentication, run the following commands. (NB: The default If using `Digest` authentication, run the following commands. (NB: The default `REALM` is `WebDAV`. If you specify your own `REALM`, you'll need to run `htdigest` again with the new name.)
`REALM` is `WebDAV`. If you specify your own `REALM`, you'll need to run
`htdigest` again with the new name.)
``` ```
@ -101,40 +90,18 @@ htdigest user.passwd WebDAV bob
``` ```
Once you've created your own `user.passwd`, bind mount it into your container Once you've created your own `user.passwd`, bind mount it into your container with `-v /path/to/user.passwd:/user.passwd`.
with `-v /path/to/user.passwd:/user.passwd`.
### Environment variables ### Environment variables
All environment variables are optional. You probably want to at least specify All environment variables are optional. You probably want to at least specify `USERNAME` and `PASSWORD` (or bind mount your own authentication file to `/user.passwd`) otherwise nobody will be able to access your WebDAV server!
`USERNAME` and `PASSWORD` (or bind mount your own authentication file to
`/user.passwd`) otherwise nobody will be able to access your WebDAV server! * **`SERVER_NAMES`**: Comma-separated list of domains (eg, `example.com,www.example.com`). The first is set as the [ServerName](https://httpd.apache.org/docs/current/mod/core.html#servername), and the rest (if any) are set as [ServerAlias](https://httpd.apache.org/docs/current/mod/core.html#serveralias). The default is `localhost`.
* **`LOCATION`**: The URL path for WebDAV (eg, if set to `/webdav` then clients should connect to `example.com/webdav`). The default is `/`.
* **`SERVER_NAMES`**: Comma-separated list of domains (eg, * **`AUTH_TYPE`**: Apache authentication type to use. This can be `Basic` (best choice for HTTPS) or `Digest` (best choice for HTTP). The default is `Basic`.
`example.com,www.example.com`). The first is set as the * **`REALM`**: Sets [AuthName](https://httpd.apache.org/docs/current/mod/mod_authn_core.html#authname), an identifier that is displayed to clients when they connect. The default is `WebDAV`.
[ServerName](https://httpd.apache.org/docs/current/mod/core.html#servername), * **`USERNAME`**: Authenticate with this username (and the password below). This is ignored if you bind mount your own authentication file to `/user.passwd`.
and the rest (if any) are set as * **`PASSWORD`**: Authenticate with this password (and the username above). This is ignored if you bind mount your own authentication file to `/user.passwd`.
[ServerAlias](https://httpd.apache.org/docs/current/mod/core.html#serveralias). * **`ANONYMOUS_METHODS`**: Comma-separated list of HTTP request methods (eg, `GET,POST,OPTIONS,PROPFIND`). Clients can use any method you specify here without authentication. Set to `ALL` to disable authentication. The default is to disallow any anonymous access.
The default is `localhost`. * **`SSL_CERT`**: Set to `selfsigned` to generate a self-signed certificate and enable Apache's SSL module. If you specify `SERVER_NAMES`, the first domain is set as the Common Name.
* **`LOCATION`**: The URL path for WebDAV (eg, if set to `/webdav` then clients
should connect to `example.com/webdav`). The default is `/`.
* **`AUTH_TYPE`**: Apache authentication type to use. This can be `Basic` (best
choice for HTTPS) or `Digest` (best choice for HTTP). The default is `Basic`.
* **`REALM`**: Sets
[AuthName](https://httpd.apache.org/docs/current/mod/mod_authn_core.html#authname),
an identifier that is displayed to clients when they connect. The default is
`WebDAV`.
* **`USERNAME`**: Authenticate with this username (and the password below).
This is ignored if you bind mount your own authentication file to
`/user.passwd`.
* **`PASSWORD`**: Authenticate with this password (and the username above).
This is ignored if you bind mount your own authentication file to
`/user.passwd`.
* **`ANONYMOUS_METHODS`**: Comma-separated list of HTTP request methods (eg,
`GET,POST,OPTIONS,PROPFIND`). Clients can use any method you specify here
without authentication. Set to `ALL` to disable authentication. The default
is to disallow any anonymous access.
* **`SSL_CERT`**: Set to `selfsigned` to generate a self-signed certificate and
enable Apache's SSL module. If you specify `SERVER_NAMES`, the first domain
is set as the Common Name.

Write Preview
Loading…
Cancel
Save