https://github.com/hausgold/docker-valkey
mDNS enabled valkey/valkey image
https://github.com/hausgold/docker-valkey
docker docker-image mdns oss redis valkey zeroconf
Last synced: 7 months ago
JSON representation
mDNS enabled valkey/valkey image
- Host: GitHub
- URL: https://github.com/hausgold/docker-valkey
- Owner: hausgold
- License: mit
- Created: 2025-01-15T03:50:57.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2025-01-15T04:09:44.000Z (12 months ago)
- Last Synced: 2025-03-30T12:02:06.013Z (10 months ago)
- Topics: docker, docker-image, mdns, oss, redis, valkey, zeroconf
- Language: Shell
- Homepage: https://hub.docker.com/r/hausgold/valkey/
- Size: 23.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/hausgold/docker-valkey/actions/workflows/package.yml)
[](https://github.com/hausgold/docker-valkey)
[](https://hub.docker.com/r/hausgold/valkey/)
This Docker images provides the [valkey/valkey](https://hub.docker.com/r/valkey/valkey/) image as base
with the mDNS/ZeroConf stack on top. So you can enjoy [Valkey](https://valkey.io/) while
it is accessible by default as *valkey.local*. (Port 6379)
- [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 Valkey:
```bash
$ docker run --rm hausgold/valkey
```
The port 6379 is untouched.
## docker-compose usage example
```yaml
services:
valkey:
image: hausgold/valkey
environment:
# Mind the .local suffix
MDNS_HOSTNAME: valkey.test.local
# We allow additional valkey-server arguments via: (default)
VALKEY_ARGS: --databases 1000
```
## 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/valkey
```
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/valkey
```
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