blockstack/subdomain-registrar

blockstack/subdomain-registrar 镜像文档

镜像概述

本镜像为 quay.io/blockstack/subdomain-registrar 的镜像，主要用于提供子域名注册服务。通过Docker容器化部署，简化了子域名注册相关的配置与运行流程，适用于需要管理子域名注册队列及监控zonefiles广播的场景。

核心功能和特性

• 配置文件管理：支持自定义配置文件，可根据需求修改服务参数
• 数据持久化：使用SQLite数据库存储注册队列信息及zonefiles监控数据，确保数据持久化
• 多部署方式：支持通过docker-compose或直接docker命令部署
• API接口：提供状态检查接口，方便验证服务运行状态

使用场景和适用范围

适用于需要部署子域名注册服务的开发者或运维人员，尤其适合需要快速搭建子域名注册系统、管理注册队列及监控zonefiles广播状态的场景。

使用方法和配置说明

前置准备

1. 创建数据目录并复制配置文件：

   bash
   mkdir -p data
   cp config-sample.json data/config.json
   

2. 编辑配置文件（根据实际需求修改）：

   bash
   vi data/config.json
   

部署方式

方式一：使用 docker-compose 部署

docker-compose 文件会自动构建镜像并启动服务：

bash
docker-compose up -d

方式二：直接使用 docker 命令部署

1. 构建镜像：

   bash
   docker build . --tag bsk-subdomain-registrar
   

2. 运行容器（挂载数据卷、设置环境变量及端口映射）：

   bash
   docker run -d \
     -v data:/root/ \
     -e BSK_SUBDOMAIN_CONFIG=/root/config.json \
     -p 3000:3000 \
     bsk-subdomain-registrar
   

服务验证

部署完成后，可通过以下命令测试服务连接状态：

bash
curl http://localhost:3000/index | jq

成功响应示例：

json
{
  "status": true
}

关键配置说明

• 数据卷挂载：-v data:/root/ 用于将本地data目录挂载到容器内/root/，存储SQLite数据库及配置文件
• 环境变量：BSK_SUBDOMAIN_CONFIG=/root/config.json 指定配置文件路径
• 端口映射：-p 3000:3000 将容器内3000端口映射到宿主机3000端口，用于API访问