happydomain/happydomain

happyDomain Docker镜像文档

镜像概述和主要用途

happyDomain是一款免费的Web应用，用于集中管理来自不同注册商和主机的域名。它由Golang编写的HTTP REST API（基于dnscontrol和miekg/dns库）和Svelte构建的Web界面组成，以无状态Linux二进制文件运行，支持数据库存储（当前为LevelDB，更多类型即将支持）。

核心功能和特性

• 超快速Web界面：无需妥协的流畅用户体验
• 多域名管理：集中管理多个域名
• 广泛的DNS提供商支持：通过DNSControl支持44+种DNS提供商（包括动态DNS、RFC 2136）
• 最新资源记录支持：基于CoreDNS库支持最新的DNS资源记录
• 带差异视图的区域编辑器：在变更传播前查看差异对比
• 变更历史记录：保留已发布变更的历史
• 上下文帮助：提供操作指导
• 灵活认证：支持多用户认证或无认证单用户模式
• 外部认证兼容：通过JWT令牌支持外部认证（如Auth0等）

注意：happyDomain虽已具备功能，但仍在持续开发中。如遇到问题，请通过https://github.com/happyDomain/happydomain/issues%E5%8F%8D%E9%A6%88%EF%BC%8C%E9%A1%B9%E7%9B%AE%E5%9B%A2%E9%98%9F%E5%93%8D%E5%BA%94%E8%BF%85%E9%80%9F%E3%80%82

使用场景和适用范围

• 个人或企业需要管理来自多个注册商的域名
• 需要统一界面管理不同DNS提供商的域名解析
• 希望跟踪域名配置变更历史的用户
• 需要团队协作管理域名的组织
• 寻求简化DNS配置流程的技术人员

使用方法和配置说明

Docker部署

使用docker compose

bash
git clone https://framagit.org/happyDomain/happyDomain.git
cd happyDomain
docker compose up

使用docker run直接启动

bash
docker run -e HAPPYDOMAIN_NO_AUTH=1 -p 8081:8081 happydomain/happydomain

此命令将以评估模式启动happyDomain（无认证、临时存储），几秒钟内即可使用。通过浏览器访问http://localhost:8081即可开始使用。

支持的标签和架构

所有标签均基于Alpine构建，支持以下架构：amd64、arm64、arm/v7。

当前可用标签：

• latest：最新版本，对应master分支

配置说明

happyDomain启动时从以HAPPYDOMAIN_为前缀的环境变量读取配置。文档中配置项使用kebab-case（如storage-engine），转换为环境变量时需：

• 将短横线(-)替换为下划线(_)
• 转换为大写字母
• 添加HAPPYDOMAIN_前缀

数据库配置

默认使用LevelDB存储引擎，可通过HAPPYDOMAIN_STORAGE_ENGINE环境变量更改。运行./happydomain -help可查看支持的引擎：

-storage-engine value
    Select the storage engine between [leveldb mysql] (default leveldb)

LevelDB配置

LevelDB是嵌入式键值存储（无需额外守护进程），配置参数：

-e HAPPYDOMAIN_LEVELDB_PATH=string
    LevelDB数据库路径（默认"happydomain.db"）

默认在二进制文件附近创建happydomain.db目录存储数据库，可修改为更持久的路径。

高级配置

详见完整文档。

管理界面

happyDomain通过Unix socket提供管理命令，容器内包含hadmin脚本用于访问管理功能：

bash
# 查看用户列表
docker exec my_container hadmin /api/users

# 发送用户验证邮件
docker exec my_container hadmin /api/users/0123456789/send_validation_email -X POST

hadmin本质是curl的包装器，使用时需先指定URL，选项放在后面。