Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
damonmorgan authored May 8, 2024
1 parent f3396ad commit e59ab53
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# mDNS/Avahi Docker Image

Docker image for the Avahi mDNS/DNS-SD daemon. Connects to the system D-Bus, publishes the hostname and announces Host rules. Container requires network host, priveleged and access to the docker sock
Docker image for the Avahi mDNS/DNS-SD daemon. Connects to the system D-Bus, publishes the hostname and announces Host rules. Container requires network host, privileged and access to the docker sock

Should work on any *nix based system with dbus. Tested on Ubuntu Server.

Expand All @@ -22,7 +22,7 @@ docker create \
--network host \
--privileged \
--restart unless-stopped \
damonmorgan/traefik-mdns
damonmorgan/docker-mdns
```


Expand All @@ -38,7 +38,7 @@ services:
#mDNS
mdns:
container_name: mdns
image: damonmorgan/traefik-mdns
image: damonmorgan/docker-mdns
environment:
SERVER_HOST_NAME: 'docker'
SERVER_DOMAIN_NAME: 'local'
Expand All @@ -60,12 +60,18 @@ services:
- "--api.dashboard=true"
- "--providers.docker=true"
- "--providers.docker.exposedbydefault=false"
- "--providers.docker.defaultRule=HostRegexp(`^{{ .ContainerName }}.*$`)"
- "--entrypoints.web.address=:80"
ports:
- "80:80"
- "8080:8080"
volumes:
- /var/run/docker.sock:/var/run/docker.sock:ro
labels:
- "mdns.host=traefik.local"
- "traefik.enable=true"
- "traefik.http.routers.admin.entrypoints=web"
- "traefik.http.services.admin.loadbalancer.server.port=8080"
restart: unless-stopped
#Basic Web Service
Expand All @@ -75,16 +81,14 @@ services:
labels:
- "mdns.host=whoami.local"
- "traefik.enable=true"
- "traefik.http.routers.whoami.rule=Host(`whoami.local`)"
- "traefik.http.routers.whoami.entrypoints=web"
- "traefik.http.services.whoami.loadbalancer.server.port=80"
```

## TODO

* If possible remove requirement for priveleged (currently required because of AppArmor policies)
* If possible remove requirement for privileged (currently required because of AppArmor policies)
* If possible remove network host requirment (although it would still need to know the host IP)
* Make it more generic to work with any reverse proxy (nginx, caddy, traefik, etc.) - potentially use container_name.local

PRs welcomed.

Expand All @@ -97,5 +101,6 @@ PRs welcomed.

[https://gitlab.com/viraptor/docker_mdns](https://gitlab.com/viraptor/docker_mdns)

[linuxserverurl]: https://linuxserver.io
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
[https://github.com/phyber/docker-mdns](https://github.com/phyber/docker-mdns)

[linuxserver.io](https://linuxserver.io)

0 comments on commit e59ab53

Please sign in to comment.