# Octop

## 文档

### 开始使用

- [Octop：自托管多用户AI助手](https://octop.mintlify.app/zh/introduction.md): Octop是一个自托管的多用户AI助手。运行个人AI专家，连接IM渠道，并将所有数据保留在您自己的机器上。
- [Octop 快速入门：几分钟内完成安装与运行](https://octop.mintlify.app/zh/quickstart.md): 在 macOS、Linux 或 Windows 上安装 Octop，运行 octop init，完成首次设置向导，然后在几分钟内开始聊天。
- [Octop Docker 部署指南：Compose、数据卷与环境变量](https://octop.mintlify.app/zh/quickstart-docker.md): 使用 Docker Compose 或独立的 docker run 命令部署 Octop。包括数据卷挂载、环境变量和首次运行设置。

### 核心概念

- [Octop 如何运作：架构概览](https://octop.mintlify.app/zh/concepts/overview.md): 了解 Octop 的单进程模型：一个服务器同时运行页面、CLI、IM 渠道和定时任务，共享同一个数据库。
- [专家：您在 Octop 中的专属 AI 助手](https://octop.mintlify.app/zh/concepts/agents.md): 每个 Octop 专家都拥有自己的工作区、LLM 提供商、技能、渠道和对话历史。了解如何创建和管理专家。
- [Octop 中的专家模板与 MBTI 人格](https://octop.mintlify.app/zh/concepts/experts-personas.md): Octop 内置 16 种 MBTI 人格模板和一个专家库。为专家分配一种人格，塑造它的思考与沟通方式。
- [知识库：在对话中检索你的文件](https://octop.mintlify.app/zh/concepts/knowledge.md): 把文档放进知识库，专家在对话里可以检索相关段落，并在回复下方展示引用来源。
- [通道：将 Octop 连接到您的消息应用](https://octop.mintlify.app/zh/concepts/channels.md): Octop 支持企业微信、飞书、钉钉、QQ、微信、Telegram、元宝、小艺和 MQTT。每个通道将一个消息平台连接到您的某个专家。
- [连接器：用内置应用和 MCP 扩展专家](https://octop.mintlify.app/zh/concepts/connectors.md): Octop 内置文档、网盘、邮箱与 MCP OAuth 连接器，并支持通过 HTTP 或 Stdio 接入自定义 MCP 服务器。

### 指南

- [如何在 Octop 中配置 LLM 提供商与模型](https://octop.mintlify.app/zh/guides/llm-providers.md): 在 Octop 中添加腾讯云、OpenAI、Anthropic、DeepSeek、Ollama 或任意自定义端点，并让自动路由为每条消息挑选最合适的模型。
- [在 Octop 中设置 IM 通道](https://octop.mintlify.app/zh/guides/im-channels.md): 将 Octop 专家连接到飞书、企业微信、钉钉、QQ、微信、Telegram 等平台，让您的团队在日常使用的工具里直接与 AI 专家对话。
- [使用 Octop 定时任务自动执行重复性专家任务](https://octop.mintlify.app/zh/guides/cron-jobs.md): 设置 Octop 专家自动运行提示。使用 cron 表达式或自然语言触发器来自动化每日报告和提醒。
- [通过 ACP 把编码任务委托给 CLI 工具](https://octop.mintlify.app/zh/guides/acp-ide.md): 让 Octop 专家借助 Agent Client Protocol（ACP），把编码任务委托给外部 AI 编程 CLI。
- [Octop 中的浏览器自动化与终端 AI 访问](https://octop.mintlify.app/zh/guides/browser-terminal.md): Octop 的工作台把远程浏览器和 AI 辅助终端合在一个页面，另有独立的远程桌面用于完整操控主机。
- [远程桌面：操控 Octop 主机](https://octop.mintlify.app/zh/guides/remote-desktop.md): 在浏览器里打开主机桌面，像坐在那台机器前一样点击、输入、使用应用。
- [远程手机：操控已连接的 Android 设备](https://octop.mintlify.app/zh/guides/remote-phone.md): 在「远程桌面 → 手机」中查看并点击 USB 手机或 Android 容器。实验性功能。
- [如何备份并完整恢复您的 Octop 数据](https://octop.mintlify.app/zh/guides/backup-restore.md): 在页面中创建、下载、上传和恢复完整的 Octop 备份，涵盖 SQLite 数据库、专家工作区、配置与密钥。
- [在飞牛 NAS 上安装 Octop](https://octop.mintlify.app/zh/guides/fnos.md): 从飞牛应用中心安装 Octop：Docker 版使用 8088 端口，本地版使用 8089 端口。
- [从 LightClaw 迁移到 Octop](https://octop.mintlify.app/zh/guides/migrate-from-lightclaw.md): 在 LightClaw 导出备份，再在 Octop 页面上传并恢复——模型、通道、工作区、环境变量与定时任务可一键迁入。
- [在 macOS 上安装 Octop 客户端与 OctopPet 桌宠](https://octop.mintlify.app/zh/guides/macos-unsigned-app.md): macOS 提示「App 已损坏，无法打开」时怎么办：移除隔离标记、允许任何来源。图文步骤，从未用过终端也能跟着做。

### 配置

- [Octop config.json 参考：所有服务器配置字段](https://octop.mintlify.app/zh/configuration/config-file.md): Octop 读取 ~/.octop/config.json 进行服务器设置。从此文件配置端口、CORS、时区、数据库后端和 TLS。
- [Octop 环境变量：完整配置参考](https://octop.mintlify.app/zh/configuration/environment-variables.md): 使用环境变量覆盖任何 Octop config.json 字段。适用于 Docker、CI 流水线以及不希望将密钥存入文件系统的场景。
- [为 Octop 配置 HTTPS 并注册为系统服务](https://octop.mintlify.app/zh/configuration/tls-service.md): 使用自签名或自定义证书通过 HTTPS 运行 Octop，并通过 systemd 或 launchd 将其注册为持久化系统服务。
- [Octop 数据目录：~/.octop/ 中的文件与文件夹](https://octop.mintlify.app/zh/configuration/data-directory.md): Octop 存储的所有内容——数据库、专家工作区、密钥、日志和插件——都位于 ~/.octop/ 下。了解每个文件和文件夹的作用。

### CLI 参考

- [Octop CLI 概览：所有命令与传输模式](https://octop.mintlify.app/zh/cli/overview.md): octop CLI 完整参考：全局选项、传输模式，以及管理 Octop 服务器的所有顶层命令。
- [Octop 服务器命令：init、run、service 与 update](https://octop.mintlify.app/zh/cli/server-commands.md): 引导新安装，在前台启动服务器，将其管理为系统服务，并将 Octop 升级到最新发布版本。
- [Octop CLI：专家、聊天、技能与模型命令](https://octop.mintlify.app/zh/cli/agent-commands.md): 创建和管理专家，启动交互式聊天会话，启用或禁用技能，并从 octop CLI 配置 LLM 提供商。
- [Octop CLI：渠道、定时任务、插件与管理命令](https://octop.mintlify.app/zh/cli/channel-cron-commands.md): 配置 IM 渠道，安排循环定时任务，安装与重新加载插件，并从 Octop 命令行执行管理操作。

## API 参考

### 概览

- [Octop REST 与 WebSocket API：端点与访问说明](https://octop.mintlify.app/zh/api/overview.md): Octop 在 /api 提供 REST 与 WebSocket。需要在浏览器里试调用时，打开 /api/docs。
- [对 Octop API 的所有请求进行认证与授权](https://octop.mintlify.app/zh/api/authentication.md): 通过 POST /api/auth/login 获取 JWT 访问令牌，然后在对 Octop REST API 的每个后续调用中将其作为 Bearer 令牌包含。

### 端点

- [Octop 专家 API：创建、配置与控制专家](https://octop.mintlify.app/zh/api/agents.md): 使用 Octop 的 /api/agents 端点创建、配置、启动、停止和重新加载 AI 专家，包含专家模板和 MBTI 人格端点。
- [Octop 对话 API：WebSocket 流式传输与线程管理](https://octop.mintlify.app/zh/api/chat.md): 通过 WebSocket 与 Octop 专家对话并流式接收回复，并使用线程管理端点组织对话历史。
- [通道 API：在 Octop 中将专家连接到消息平台](https://octop.mintlify.app/zh/api/channels.md): 使用 Octop 的 /api/agents/{agent_id}/channels 端点，将专家连接到飞书、企业微信、钉钉、Telegram 等消息平台。
- [Octop 提供商 API：配置 LLM 提供商与模型](https://octop.mintlify.app/zh/api/providers.md): 配置 LLM 提供商，选择可用模型，并控制专家使用的默认模型。
- [Octop 定时任务 API：通过 REST 计划自动化专家任务](https://octop.mintlify.app/zh/api/cron.md): 使用 Octop 的 /api/agents/{agent_id}/cron 端点，通过 cron 表达式、间隔或一次性日期计划自动化专家任务。
- [知识库 API](https://octop.mintlify.app/zh/api/knowledge.md): 通过 HTTP 创建知识库、上传文档，让对话检索带引用的来源。
- [Octop 用户与管理 API：管理账户与设置](https://octop.mintlify.app/zh/api/users-admin.md): 使用 Octop 的 /api/users 和 /api/admin 端点管理用户账户、角色、审计日志以及平台设置（仅限管理员）。

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [English (37 pages)](https://octop.mintlify.app/_llms/en.txt): Docs, API Reference.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.