*** Quickstart Docker镜像

镜像概述和主要用途

本项目提供一种简单方式，通过Docker将***-core和horizon整合到您的私有基础设施中。该镜像提供默认的非验证、临时配置，适用于大多数开发者。通过配置基于主机的卷，可实现完整的配置自定义和数据持久化。

核心功能和特性

使用的软件组件

• Postgresql 9.5：用于存储***-core和horizon数据
• ***-core
• horizon
• Supervisord：用于管理上述服务的进程

核心特性

• 支持三种网络模式：公网（pubnet）、测试网（testnet）和独立网络（standalone，私有***网络）
• 独立网络模式支持通过--protocol-version {version}参数指定协议版本（默认最新版）
• 两种运行模式：
  • 临时模式：无数据持久化，每次启动数据库为空，使用默认配置，适合开发测试
  • 持久模式：通过挂载主机卷实现配置自定义和数据持久化，适合生产环境

使用场景和适用范围

• 开发环境：使用临时模式快速启动测试网节点，无需担心数据持久化
• 测试环境：通过临时模式验证与***网络的交互逻辑
• 私有基础设施：使用持久模式部署自定义配置的***节点，运行独立网络或连接公网/测试网

详细使用方法和配置说明

使用前准备

使用前需确定以下事项：

1. 网络类型：选择公网（--pubnet）、测试网（--testnet）或独立网络（--standalone）
2. 运行模式：临时模式（无卷挂载）或持久模式（需挂载主机卷）
3. 暴露端口：根据需求暴露所需端口（详见“端口”部分）

背景与交互式容器

Docker容器可后台运行（-d参数）或交互式运行（-it参数）。建议参考Docker官方教程熟悉基本操作。

临时模式

临时模式适用于开发和测试环境，每次启动容器时数据库为空，使用默认配置。

启动命令示例（测试网节点，暴露horizon端口）：

$ docker run --rm -it -p "8000:8000" --name *** ***/quickstart --testnet

启动时，临时模式容器会生成随机PostgreSQL密码并输出到标准输出，可用于访问数据库（需暴露PostgreSQL端口）。

持久模式

持久模式通过挂载主机卷实现配置自定义和数据持久化，适用于需要保留数据或自定义配置的场景。

启动命令示例（测试网节点，挂载主机目录/home/scott/***）：

$ docker run --rm -it -p "8000:8000" -v "/home/scott/***:/opt/***" --name *** ***/quickstart --testnet

初始化步骤：

1. 首次启动时以交互式方式运行容器，完成配置初始化
2. 通过Ctrl-C停止交互式容器
3. 使用相同主机目录后台启动容器

自定义配置

持久模式下，首次启动会在挂载卷中生成默认配置文件，文件结构如下：

/opt/***
├── core
│   └── etc
│       └── ***-core.cfg  # *** core配置文件
├── horizon
│   └── etc
│       └── horizon.env       # Horizon环境变量配置脚本
├── postgresql
│   └── etc
│       ├── postgresql.conf   # PostgreSQL主配置文件
│       ├── pg_hba.conf       # PostgreSQL客户端配置文件
│       └── pg_ident.conf     # PostgreSQL用户映射文件
└── supervisor
    └── etc
        └── supervisord.conf  # Supervisord主配置文件

注意：修改配置前建议停止容器，修改后重启。错误配置可能导致服务异常，建议先了解各服务管理方法。

用户账户管理

容器与主机卷之间的UID管理较复杂，当前镜像使用固定UID 10011001创建用户。主机卷中的数据将归属于该UID。如需修改，建议Fork项目并替换UID。

端口说明

安全注意事项

• PostgreSQL端口：必须严格保护，攻击者获得写权限可篡改网络视图
• Horizon HTTP端口：可安全暴露，设计用于面向互联网
• Horizon管理端口：仅暴露给可信网络，无内置安全机制
• ***-core HTTP端口：仅暴露给可信网络，攻击者可执行管理命令
• ***-core对等端口：可暴露到互联网，提升网络连通性（非必需）

访问和调试运行中的容器

进入容器

通过以下命令在运行中的容器内启动交互式shell：

$ docker exec -it *** /bin/bash

（将***替换为容器实际名称）

重启服务

容器内服务通过supervisord管理，可使用supervisorctl交互：

# 进入容器后执行
$ supervisorctl

supervisorctl命令示例：

# 重启horizon
supervisor> restart horizon

# 停止***-core
supervisor> stop ***-core

查看日志

日志位于容器内/var/log/supervisor/目录，也可通过supervisorctl的tail命令查看。

访问数据库

容器内运行两个PostgreSQL数据库：core（***-core数据）和horizon（horizon数据）。连接信息：

• 用户名：***
• 密码：临时模式下启动时输出；持久模式下初始化过程中设置

示例启动命令

后台运行临时公网节点（暴露horizon端口）

$ docker run -d -p "8000:8000" --name *** ***/quickstart --pubnet

前台运行临时测试网节点（暴露所有端口）

$ docker run --rm -it \
    -p "8000:8000" \
    -p "11626:11626" \
    -p "11625:11625" \
    --name *** \
    ***/quickstart --testnet

初始化新的持久化节点（使用主机目录/str）

$ docker run -it --rm \
    -v "/str:/opt/***" \
    --name *** \
    ***/quickstart --pubnet

后台运行已初始化的持久化节点

$ docker run -d \
    -v "/str:/opt/***" \
    -p "8000:8000" \
    --name *** \
    ***/quickstart --pubnet

故障排除

如有问题，请提交issue或加入***公共Slack频道获取支持。