# Octop > Self-hosted, multi-user AI assistant platform. Run personal AI agents, connect IM channels, and keep all your data on your own machine. ## Guide - [Octop: Self-Hosted Multi-User AI Assistant](/en/guide/introduction.md): Start from zero: send a first message, turn an expert into your assistant, then reach it from Feishu, WeChat, and the other apps you already use. - [Get Started with Octop: Install and Run in Minutes](/en/guide/quickstart.md): Install Octop on macOS, Linux, or Windows, run octop init, complete the first-run setup wizard, then start chatting in minutes. - [Octop Docker Setup: Standalone Docker, Compose, and Configuration Reference](/en/guide/quickstart-docker.md): Deploy Octop using a single docker run command (China mirror and GitHub source) or Docker Compose. Includes volume persistence, environment variables, configuration breakdown, and first-run wizard credentials. - [Use Octop on Tencent Cloud](/en/guide/use-in-tencent-cloud.md): Launch Octop on Tencent Cloud Lighthouse or CVM with the official image pre-selected. Sign in, review the spec, and place the order. - [Use Octop on FnOS](/en/guide/fnos.md): Deploy Octop on a Feiniu NAS (FnOS). Install the Docker or native .fpk package from App Center, complete the setup wizard, and start chatting within minutes. - [Use Octop on domestic operating systems](/en/guide/domestic-os.md): On UnionTech UOS and Kylin, pick the deb package for your CPU, install it with apt, and fix signature checks, security policy, and a launcher that does nothing. - [For Agents](/en/guide/for-agents.md): Add .md to a page URL to fetch that page as Markdown. Chinese routes have no language prefix. English routes start with /en. /llms.txt is the index. /llms-full.txt is every page in one file. - [First time with Octop: how the pieces fit](/en/guide/concepts/overview.md): Follow one real question to see what experts, models, knowledge bases, connectors, and channels each do, and which page to open next. - [Experts: make your first assistant](/en/guide/concepts/agents.md): Create an expert from Discover Experts, give it one concrete job in chat, then add memory, skills, and channels when you need them. - [Choose a role and a voice for an expert](/en/guide/concepts/experts-personas.md): Create a specialist from Discover Experts, then set how it speaks with MBTI or Take the test. - [Expert teams: give one job to several experts](/en/guide/concepts/expert-teams.md): Create at least two experts, then create a team. The host assigns work, and members reply in the same conversation. - [Knowledge bases: ground answers in your files](/en/guide/concepts/knowledge.md): Put a PDF, Word file, or spreadsheet in a knowledge base. Select it in chat, and the reply lists the passages it used. - [Channels: reach an expert from Feishu or WeChat](/en/guide/concepts/channels.md): Link an expert to Feishu, WeCom, DingTalk, QQ, WeChat, Telegram, or Discord. After that, message it from the chat app you already use. - [Connectors: let an expert use your apps](/en/guide/concepts/connectors.md): Authorize Tencent Docs, meetings, mail, or another app once, then ask the expert in plain language to look something up or change it. - [How to Configure LLM Providers and Models in Octop](/en/guide/guides/llm-providers.md): Add Tencent Cloud, OpenAI, Anthropic, DeepSeek, Ollama, or any custom endpoint as an Octop provider, and let auto-routing pick the best model per message. - [Connect an expert to Feishu, DingTalk, or QQ](/en/guide/guides/im-channels.md): Scan with your phone to connect an expert to Feishu, WeCom, DingTalk, QQ, or WeChat. Fill in an app credential only when a scan is not enough. - [Connect two Octop instances with cloud collaboration](/en/guide/guides/cloud-bridge.md): Link another Octop host so you can chat with its experts and teams from your local web UI. - [Have an expert remind you or push an update](/en/guide/guides/cron-jobs.md): Schedule a daily or one-time task for an expert under Automation, then use Execute Now to try it once. - [Delegate Coding Tasks to CLI Tools via ACP](/en/guide/guides/acp-ide.md): Have your Octop agent hand off coding tasks to external AI CLI tools through the Agent Client Protocol (ACP). - [Browser Automation and Terminal AI Access in Octop](/en/guide/guides/browser-terminal.md): The Octop workbench combines a remote browser and an AI-assisted terminal in one page, with a separate remote desktop for full host control. - [Watch Tencent Cloud CVM from the workbench](/en/guide/guides/cloud-hosts.md): Authorize Tencent Cloud, list CVM instances and metrics on the workbench Cloud Servers tab, and let the resident ops expert inspect them. - [Remote desktop: control the Octop host](/en/guide/guides/remote-desktop.md): Open the host desktop in your browser and click, type, and use apps as if you were sitting at the machine. - [Remote phone: control a connected Android device](/en/guide/guides/remote-phone.md): View and tap a USB phone or Android container from Remote Desktop → Phone. Experimental. - [How to Back Up and Completely Restore Your Octop Data](/en/guide/guides/backup-restore.md): Create, download, upload, and restore full Octop backups from the web UI — including the SQLite database, agent workspaces, config, and secrets. - [How to upgrade Octop](/en/guide/guides/upgrade.md): Upgrade Octop for each install method: in-app upgrade, the install script, octop update, pip, Docker, and FnOS. Restart after upgrading. Your data stays in the working directory. - [Reset an Octop account password](/en/guide/guides/reset-password.md): Choose a reset path by whether you can still sign in and how Octop is installed: the web UI, an admin reset, or a command on the host. - [Host a plugin and expert market](/en/guide/guides/private-market.md): Serve your own plugin and expert catalogs when the host cannot reach octop.cloud, including the HTTP API Octop calls. - [Host a skill market](/en/guide/guides/skill-market.md): Serve a SkillHub-compatible skill catalog, including search, rankings, ZIP download, and the skillset API used when you import a skill package. - [Installing the Octop Client and OctopPet on macOS](/en/guide/guides/macos-unsigned-app.md): What to do when macOS reports that the app is damaged and cannot be opened — remove the quarantine flag or allow apps from anywhere. Step-by-step, no terminal experience needed. - [Migrate from LightClaw to Octop](/en/guide/migrate/lightclaw.md): Export a LightClaw backup and restore it in Octop — providers, channels, workspace files, env, and cron jobs move over in a few clicks. - [Migrate from OpenClaw to Octop](/en/guide/migrate/openclaw.md): Use octop migrate openclaw to copy models, persona files, skills, MCP servers, and chat channels into one Octop expert. The command only reads the source directory. - [Migrate from Hermes Agent to Octop](/en/guide/migrate/hermes.md): Use octop migrate hermes to copy models, persona files, skills you installed, MCP servers, and chat channels into one Octop expert. Bundled skills stay behind. - [Octop config.json Reference: All Server Configuration Fields](/en/guide/configuration/config-file.md): Octop reads ~/.octop/config.json for server settings. Configure the port, CORS, timezone, database backend, and TLS from this file. - [Octop Environment Variables: Complete Config Reference](/en/guide/configuration/environment-variables.md): Override any Octop config.json field with an environment variable. Ideal for Docker, CI pipelines, and keeping secrets off the filesystem. - [Configure HTTPS and Register Octop as a System Service](/en/guide/configuration/tls-service.md): Run Octop over HTTPS using a self-signed or custom certificate, then register it as a persistent system service via systemd or launchd. - [Octop Data Directory: Files and Folders in ~/.octop/](/en/guide/configuration/data-directory.md): Everything Octop stores — database, agent workspaces, secrets, logs, and plugins — lives under ~/.octop/. Learn what each file and folder does. ## CLI Reference - [Octop CLI Overview: All Commands and Transport Modes](/en/cli/overview.md): Complete reference for the octop CLI: global options, transport modes, and every top-level command for managing your Octop server. - [Octop Server Commands: init, run, service, and update](/en/cli/server-commands.md): Bootstrap a new install, start the server in the foreground, manage it as a system service, and update to the latest Octop release. - [Octop CLI: Agent, Chat, Skills, and Model Commands](/en/cli/agent-commands.md): Create and manage agents, start interactive chat sessions, enable or disable skills, and configure LLM providers from the octop CLI. - [Octop CLI: Channel, Cron, Plugin, and Admin Commands](/en/cli/channel-cron-commands.md): Configure IM channels, schedule recurring cron jobs, install and reload plugins, and run admin operations from the Octop command line. ## API Reference - [Octop REST and WebSocket API: Endpoints and Access Guide](/en/api/overview.md): Octop exposes a REST API and WebSocket chat endpoint at /api. Enable interactive docs at /api/docs when you want to try calls in the browser. - [Authenticate and Authorize All Requests to the Octop API](/en/api/authentication.md): Get a JWT access token via POST /api/auth/login, then include it as a Bearer token on every subsequent call to the Octop REST API. - [Octop Agents API: Create, Configure, and Control Agents](/en/api/agents.md): REST endpoints for creating, configuring, and controlling Octop agents. Start, stop, reload, and read agent status via the HTTP API. - [Octop Chat API: WebSocket Streaming and Thread Management](/en/api/chat.md): Send messages to Octop agents via WebSocket for real-time streaming. Manage conversation threads with session create, list, and history endpoints. - [Channels API: Connect Agents to IM Platforms in Octop](/en/api/channels.md): Create, update, test, and delete IM channel connections for Octop agents. Endpoints for Feishu, WeCom, DingTalk, Telegram, and more. - [Connectors API](/en/api/connectors.md): List built-in connector catalog entries, manage connector instances, configure custom MCP servers, and complete OAuth authorization flows. - [Call Octop experts from other programs (Agent MCP)](/en/api/agent-mcp.md): Use the authenticated /api/mcp/agents Streamable HTTP endpoint so external MCP clients can list and call your Octop experts. - [Octop Providers API: Configure LLM Providers and Models](/en/api/providers.md): Add, list, and remove LLM provider configurations through the Octop API. Supports OpenAI-compatible, DashScope, Ollama, and custom endpoints. - [Octop Cron API: Schedule Automated Agent Tasks via REST](/en/api/cron.md): Create and manage scheduled cron jobs for Octop agents via the REST API. Supports cron expressions, intervals, and one-time date triggers. - [Knowledge bases API](/en/api/knowledge.md): Create knowledge bases, upload documents, and let chat retrieve cited sources over HTTP. - [Octop Users and Admin API: Manage Accounts and Settings](/en/api/users-admin.md): Create users, assign module permissions, send invites, reset passwords, and read audit data.