Skip to content

config-mate-user-quick-start.md

Latest commit

 

History

History
191 lines (131 loc) · 3.6 KB

config-mate-user-quick-start.md

File metadata and controls

191 lines (131 loc) · 3.6 KB

Config Mate 现场快速使用说明

1. 准备文件

现场安装包目录示例：

/opt/sprixin-iotcloud

或：

/opt/sprixin-iotedge

把 Config Mate 镜像文件放到安装包的 images 目录：

/opt/sprixin-iotcloud/images/tb-config-mate_linux_amd64.tar.gz

如果是 ARM 服务器，使用：

tb-config-mate_linux_arm64.tar.gz

2. 进入安装包目录

Cloud 示例：

cd /opt/sprixin-iotcloud

Edge 示例：

cd /opt/sprixin-iotedge

3. 加载镜像

x86 服务器：

docker load -i images/tb-config-mate_linux_amd64.tar.gz

ARM 服务器：

docker load -i images/tb-config-mate_linux_arm64.tar.gz

4. 创建启动配置

在安装包根目录创建 .config-mate.env：

cat > .config-mate.env <<EOF
DEPLOY_ROOT=$(pwd)
CONFIG_MATE_PORT=3300
CONFIG_MATE_PASSWORD=请改成你的登录密码
EOF

说明：

  • DEPLOY_ROOT：当前安装包目录，保持 $(pwd) 即可。
  • CONFIG_MATE_PORT：Web 访问端口，默认用 3300。
  • CONFIG_MATE_PASSWORD：登录密码，必须设置。

一般不需要配置 APP_TYPE，程序会自动识别 Cloud 或 Edge。

5. 创建启动文件

如果安装包里已经有 Config Mate 的 compose 配置，可以跳过这一步。

如果没有，在安装包根目录创建 docker-compose.config-mate.yml：

services:
  config-mate:
    image: tb-config-mate:latest
    container_name: tb-config-mate
    ports:
      - "${CONFIG_MATE_PORT:-3300}:3300"
    working_dir: "${DEPLOY_ROOT}"
    environment:
      APP_ROOT: "${DEPLOY_ROOT}"
      CONFIG_MATE_PASSWORD: "${CONFIG_MATE_PASSWORD}"
      PORT: "3300"
      NO_BROWSER: "1"
      TZ: Asia/Shanghai
    volumes:
      - "${DEPLOY_ROOT}:${DEPLOY_ROOT}"
      - /var/run/docker.sock:/var/run/docker.sock
    restart: always

注意：

  • DEPLOY_ROOT 必须是整个 sprixin-iotcloud 或 sprixin-iotedge 安装包根目录。
  • 不建议只映射 services/iotcloud 或 services/iotedge，否则页面无法统一管理 postgres、redis、kafka、cassandra 等服务。
  • /var/run/docker.sock 用于让 Config Mate 控制宿主机 Docker 容器，必须挂载。

6. 启动 Config Mate

docker compose --env-file .config-mate.env -f docker-compose.config-mate.yml up -d

如果现场使用旧版命令：

docker-compose --env-file .config-mate.env -f docker-compose.config-mate.yml up -d

如果安装包自带的 docker-compose.yml 里已经包含 config-mate 服务，也可以使用：

docker compose --env-file .config-mate.env up -d config-mate

7. 访问页面

浏览器打开：

http://服务器IP:3300

如果你把端口改成了 3301：

http://服务器IP:3301

登录时输入：

  • 操作员名称：任意填写，例如 admin
  • 管理口令：.config-mate.env 里的 CONFIG_MATE_PASSWORD

8. 查看运行状态

docker ps --filter name=tb-config-mate

查看日志：

docker logs --tail=100 tb-config-mate

9. 停止或重启

重启：

docker restart tb-config-mate

停止：

docker stop tb-config-mate

再次启动：

docker compose --env-file .config-mate.env -f docker-compose.config-mate.yml up -d

10. 更新 Config Mate

把新的镜像文件放到 images 目录后执行：

docker load -i images/tb-config-mate_linux_amd64.tar.gz
docker compose --env-file .config-mate.env -f docker-compose.config-mate.yml up -d

ARM 服务器把文件名换成：

images/tb-config-mate_linux_arm64.tar.gz