rocketadmin/rocketadmin-agent

Autoadmin-agent Docker镜像文档

镜像概述和主要用途

Autoadmin-agent Docker镜像是用于部署Autoadmin代理的容器化解决方案，支持通过Docker命令或Docker Compose两种方式快速安装。该代理用于建立Autoadmin平台与目标服务（如数据库）的连接，配置完成后新连接将自动出现在Autoadmin的连接列表中。适用于MacOS、Windows（依赖Docker Desktop）及Linux（依赖Docker Engine）操作系统。

核心功能和特性

• 跨平台支持：兼容MacOS、Windows和Linux系统，根据操作系统选择Docker Desktop或Docker Engine部署环境
• 灵活部署方式：提供Docker命令直接部署和Docker Compose编排部署两种选项
• 环境变量配置：通过环境变量或配置文件设置连接参数，简化配置流程
• 自动集成：部署成功后无需手动操作，新连接自动添加至Autoadmin连接列表

使用场景和适用范围

适用于需要在Autoadmin平台中添加数据库等服务连接的场景，通过部署该代理实现Autoadmin与目标服务的安全连接，适用于开发、测试及生产环境的服务集成需求。

详细使用方法和配置说明

方法一：通过Docker命令安装

前提条件

• 已安装Docker Desktop（MacOS/Windows）或Docker Engine（Linux）

操作步骤

1. 拉取镜像
   打开终端执行以下命令拉取最新镜像：

   bash
   docker pull docker.xuanyuan.run/rocketadmin/rocketadmin-agent
   

2. 运行容器
   使用以下命令启动容器，并通过环境变量指定连接参数：

   bash
   docker run -e CONNECTION_TOKEN=connection_token -e CONNECTION_TYPE=mysql -e CONNECTION_USERNAME=your_username \
    -e CONNECTION_PASSWORD=your_password -e CONNECTION_HOST=example.com docker.xuanyuan.run/rocketadmin/rocketadmin-agent
   

方法二：通过Docker Compose安装

前提条件

• 安装Docker Engine（https://docker.com）
• Linux系统需额外安装Docker Compose（https://docs.docker.com/compose/install/）

  注意：Windows和MacOS的Docker Desktop已内置Docker Compose，无需额外安装

操作步骤

1. 创建docker-compose.yml文件
   复制https://github.com/Autoadmin-org/autoadmin-agent/blob/master/docker-compose.yml内容或直接下载该文件至本地目录。

2. 创建配置文件
   在同一目录下创建.config.env文件，复制https://github.com/Autoadmin-org/autoadmin-agent/blob/master/.config.env内容或下载该文件。

3. 配置连接凭据
   编辑.config.env文件，填写所有必填连接参数（如令牌、用户名、密码等）。

4. 启动服务
   打开终端，在配置文件所在目录执行以下命令：

   sh
   docker-compose up --build
   

   部署成功后，新连接将自动显示在Autoadmin的连接列表中。

配置参数说明

以下为配置连接所需的必填环境变量，需在运行容器时通过-e参数指定或在.config.env文件中配置：

• CONNECTION_TOKEN：连接令牌，用于Autoadmin平台身份验证
• CONNECTION_TYPE：连接类型，如mysql（根据实际服务类型指定）
• CONNECTION_USERNAME：目标服务的登录用户名
• CONNECTION_PASSWORD：目标服务的登录密码
• CONNECTION_HOST：目标服务的主机地址（如example.com或IP地址）