tweaked readme

This commit is contained in:
Nils 2021-05-29 18:31:23 +02:00
parent 940a9c1209
commit 812ea6c447
Signed by: byreqz
GPG Key ID: 396A62D7D436749E
1 changed files with 27 additions and 1 deletions

View File

@ -1,2 +1,28 @@
# netdiscover-docker
dockerized mac-adress monitoring
this container will expose a netdiscover instance via http
currently supported (optional) arguments are:
- port // specifies the port (def. 8080)
- userpass // sets http basic auth - ex. user:pass (def. none)
- title // sets tab title (def. netdiscover-docker)
# docker compose
```yaml
version: '2.3'
services:
netdiscover-docker:
container_name: netdiscover-docker
network_mode: host
image: byreqz/netdiscover-docker:latest
restart: unless-stopped
# environment:
# - port=1234
# - userpass=user:pass
# - title=1234
```
# credits
Netdiscover: https://github.com/netdiscover-scanner/netdiscover <br>
GoTTY: https://github.com/yudai/gotty