Update readme.

This commit is contained in:
Jonas Pedersen 2019-06-14 08:42:54 +02:00
parent cd607b1ec8
commit 7093be25ef

View file

@ -1,19 +1,23 @@
# wsdd-docker # wsdd-docker
Docker container for wsdd.py. Docker image for wsdd.py.
wsdd implements a Web Service Discovery host daemon. This enables (Samba) hosts, like your local NAS device, to be found by Web Service Discovery Clients like Windows. wsdd implements a Web Service Discovery host daemon. This enables (Samba) hosts, like your local NAS device or Linux server, to be found by Web Service Discovery Clients like Windows.
## Running container ## Running container
### From command line ### From command line
`docker run --net=host -e HOSTNAME=$(hostname) jonasped/wsdd` ```
docker run --net=host -e HOSTNAME=$(hostname) jonasped/wsdd
```
It is important that the container is run with the argument --net=host and that the environment variabel HOSTNAME is set to the same value as your Samba netbios name. Samba netbios name defaults to the hostname. It is important that the container is run with the argument --net=host and that the environment variabel HOSTNAME is set to the same value as your Samba netbios name. Samba netbios name defaults to the hostname.
### From docker compose ### From docker compose
A docker-compose.yml file could look like the one below. A docker-compose.yml file could look like the one below.
` wsdd: ```
wsdd:
image: "jonasped/wsdd" image: "jonasped/wsdd"
environment: environment:
- HOSTNAME=NETBIOS_NAME - HOSTNAME=NETBIOS_NAME
restart: unless-stopped restart: unless-stopped
network_mode: "host"` network_mode: "host"
```