> ## Documentation Index
> Fetch the complete documentation index at: https://docs.myrmagent.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 本地部署

> 使用 Docker 或手动方式自托管 Myrm。

# 本地部署

在你自己的机器上运行 Myrm，完全掌控数据。

## 一行命令安装（最快）

**macOS / Linux / Git Bash**

```bash theme={null}
curl -fsSL https://myrmagent.ai/install.sh | bash
myrm start
```

**Windows（PowerShell）**

```powershell theme={null}
irm https://myrmagent.ai/install.ps1 | iex
myrm start
```

打开 \*\*[http://localhost:3000\*\*，在设置中添加](http://localhost:3000**，在设置中添加) LLM API Key。Harness 来自 PyPI；自托管无需单独的 harness 仓库。

## 克隆并开发（开源仓库）

```bash theme={null}
git clone https://github.com/Pursue-LLL/myrm-agent.git
cd myrm-agent
myrm setup          # uv sync + bun install
myrm start          # 后端（终端 1）
cd myrm-agent-frontend && bun run dev   # 前端（终端 2）
```

开发脚本位于开源仓库的 `scripts/` 下，贡献者克隆一次即可本地运行。

<Callout type="tip">
  **分体开发提示：** 若只启动 WebUI（端口 3000）而未启后端，界面会显示友好 Banner 指引如何启动完整服务，不会出现难以理解的报错；设置会离线缓存，后端恢复后自动同步。
</Callout>

## 前置条件（Docker 路径）

* Docker 24+ 与 Docker Compose v2
* 至少 4GB 内存（推荐 8GB）
* 10GB 磁盘空间

## Docker Compose

```bash theme={null}
git clone https://github.com/Pursue-LLL/myrm-agent.git
cd myrm-agent/myrm-agent-server
cp .env.example .env   # 若存在
docker compose up -d
```

## 配置

编辑 `.env` 设置 API Key：

```env theme={null}
# LLM 提供商（至少需要一个）
OPENAI_API_KEY=sk-...
ANTHROPIC_API_KEY=sk-ant-...

# 可选：其他提供商
DEEPSEEK_API_KEY=...
GOOGLE_API_KEY=...
```

完整参考见[环境变量](/zh/self-hosting/environment-variables)。

## 中国大陆加速

安装脚本自动检测中国大陆网络（通过时区 + 连通性检测），自动切换国内镜像：

* **PyPI** → pypi.tuna.tsinghua.edu.cn
* **npm** → registry.npmmirror.com
* **Playwright** → cdn.npmmirror.com

Docker 构建时传入 `--build-arg USE_CN_MIRROR=1`：

```bash theme={null}
docker build --build-arg USE_CN_MIRROR=1 -f myrm-agent-server/Dockerfile -t myrm-server .
```

手动控制：设置 `MYRM_USE_CN_MIRROR=1` 强制使用国内镜像，或 `MYRM_NO_CN_MIRROR=1` 禁用自动检测。

## 验证安装

```bash theme={null}
curl http://localhost:3000/api/health
```

预期响应：

```json theme={null}
{ "status": "ok" }
```

## 生产 Docker 构建（开源服务端镜像）

从预构建 harness wheel 构建开源服务端镜像时，构建器通过 BuildKit `TARGETPLATFORM` 选择正确的平台核心 wheel，并在镜像就绪前运行 `verify-harness-distribution`。不匹配或不完整的安装会在构建/启动时失败——而非对话中途。

详见 monorepo 中的 harness 分发指南：`myrm-agent-harness/harness_packaging/DISTRIBUTION_SYSTEM.md`。

## 模块化引擎打包（二次开发者）

Harness 核心仅 **24 项运行时依赖**，另有 **11 组可选 Extras**（浏览器、检索、ACP、可观测性等）。通过 `install.sh`、Docker 或 Tauri 安装的最终用户会自动获得 server 所需的完整组合——**无需手动选 Extras**。

若你在自有 Python 服务中嵌入引擎，可按需安装：

```bash theme={null}
pip install 'myrm-agent-harness[fastapi,web,compiled-core]==0.1.0'
```

缺少 Extra 时会在调用点给出明确安装提示，而非对话中途静默崩溃。架构测试锁定核心依赖列表，防止 silent 膨胀——**327** 项 harness 架构测试已验证（2026-07）。

## 依赖自动管理

Myrm 自动处理依赖安装，无需手动操作：

* **渠道 SDK** — 启用 Matrix、Discord 或飞书渠道时，所需 Python 包通过安全允许列表机制按需安装，无需重启服务。
* **MCP 服务器** — 外部工具通过 `npx`/`uvx` 运行，自动管理各自的环境。在 GUI 中添加服务器即可使用。
* **Doctor 诊断** — 运行 `myrm doctor` 检查系统健康状态：Python 版本、核心依赖、浏览器可用性等。每项检查失败都附带修复建议。
* **安全优先** — 仅预先批准的包可被自动安装。MCP 服务器在激活前会进行恶意软件（OSV）和提示注入扫描。

## 更新

```bash theme={null}
git pull
docker compose pull
docker compose up -d
```