Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hausgold/docker-node
mDNS enabled official/node image
https://github.com/hausgold/docker-node
docker docker-image mdns node oss zeroconf
Last synced: 3 months ago
JSON representation
mDNS enabled official/node image
- Host: GitHub
- URL: https://github.com/hausgold/docker-node
- Owner: hausgold
- License: mit
- Created: 2017-08-03T17:21:18.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T06:52:23.000Z (4 months ago)
- Last Synced: 2024-10-21T09:48:10.589Z (4 months ago)
- Topics: docker, docker-image, mdns, node, oss, zeroconf
- Language: Shell
- Homepage: https://hub.docker.com/r/hausgold/node/
- Size: 102 KB
- Stars: 2
- Watchers: 13
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
![mDNS enabled official/node](https://raw.githubusercontent.com/hausgold/docker-node/master/docs/assets/project.png)
[![Continuous Integration](https://github.com/hausgold/docker-node/actions/workflows/package.yml/badge.svg?branch=master)](https://github.com/hausgold/docker-node/actions/workflows/package.yml)
[![Source Code](https://img.shields.io/badge/source-on%20github-blue.svg)](https://github.com/hausgold/docker-node)
[![Docker Image](https://img.shields.io/badge/image-on%20docker%20hub-blue.svg)](https://hub.docker.com/r/hausgold/node/)This Docker images provides the [official/node](https://hub.docker.com/_/node/) image as base with
the mDNS/ZeroConf stack on top. So you can enjoy your [node](https://nodejs.org/) app
while it is accessible by default as *node.local*. (Port 80)- [Requirements](#requirements)
- [Getting starting](#getting-starting)
- [docker-compose usage example](#docker-compose-usage-example)
- [Host configs](#host-configs)
- [Configure a different mDNS hostname](#configure-a-different-mdns-hostname)
- [Other top level domains](#other-top-level-domains)
- [Further reading](#further-reading)## Requirements
* Host enabled Avahi daemon
* Host enabled mDNS NSS lookup## Getting starting
You just need to run it like that, to get a working node:
```bash
$ docker run --rm hausgold/node
```The port 3000 is proxied by haproxy to port 80 to make *node.local*
directly accessible. The port 3000 is untouched.## docker-compose usage example
```yaml
node:
image: hausgold/node
environment:
# Mind the .local suffix
- MDNS_HOSTNAME=node.test.local
ports:
# The ports are just for you to know when configure your
# container links, on depended containers
- "3000"
```## Host configs
Install the nss-mdns package, enable and start the avahi-daemon.service. Then,
edit the file /etc/nsswitch.conf and change the hosts line like this:```bash
hosts: ... mdns4_minimal [NOTFOUND=return] resolve [!UNAVAIL=return] dns ...
```## Configure a different mDNS hostname
The magic environment variable is *MDNS_HOSTNAME*. Just pass it like that to
your docker run command:```bash
$ docker run --rm -e MDNS_HOSTNAME=something.else.local hausgold/node
```This will result in *something.else.local*.
You can also configure multiple aliases (CNAME's) for your container by
passing the *MDNS_CNAMES* environment variable. It will register all the comma
separated domains as aliases for the container, next to the regular mDNS
hostname.```bash
$ docker run --rm \
-e MDNS_HOSTNAME=something.else.local \
-e MDNS_CNAMES=nothing.else.local,special.local \
hausgold/node
```This will result in *something.else.local*, *nothing.else.local* and
*special.local*.## Other top level domains
By default *.local* is the default mDNS top level domain. This images does not
force you to use it. But if you do not use the default *.local* top level
domain, you need to [configure your host avahi][custom_mdns] to accept it.## Further reading
* Docker/mDNS demo: https://github.com/Jack12816/docker-mdns
* Archlinux howto: https://wiki.archlinux.org/index.php/avahi
* Ubuntu/Debian howto: https://wiki.ubuntuusers.de/Avahi/[custom_mdns]: https://wiki.archlinux.org/index.php/avahi#Configuring_mDNS_for_custom_TLD