快速开始
本指南将带你使用 Docker Compose 一键部署完整的 EasyShell 环境。所有服务(Server、Web、MySQL、Redis)均已容器化,预构建镜像通过 GitHub Actions 自动发布到 Docker Hub 和 GHCR。
- Docker 24+ 并安装 Docker Compose v2(Docker Desktop 已内置)
- Git —— 用于克隆仓库
- 至少 2 GB 内存 和 10 GB 磁盘空间
第一步:克隆仓库
Section titled “第一步:克隆仓库”git clone https://github.com/easyshell-ai/easyshell.gitcd easyshell第二步:配置环境变量
Section titled “第二步:配置环境变量”复制环境变量模板并根据需要修改:
cp .env.example .env默认配置即可直接使用,关键配置项如下:
| 变量 | 默认值 | 说明 |
|---|---|---|
MYSQL_PASSWORD | 18923ce29fdab04e | MySQL root 密码 |
SERVER_PORT | 18080 | Server API 端口 |
WEB_PORT | 18880 | Web 前端端口 |
PROVISION_SERVER_URL | http://easyshell-server:18080 | Agent 连接地址,部署 Agent 时需改为服务器外部可达地址 |
第三步:一键启动所有服务
Section titled “第三步:一键启动所有服务”docker compose up -dDocker Compose 将自动拉取预构建镜像并启动以下四个服务:
| 服务 | 镜像 | 端口 |
|---|---|---|
| easyshell-server | laolupaojiao/easyshell-server:latest | 18080 |
| easyshell-web | laolupaojiao/easyshell-web:latest | 18880 |
| easyshell-mysql | mysql:8.0 | 13306 |
| easyshell-redis | redis:7-alpine | 16379 |
第四步:验证服务状态
Section titled “第四步:验证服务状态”docker compose ps所有服务应在 1–2 分钟内显示 healthy 状态。也可以查看日志排查问题:
docker compose logs -f第五步:登录
Section titled “第五步:登录”打开浏览器访问 http://localhost:18880,使用以下账号登录:
- 用户名:
easyshell - 密码:
easyshell@changeme
第六步:部署 Agent 到被管理主机
Section titled “第六步:部署 Agent 到被管理主机”EasyShell Agent 运行在每台需要管理的服务器上。有两种部署方式:
方式一:自动部署(通过 Web 界面)
Section titled “方式一:自动部署(通过 Web 界面)”- 在侧边栏导航到 主机管理
- 点击 添加主机 → 安装 Agent
- 输入目标主机的 SSH 凭据(IP、端口、用户名、密码/密钥)
- 服务端将自动 SSH 到目标主机,上传对应的二进制文件(amd64/arm64),并启动 Agent
方式二:手动部署
Section titled “方式二:手动部署”- 将预编译的二进制文件复制到目标主机:
scp easyshell-agent/easyshell-agent-linux-amd64 user@target:/usr/local/bin/easyshell-agent- 在目标主机上创建配置文件
/etc/easyshell/agent.yaml:
server: url: http://你的EasyShell服务器地址:18080
agent: id: "" # 留空则根据主机名自动生成
heartbeat: interval: 30 # 秒
metrics: interval: 60 # 秒
log: level: info- 启动 Agent:
chmod +x /usr/local/bin/easyshell-agent/usr/local/bin/easyshell-agent --config /etc/easyshell/agent.yaml第七步:配置 AI 助手(可选)
Section titled “第七步:配置 AI 助手(可选)”启用 AI 智能运维助手:
- 进入 系统管理 → AI 设置
- 添加你的 AI 模型提供商(如 OpenAI、DeepSeek 或任何 OpenAI 兼容的 API)
- 配置 API Key 和模型参数
- 测试连接
详细的 AI 配置说明请参阅 AI 配置指南。
开发者:从源码构建
Section titled “开发者:从源码构建”如需从源码构建镜像(而非使用预构建镜像),使用开发配置文件:
docker compose -f docker-compose.build.yml up -d这将使用本地的 Dockerfile.server 和 Dockerfile.web 在本地构建镜像后启动。