hausgold/redis

hausgold/redis 镜像文档

镜像概述

该 Docker 镜像基于 https://hub.docker.com/_/redis/ 构建，在其基础上集成了 mDNS/ZeroConf 栈。通过该镜像，您可以直接使用 redis 服务，并默认通过 mDNS 主机名 redis.local（端口 6379）访问，无需手动配置 DNS。

核心功能与特性

• 基于官方 redis 镜像：保留 redis 原生功能与性能，确保兼容性。
• 内置 mDNS 支持：默认注册 redis.local 主机名，实现服务自动发现。
• 自定义 mDNS 配置：支持修改 mDNS 主机名及添加多个别名（CNAME）。
• 灵活的 redis 参数配置：可通过环境变量传递额外的 redis-server 参数。
• 保留原生端口：默认暴露 redis 标准端口 6379，无需额外端口映射配置。

使用场景与适用范围

• 本地开发环境：无需手动配置 DNS 或 hosts 文件，通过 redis.local 快速访问 redis 服务。
• 测试环境：简化多服务协同测试时的服务发现配置。
• 小型部署场景：适用于对 DNS 配置要求较低、需要便捷访问 redis 的场景。

环境要求

使用该镜像前，主机需满足以下条件：

• 已安装并启用 Avahi 守护进程（avahi-daemon）。
• 已启用 mDNS NSS 查找（Name Service Switch，名称服务切换）。

快速开始

通过以下命令即可启动一个默认配置的 redis 服务：

bash
docker run --rm docker.xuanyuan.run/hausgold/redis

服务默认监听端口 6379，可通过 redis.local:6379 访问。

详细使用方法

Docker Compose 配置示例

以下是使用 docker-compose.yml 部署的示例，包含自定义 mDNS 主机名和额外 redis 参数：

yaml
services:
  redis:
    image: docker.xuanyuan.run/hausgold/redis
    environment:
      # 自定义 mDNS 主机名（需包含 .local 后缀）
      MDNS_HOSTNAME: redis.test.local
      # 传递额外的 redis-server 参数（默认值为空）
      REDIS_ARGS: --databases 1000  # 示例：设置数据库数量为 1000

主机配置（mDNS 支持）

为使主机能解析 mDNS 主机名，需完成以下配置：

1. 安装依赖包：
   安装 nss-mdns 包（提供 mDNS NSS 支持）：

   bash
   # Debian/Ubuntu
   sudo apt install nss-mdns
   
   # CentOS/RHEL
   sudo yum install nss-mdns
   
   # Arch Linux
   sudo pacman -S nss-mdns
   

2. 启用 Avahi 服务：
   启动并设置 Avahi 守护进程开机自启：

   bash
   sudo systemctl enable --now avahi-daemon.service
   

3. 配置 NSS 查找顺序：
   编辑 /etc/nsswitch.conf 文件，修改 hosts 行，添加 mdns4_minimal 模块：

   bash
   hosts: ... mdns4_minimal [NOTFOUND=return] resolve [!UNAVAIL=return] dns ...
   

自定义 mDNS 主机名

通过 MDNS_HOSTNAME 环境变量可自定义 mDNS 主机名（需包含 .local 后缀）。示例：

bash
docker run --rm -e MDNS_HOSTNAME=myredis.local docker.xuanyuan.run/hausgold/redis

此时 redis 服务可通过 myredis.local:6379 访问。

添加 mDNS 别名（CNAME）

通过 MDNS_CNAMES 环境变量可添加多个 mDNS 别名（逗号分隔）。示例：

bash
docker run --rm \
  -e MDNS_HOSTNAME=primary.redis.local \
  -e MDNS_CNAMES=secondary.redis.local,backup.redis.local \
  docker.xuanyuan.run/hausgold/redis

服务将同时通过以下主机名访问：primary.redis.local、secondary.redis.local、backup.redis.local。

使用其他顶级域名

默认 mDNS 顶级域名为 .local，但可通过 MDNS_HOSTNAME 指定其他域名（如 redis.test）。注意：使用非 .local 域名时，需额外配置主机的 Avahi 服务以支持自定义顶级域名（参考 https://wiki.archlinux.org/index.php/avahi#Configuring_mDNS_for_custom_TLD%EF%BC%89%E3%80%82

配置参数说明

参考资料

• https://github.com/Jack***/docker-mdns
• https://wiki.archlinux.org/index.php/avahi
• https://wiki.ubuntuusers.de/Avahi/
• https://hub.docker.com/_/redis/