diff --git a/.gitignore b/.gitignore index d11e654..48c08a9 100644 --- a/.gitignore +++ b/.gitignore @@ -23,4 +23,4 @@ dist-ssr *.sln *.sw? -.vitepress/cache \ No newline at end of file +**/.vitepress/cache diff --git a/README.md b/README.md index 19189c8..9b95a44 100644 --- a/README.md +++ b/README.md @@ -106,6 +106,22 @@ pnpm preview └── pnpm-lock.yaml ``` +## Changelog + +### 2026-09 + +- **Navigation restructure**: docs are now organized under a single **References** tree — Getting Started (with Deployment and Channels), Advanced (with Providers → Memory / TTS Providers), and Use Cases. The version selector moved to the header right, and edit links were added to every page. +- **New Get Started tutorial**: a step-by-step onboarding guide added for both English and Chinese docs; Overview now comes before Getting Started in the sidebar. +- **Framework**: evaluated a migration to Scalar Docs, then restored VitePress while keeping all content and structure changes intact. +- **Translation quality pass**: reviewed all 53 English/Chinese page pairs; fixed mistranslations (e.g. ACL presets, private channels, compaction behavior), typos, machine-translated phrasing, and terminology mismatches across 29 files, plus a plural typo in the English Matrix page. +- **Housekeeping**: `.gitignore` now correctly excludes `docs/.vitepress/cache`. + +### Earlier + +- Synced docs with the Memoh source and added Quick Start (#7). +- Added Connect-It connectors documentation (#5). +- Updated documentation for v0.17 (#4) and v0.13. + ## Contributing Small fixes are best made directly in the relevant Markdown page. For larger changes: diff --git a/README_CN.md b/README_CN.md index a5b1395..b85caf0 100644 --- a/README_CN.md +++ b/README_CN.md @@ -106,6 +106,22 @@ pnpm preview └── pnpm-lock.yaml ``` +## 更新日志 + +### 2026-09 + +- **导航结构重组**:文档统一收入单一的 **References(参考文档)** 树——快速开始(内含部署与渠道)、进阶教程(内含提供方 → 记忆/TTS 提供方)、使用场景。版本选择器移到页头右侧,并为每个页面加上编辑链接。 +- **新增 Get Started 新手教程**:中英文各新增一份分步上手指南;侧边栏中 Overview 调整到 Getting Started 之前。 +- **框架**:尝试迁移到 Scalar Docs 后还原回 VitePress,全部内容与结构改动均保留。 +- **翻译质量核查**:全量核查 53 对中英文页面,修正误译(如 ACL 预设、私有频道、会话压缩描述)、错别字、机翻痕迹和术语不一致,共涉及 29 个文件;同时修复英文 Matrix 页面的一处单复数笔误。 +- **杂项**:修正 `.gitignore`,正确排除 `docs/.vitepress/cache`。 + +### 更早 + +- 与 Memoh 源码同步并新增 Quick Start(#7)。 +- 新增 Connect-It 连接器文档(#5)。 +- 更新 v0.17(#4)与 v0.13 文档。 + ## 贡献文档 小的错别字、链接和措辞修正可以直接改对应 Markdown 页面。较大的结构调整建议这样做: diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index a46632a..e320f9e 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -46,9 +46,8 @@ export default defineConfig({ }, nav: [ - { text: 'Guides', link: '/guides/' }, - { text: 'Integrations', link: '/integrations/' }, - { text: 'Self-hosted', link: '/self-hosted/' }, + { text: 'References', link: '/guides/' }, + { text: 'About', link: '/about.md' }, ], logo: { diff --git a/docs/.vitepress/en.ts b/docs/.vitepress/en.ts index 9af9524..3df6de9 100644 --- a/docs/.vitepress/en.ts +++ b/docs/.vitepress/en.ts @@ -1,92 +1,108 @@ +const references = [ + { + text: 'References', + items: [ + { text: 'Overview', link: '/guides/' }, + ], + }, + { + text: 'Getting Started', + items: [ + { text: 'Get Started', link: '/guides/get-started.md' }, + { text: 'Quick Start', link: '/guides/quick-start.md' }, + { text: 'Preferences', link: '/guides/preferences.md' }, + { text: 'Bot', link: '/guides/bot.md' }, + { text: 'Sessions', link: '/guides/sessions.md' }, + { text: 'Files', link: '/guides/files.md' }, + { text: 'Slash Commands', link: '/guides/slash-commands.md' }, + { + text: 'Deployment', + collapsed: true, + items: [ + { text: 'Server Deploy', link: '/self-hosted/docker.md' }, + { text: 'Desktop', link: '/self-hosted/desktop.md' }, + { text: 'Workspace Backends', link: '/self-hosted/workspace-backends.md' }, + { text: 'Overview', link: '/self-hosted/' }, + ], + }, + { + text: 'Channels', + collapsed: true, + items: [ + { text: 'Slack', link: '/integrations/channels/slack.md' }, + { text: 'Telegram', link: '/integrations/channels/telegram.md' }, + { text: 'Feishu (Lark)', link: '/integrations/channels/feishu.md' }, + { text: 'Discord', link: '/integrations/channels/discord.md' }, + { text: 'QQ', link: '/integrations/channels/qq.md' }, + { text: 'Matrix', link: '/integrations/channels/matrix.md' }, + { text: 'Misskey', link: '/integrations/channels/misskey.md' }, + { text: 'LINE', link: '/integrations/channels/line.md' }, + { text: 'DingTalk', link: '/integrations/channels/dingtalk.md' }, + { text: 'WeCom (WeWork)', link: '/integrations/channels/wecom.md' }, + { text: 'WeChat', link: '/integrations/channels/weixin.md' }, + { text: 'WeChat Official Account', link: '/integrations/channels/wechatoa.md' }, + { text: 'Overview', link: '/integrations/channels/' }, + ], + }, + ], + }, + { + text: 'Advanced', + items: [ + { text: 'Agents / ACP', link: '/guides/acp.md' }, + { text: 'Access Control', link: '/guides/access.md' }, + { text: 'Workspace', link: '/guides/container.md' }, + { text: 'Computers', link: '/guides/computers.md' }, + { text: 'Browser / Computer Use', link: '/guides/browser-computer-use.md' }, + { text: 'Skills', link: '/guides/skills.md' }, + { text: 'Supermarket', link: '/guides/supermarket.md' }, + { text: 'Connectors', link: '/guides/connectors.md' }, + { text: 'Hooks', link: '/guides/hooks.md' }, + { text: 'MCP', link: '/guides/mcp.md' }, + { text: 'Memory', link: '/guides/memory.md' }, + { text: 'Compaction', link: '/guides/compaction.md' }, + { text: 'Scheduled Tasks', link: '/guides/schedule.md' }, + { text: 'Email', link: '/guides/email.md' }, + { + text: 'Providers', + collapsed: true, + items: [ + { text: 'LLM Providers', link: '/integrations/providers/llm.md' }, + { text: 'Web Search Providers', link: '/integrations/providers/web-search.md' }, + { text: 'Video Providers', link: '/integrations/providers/video.md' }, + { + text: 'Memory Providers', + collapsed: true, + items: [ + { text: 'Built-in', link: '/integrations/providers/memory/builtin.md' }, + { text: 'Mem0', link: '/integrations/providers/memory/mem0.md' }, + { text: 'OpenViking', link: '/integrations/providers/memory/openviking.md' }, + { text: 'Overview', link: '/integrations/providers/memory/' }, + ], + }, + { + text: 'TTS Providers', + collapsed: true, + items: [ + { text: 'Edge TTS', link: '/integrations/providers/tts/edge.md' }, + { text: 'Overview', link: '/integrations/providers/tts/' }, + ], + }, + { text: 'Overview', link: '/integrations/providers/' }, + ], + }, + ], + }, + { + text: 'Use Cases', + items: [ + { text: 'Use Cases', link: '/guides/use-cases.md' }, + ], + }, +] + export const en = { - '/guides/': [ - { - text: 'Guides', - items: [ - { text: 'Overview', link: '/guides/' }, - { text: 'Quick Start', link: '/guides/quick-start.md' }, - { text: 'Preferences', link: '/guides/preferences.md' }, - { text: 'Bot', link: '/guides/bot.md' }, - { text: 'Sessions', link: '/guides/sessions.md' }, - { text: 'Agents / ACP', link: '/guides/acp.md' }, - { text: 'Access Control', link: '/guides/access.md' }, - { text: 'Workspace', link: '/guides/container.md' }, - { text: 'Computers', link: '/guides/computers.md' }, - { text: 'Browser / Computer Use', link: '/guides/browser-computer-use.md' }, - { text: 'Files', link: '/guides/files.md' }, - { text: 'Skills', link: '/guides/skills.md' }, - { text: 'Supermarket', link: '/guides/supermarket.md' }, - { text: 'Connectors', link: '/guides/connectors.md' }, - { text: 'Hooks', link: '/guides/hooks.md' }, - { text: 'MCP', link: '/guides/mcp.md' }, - { text: 'Memory', link: '/guides/memory.md' }, - { text: 'Compaction', link: '/guides/compaction.md' }, - { text: 'Scheduled Tasks', link: '/guides/schedule.md' }, - { text: 'Email', link: '/guides/email.md' }, - { text: 'Slash Commands', link: '/guides/slash-commands.md' }, - ], - }, - ], - '/integrations/': [ - { - text: 'Integrations', - items: [ - { text: 'Overview', link: '/integrations/' }, - ], - }, - { - text: 'Channels', - items: [ - { text: 'Overview', link: '/integrations/channels/' }, - { text: 'Slack', link: '/integrations/channels/slack.md' }, - { text: 'Telegram', link: '/integrations/channels/telegram.md' }, - { text: 'Feishu (Lark)', link: '/integrations/channels/feishu.md' }, - { text: 'Discord', link: '/integrations/channels/discord.md' }, - { text: 'QQ', link: '/integrations/channels/qq.md' }, - { text: 'Matrix', link: '/integrations/channels/matrix.md' }, - { text: 'Misskey', link: '/integrations/channels/misskey.md' }, - { text: 'LINE', link: '/integrations/channels/line.md' }, - { text: 'DingTalk', link: '/integrations/channels/dingtalk.md' }, - { text: 'WeCom (WeWork)', link: '/integrations/channels/wecom.md' }, - { text: 'WeChat', link: '/integrations/channels/weixin.md' }, - { text: 'WeChat Official Account', link: '/integrations/channels/wechatoa.md' }, - ], - }, - { - text: 'Providers', - items: [ - { text: 'Overview', link: '/integrations/providers/' }, - { text: 'LLM Providers', link: '/integrations/providers/llm.md' }, - { text: 'Web Search Providers', link: '/integrations/providers/web-search.md' }, - { text: 'Video Providers', link: '/integrations/providers/video.md' }, - ], - }, - { - text: 'Memory Providers', - items: [ - { text: 'Overview', link: '/integrations/providers/memory/' }, - { text: 'Built-in', link: '/integrations/providers/memory/builtin.md' }, - { text: 'Mem0', link: '/integrations/providers/memory/mem0.md' }, - { text: 'OpenViking', link: '/integrations/providers/memory/openviking.md' }, - ], - }, - { - text: 'TTS Providers', - items: [ - { text: 'Overview', link: '/integrations/providers/tts/' }, - { text: 'Edge TTS', link: '/integrations/providers/tts/edge.md' }, - ], - }, - ], - '/self-hosted/': [ - { - text: 'Self-hosted', - items: [ - { text: 'Overview', link: '/self-hosted/' }, - { text: 'Desktop', link: '/self-hosted/desktop.md' }, - { text: 'Server Deploy', link: '/self-hosted/docker.md' }, - { text: 'Workspace Backends', link: '/self-hosted/workspace-backends.md' }, - ], - }, - ], + '/guides/': references, + '/integrations/': references, + '/self-hosted/': references, } diff --git a/docs/.vitepress/theme/components/DocsHome.vue b/docs/.vitepress/theme/components/DocsHome.vue index 3cba53d..4e55785 100644 --- a/docs/.vitepress/theme/components/DocsHome.vue +++ b/docs/.vitepress/theme/components/DocsHome.vue @@ -21,23 +21,23 @@ const copy = computed(() => { { tone: 'guide', icon: 'book', - title: '教程', - text: '学习如何创建机器人、管理会话并使用 Memoh 的核心功能。', + title: '入门指南', + text: '部署、添加模型、创建机器人、接入渠道,并掌握日常基础操作。', href: '/zh/guides/', }, { tone: 'integration', icon: 'plug', - title: '集成', - text: '连接渠道、模型、记忆、TTS 和网页搜索等外部能力。', - href: '/zh/integrations/', + title: '进阶教程', + text: '高级能力、自动化与外部提供方——智能体、Hooks、长期记忆等。', + href: '/zh/guides/', }, { tone: 'hosted', icon: 'server', - title: '自托管', - text: '部署和运维开源版 Memoh,适合自建服务和本地运行。', - href: '/zh/self-hosted/', + title: '使用场景', + text: '组合多种功能解决实际问题的即用型示例。', + href: '/zh/guides/use-cases', }, ], } @@ -55,23 +55,23 @@ const copy = computed(() => { { tone: 'guide', icon: 'book', - title: 'Guides', - text: 'Learn how to create bots, manage sessions, and use Memoh core features.', + title: 'Getting Started', + text: 'Deploy, add a model, create a bot, connect channels, and learn the day-to-day basics.', href: '/guides/', }, { tone: 'integration', icon: 'plug', - title: 'Integrations', - text: 'Connect channels, models, memory, TTS, web search, and other external capabilities.', - href: '/integrations/', + title: 'Advanced', + text: 'Capabilities, automation, and external providers — agents, hooks, memory, and more.', + href: '/guides/', }, { tone: 'hosted', icon: 'server', - title: 'Self-hosted', - text: 'Deploy and operate open-source Memoh for your own servers or local runtime.', - href: '/self-hosted/', + title: 'Use Cases', + text: 'Ready-to-follow scenarios that combine features to solve real problems.', + href: '/guides/use-cases', }, ], } diff --git a/docs/.vitepress/zh.ts b/docs/.vitepress/zh.ts index fe06119..a8ef3a5 100644 --- a/docs/.vitepress/zh.ts +++ b/docs/.vitepress/zh.ts @@ -1,92 +1,108 @@ +const references = [ + { + text: '参考文档', + items: [ + { text: '总览', link: '/zh/guides/' }, + ], + }, + { + text: '快速开始', + items: [ + { text: '入门教程', link: '/zh/guides/get-started.md' }, + { text: '快速开始', link: '/zh/guides/quick-start.md' }, + { text: '用户偏好', link: '/zh/guides/preferences.md' }, + { text: '机器人', link: '/zh/guides/bot.md' }, + { text: '会话', link: '/zh/guides/sessions.md' }, + { text: '文件', link: '/zh/guides/files.md' }, + { text: '斜杠命令', link: '/zh/guides/slash-commands.md' }, + { + text: '部署', + collapsed: true, + items: [ + { text: '服务器部署', link: '/zh/self-hosted/docker.md' }, + { text: 'Desktop 桌面版', link: '/zh/self-hosted/desktop.md' }, + { text: '工作区后端', link: '/zh/self-hosted/workspace-backends.md' }, + { text: '总览', link: '/zh/self-hosted/' }, + ], + }, + { + text: '渠道', + collapsed: true, + items: [ + { text: 'Slack', link: '/zh/integrations/channels/slack.md' }, + { text: 'Telegram', link: '/zh/integrations/channels/telegram.md' }, + { text: '飞书', link: '/zh/integrations/channels/feishu.md' }, + { text: 'Discord', link: '/zh/integrations/channels/discord.md' }, + { text: 'QQ', link: '/zh/integrations/channels/qq.md' }, + { text: 'Matrix', link: '/zh/integrations/channels/matrix.md' }, + { text: 'Misskey', link: '/zh/integrations/channels/misskey.md' }, + { text: 'LINE', link: '/zh/integrations/channels/line.md' }, + { text: '钉钉', link: '/zh/integrations/channels/dingtalk.md' }, + { text: '企微', link: '/zh/integrations/channels/wecom.md' }, + { text: '微信', link: '/zh/integrations/channels/weixin.md' }, + { text: '微信公众号', link: '/zh/integrations/channels/wechatoa.md' }, + { text: '总览', link: '/zh/integrations/channels/' }, + ], + }, + ], + }, + { + text: '进阶教程', + items: [ + { text: 'Agents / ACP', link: '/zh/guides/acp.md' }, + { text: '访问控制', link: '/zh/guides/access.md' }, + { text: '工作区', link: '/zh/guides/container.md' }, + { text: '电脑(远程 Runtime)', link: '/zh/guides/computers.md' }, + { text: 'Browser / Computer Use', link: '/zh/guides/browser-computer-use.md' }, + { text: '技能', link: '/zh/guides/skills.md' }, + { text: '应用市场', link: '/zh/guides/supermarket.md' }, + { text: '连接器', link: '/zh/guides/connectors.md' }, + { text: 'Hooks', link: '/zh/guides/hooks.md' }, + { text: 'MCP', link: '/zh/guides/mcp.md' }, + { text: '长期记忆', link: '/zh/guides/memory.md' }, + { text: '上下文压缩', link: '/zh/guides/compaction.md' }, + { text: '定时任务', link: '/zh/guides/schedule.md' }, + { text: '邮件', link: '/zh/guides/email.md' }, + { + text: '提供方', + collapsed: true, + items: [ + { text: '模型服务商', link: '/zh/integrations/providers/llm.md' }, + { text: '搜索提供方', link: '/zh/integrations/providers/web-search.md' }, + { text: '视频提供方', link: '/zh/integrations/providers/video.md' }, + { + text: '记忆提供方', + collapsed: true, + items: [ + { text: '内置', link: '/zh/integrations/providers/memory/builtin.md' }, + { text: 'Mem0', link: '/zh/integrations/providers/memory/mem0.md' }, + { text: 'OpenViking', link: '/zh/integrations/providers/memory/openviking.md' }, + { text: '总览', link: '/zh/integrations/providers/memory/' }, + ], + }, + { + text: 'TTS 提供方', + collapsed: true, + items: [ + { text: 'Edge TTS', link: '/zh/integrations/providers/tts/edge.md' }, + { text: '总览', link: '/zh/integrations/providers/tts/' }, + ], + }, + { text: '总览', link: '/zh/integrations/providers/' }, + ], + }, + ], + }, + { + text: '使用场景', + items: [ + { text: '使用场景', link: '/zh/guides/use-cases.md' }, + ], + }, +] + export const zh = { - '/zh/guides/': [ - { - text: '教程', - items: [ - { text: '总览', link: '/zh/guides/' }, - { text: '快速开始', link: '/zh/guides/quick-start.md' }, - { text: '用户偏好', link: '/zh/guides/preferences.md' }, - { text: '机器人', link: '/zh/guides/bot.md' }, - { text: '会话', link: '/zh/guides/sessions.md' }, - { text: 'Agents / ACP', link: '/zh/guides/acp.md' }, - { text: '访问控制', link: '/zh/guides/access.md' }, - { text: 'Workspace', link: '/zh/guides/container.md' }, - { text: '电脑(远程 Runtime)', link: '/zh/guides/computers.md' }, - { text: 'Browser / Computer Use', link: '/zh/guides/browser-computer-use.md' }, - { text: '文件', link: '/zh/guides/files.md' }, - { text: '技能', link: '/zh/guides/skills.md' }, - { text: '应用市场', link: '/zh/guides/supermarket.md' }, - { text: '连接器', link: '/zh/guides/connectors.md' }, - { text: 'Hooks', link: '/zh/guides/hooks.md' }, - { text: 'MCP', link: '/zh/guides/mcp.md' }, - { text: '长期记忆', link: '/zh/guides/memory.md' }, - { text: '上下文压缩', link: '/zh/guides/compaction.md' }, - { text: '计划任务', link: '/zh/guides/schedule.md' }, - { text: '邮件', link: '/zh/guides/email.md' }, - { text: '斜杠命令', link: '/zh/guides/slash-commands.md' }, - ], - }, - ], - '/zh/integrations/': [ - { - text: '集成', - items: [ - { text: '总览', link: '/zh/integrations/' }, - ], - }, - { - text: '渠道', - items: [ - { text: '总览', link: '/zh/integrations/channels/' }, - { text: 'Slack', link: '/zh/integrations/channels/slack.md' }, - { text: 'Telegram', link: '/zh/integrations/channels/telegram.md' }, - { text: '飞书', link: '/zh/integrations/channels/feishu.md' }, - { text: 'Discord', link: '/zh/integrations/channels/discord.md' }, - { text: 'QQ', link: '/zh/integrations/channels/qq.md' }, - { text: 'Matrix', link: '/zh/integrations/channels/matrix.md' }, - { text: 'Misskey', link: '/zh/integrations/channels/misskey.md' }, - { text: 'LINE', link: '/zh/integrations/channels/line.md' }, - { text: '钉钉', link: '/zh/integrations/channels/dingtalk.md' }, - { text: '企微', link: '/zh/integrations/channels/wecom.md' }, - { text: '微信', link: '/zh/integrations/channels/weixin.md' }, - { text: '微信公众号', link: '/zh/integrations/channels/wechatoa.md' }, - ], - }, - { - text: '提供方', - items: [ - { text: '总览', link: '/zh/integrations/providers/' }, - { text: 'LLM 提供方', link: '/zh/integrations/providers/llm.md' }, - { text: '搜索提供方', link: '/zh/integrations/providers/web-search.md' }, - { text: '视频提供方', link: '/zh/integrations/providers/video.md' }, - ], - }, - { - text: '记忆提供方', - items: [ - { text: '总览', link: '/zh/integrations/providers/memory/' }, - { text: '内置', link: '/zh/integrations/providers/memory/builtin.md' }, - { text: 'Mem0', link: '/zh/integrations/providers/memory/mem0.md' }, - { text: 'OpenViking', link: '/zh/integrations/providers/memory/openviking.md' }, - ], - }, - { - text: 'TTS 提供方', - items: [ - { text: '总览', link: '/zh/integrations/providers/tts/' }, - { text: 'Edge TTS', link: '/zh/integrations/providers/tts/edge.md' }, - ], - }, - ], - '/zh/self-hosted/': [ - { - text: '自托管', - items: [ - { text: '总览', link: '/zh/self-hosted/' }, - { text: 'Desktop 桌面版', link: '/zh/self-hosted/desktop.md' }, - { text: 'Server Deploy', link: '/zh/self-hosted/docker.md' }, - { text: 'Workspace Backend', link: '/zh/self-hosted/workspace-backends.md' }, - ], - }, - ], + '/zh/guides/': references, + '/zh/integrations/': references, + '/zh/self-hosted/': references, } diff --git a/docs/about.md b/docs/about.md index 1e4e26f..2d53659 100644 --- a/docs/about.md +++ b/docs/about.md @@ -36,9 +36,9 @@ Access control is split between channel-side chat permissions and workspace-side ## Where To Start -- **[Bot Setup](/guides/bot)** - create and configure a bot. -- **[Providers And Models](/integrations/providers/llm)** - configure model access. -- **[Channels](/integrations/channels/)** - choose where bots are reachable. -- **[Skills](/guides/skills)** and **[Supermarket](/guides/supermarket)** - install reusable capabilities. -- **[Scheduled Tasks](/guides/schedule)** and **[Access Control](/guides/access)** - operate recurring work and permissions. -- **[Self-hosted](/self-hosted/)** - deploy and maintain your own Memoh instance. +- **[Bot Setup](./guides/bot.md)** - create and configure a bot. +- **[Providers And Models](./integrations/providers/llm.md)** - configure model access. +- **[Channels](./integrations/channels/index.md)** - choose where bots are reachable. +- **[Skills](./guides/skills.md)** and **[Supermarket](./guides/supermarket.md)** - install reusable capabilities. +- **[Scheduled Tasks](./guides/schedule.md)** and **[Access Control](./guides/access.md)** - operate recurring work and permissions. +- **[Self-hosted](./self-hosted/index.md)** - deploy and maintain your own Memoh instance. diff --git a/docs/guides/acp.md b/docs/guides/acp.md index 1951d7b..c1a30ef 100644 --- a/docs/guides/acp.md +++ b/docs/guides/acp.md @@ -90,7 +90,7 @@ ACP work uses the `acp_agent` session type. These sessions are created and manag ## Related Pages -- [Bot Management](/guides/bot.md) -- [Sessions](/guides/sessions.md) -- [Files](/guides/files.md) -- [Providers And Models](/integrations/providers/llm.md) +- [Bot Management](./bot.md) +- [Sessions](./sessions.md) +- [Files](./files.md) +- [Providers And Models](../integrations/providers/llm.md) diff --git a/docs/guides/bot.md b/docs/guides/bot.md index 47432a2..683cffb 100644 --- a/docs/guides/bot.md +++ b/docs/guides/bot.md @@ -58,11 +58,11 @@ After creating a bot, the most important step is configuring its runtime setting If you have not created these resources yet, set them up first: -- [Providers And Models](/integrations/providers/llm) -- [Built-in Memory Provider](/integrations/providers/memory/builtin.md) -- [Search Providers](/integrations/providers/web-search) -- [TTS Providers](/integrations/providers/tts/index.md) -- [Agents / ACP](/guides/acp.md) +- [Providers And Models](../integrations/providers/llm.md) +- [Built-in Memory Provider](../integrations/providers/memory/builtin.md) +- [Search Providers](../integrations/providers/web-search.md) +- [TTS Providers](../integrations/providers/tts/index.md) +- [Agents / ACP](./acp.md) --- @@ -85,8 +85,8 @@ The **General** tab contains the settings that shape everyday conversation behav Notes: - The **Image Generation Model** is intentionally separate from the normal chat model so you can dedicate an image-capable model only to visual generation tasks. -- The **TTS Model** comes from the [TTS Providers](/integrations/providers/tts/index.md) system and uses `speech` models from the configured speech provider. -- The selected chat model's `context_window` influences session status reporting and [Context Compaction](/guides/compaction). +- The **TTS Model** comes from the [TTS Providers](../integrations/providers/tts/index.md) system and uses `speech` models from the configured speech provider. +- The selected chat model's `context_window` influences session status reporting and [Context Compaction](./compaction.md). --- @@ -103,7 +103,7 @@ Compaction is now about **session context compaction**, not memory maintenance. The Compaction tab also exposes compaction logs so you can see recent successful, pending, or failed runs. -For the runtime behavior, see [Context Compaction](/guides/compaction). +For the runtime behavior, see [Context Compaction](./compaction.md). --- @@ -122,7 +122,7 @@ Use the **Access** tab to refine conversation, group, and thread rules after the ## Discuss-Related Advanced Settings -Most users only need the `chat` and `discuss` behavior described in [Sessions](/guides/sessions). +Most users only need the `chat` and `discuss` behavior described in [Sessions](./sessions.md). If you manage bot settings through the API or custom automation, the settings schema also includes `discuss_probe_model_id` for discuss-mode specific setups. Treat it as an advanced setting rather than a required field for normal bot creation. @@ -136,7 +136,7 @@ Workspace files and terminals are available from the chat workspace UI after the - Open terminal sessions inside the workspace runtime. - Use display/browser tools when the bot workspace has display support enabled. -For file workflows, see [Files](/guides/files.md). For headed browser and desktop workflows, see [Browser / Computer Use](/guides/browser-computer-use.md). +For file workflows, see [Files](./files.md). For headed browser and desktop workflows, see [Browser / Computer Use](./browser-computer-use.md). --- diff --git a/docs/guides/browser-computer-use.md b/docs/guides/browser-computer-use.md index 861c16e..17cc1c1 100644 --- a/docs/guides/browser-computer-use.md +++ b/docs/guides/browser-computer-use.md @@ -47,9 +47,9 @@ Computer Use depends on the `a11y-cli` binary installed under `/opt/memoh/toolki These tools are workspace runtime features. They do not automate the Electron desktop app itself. -When a bot has remote [Computers](/guides/computers.md) attached, Browser Use and Computer Use still run in the **Server Workspace** — they do not follow the selected work location. +When a bot has remote [Computers](./computers.md) attached, Browser Use and Computer Use still run in the **Server Workspace** — they do not follow the selected work location. ## Related -- [Bot Workspace Management](/guides/container) -- [Workspace Backends](/self-hosted/workspace-backends) +- [Bot Workspace Management](./container.md) +- [Workspace Backends](../self-hosted/workspace-backends.md) diff --git a/docs/guides/compaction.md b/docs/guides/compaction.md index 6a31b6e..bb9d71e 100644 --- a/docs/guides/compaction.md +++ b/docs/guides/compaction.md @@ -2,7 +2,7 @@ **Context Compaction** reduces the prompt footprint of a single conversation session by summarizing older turns and keeping the active context smaller. -This page is about **session context**, not long-term memory storage. If you want to merge or rewrite stored memories in a memory provider, see [Bot Memory Management](/guides/memory). +This page is about **session context**, not long-term memory storage. If you want to merge or rewrite stored memories in a memory provider, see [Bot Memory Management](./memory.md). --- @@ -14,7 +14,7 @@ New bots ship with automatic context compaction **enabled and zero-config**. You - If a session grows past about **75%** before the background pass catches up, Memoh compacts **synchronously** before sending the next turn. - Either path aims to bring the raw history back down to about **40%** of the window. -The only real prerequisite: the bot's chat model must declare a `context_window` in its model settings. Without it, the automatic policy has no budget to work against and never triggers. See [Providers And Models](/integrations/providers/llm.md). +The only real prerequisite: the bot's chat model must declare a `context_window` in its model settings. Without it, the automatic policy has no budget to work against and never triggers. See [Providers And Models](../integrations/providers/llm.md). Bots created before this default changed keep their stored settings and behave as configured (see legacy mode below). @@ -132,6 +132,6 @@ Use **Memory Compaction** when the bot's stored memories themselves have become ## Next Steps -- To inspect session runtime information, see [Sessions](/guides/sessions). -- To understand slash-triggered compaction, see [Slash Commands](/guides/slash-commands). -- To manage long-term memory instead of session context, see [Bot Memory Management](/guides/memory). +- To inspect session runtime information, see [Sessions](./sessions.md). +- To understand slash-triggered compaction, see [Slash Commands](./slash-commands.md). +- To manage long-term memory instead of session context, see [Bot Memory Management](./memory.md). diff --git a/docs/guides/computers.md b/docs/guides/computers.md index 948c80c..b9ff746 100644 --- a/docs/guides/computers.md +++ b/docs/guides/computers.md @@ -72,6 +72,6 @@ Every location has its own approval policy for **read**, **write**, and **execut ## Related Pages -- [Bot Workspace Management](/guides/container.md) -- [Browser / Computer Use](/guides/browser-computer-use.md) -- [Self-hosted Overview](/self-hosted/index.md) +- [Bot Workspace Management](./container.md) +- [Browser / Computer Use](./browser-computer-use.md) +- [Self-hosted Overview](../self-hosted/index.md) diff --git a/docs/guides/connectors.md b/docs/guides/connectors.md index 4c1dc5a..a1a01fb 100644 --- a/docs/guides/connectors.md +++ b/docs/guides/connectors.md @@ -18,7 +18,7 @@ api_token = "" # trusted server-to-server token Leaving both empty disables the feature. In deployed environments, prefer the matching environment variables (`MEMOH_CONNECT_IT_BASE_URL`, `MEMOH_CONNECT_IT_API_TOKEN`). -The one-click server deployment provisions a co-hosted Connect-It automatically on fresh installs; see [Server Deploy](/self-hosted/docker.md#connect-it-connectors). When Connect-It is not configured, the Supermarket hides the **Connectors** tab and connector operations report that connectors are not configured on this server. +The one-click server deployment provisions a co-hosted Connect-It automatically on fresh installs; see [Server Deploy](../self-hosted/docker.md#connect-it-connectors). When Connect-It is not configured, the Supermarket hides the **Connectors** tab and connector operations report that connectors are not configured on this server. --- @@ -67,6 +67,6 @@ Each connection gets a **tool namespace** derived from the connector type when i ## Related Pages -- [Supermarket](/guides/supermarket.md) — where connectors are discovered and connected. -- [MCP](/guides/mcp.md) — direct MCP connection management. -- [Server Deploy](/self-hosted/docker.md#connect-it-connectors) — co-hosted Connect-It provisioning, credentials, and the OAuth callback URL. +- [Supermarket](./supermarket.md) — where connectors are discovered and connected. +- [MCP](./mcp.md) — direct MCP connection management. +- [Server Deploy](../self-hosted/docker.md#connect-it-connectors) — co-hosted Connect-It provisioning, credentials, and the OAuth callback URL. diff --git a/docs/guides/container.md b/docs/guides/container.md index 1e08246..1e31398 100644 --- a/docs/guides/container.md +++ b/docs/guides/container.md @@ -14,9 +14,9 @@ The workspace acts as the bot's private computer. Within it, the bot can: The workspace toolkit ships both **Node.js** and **Python** runtimes (with `pip` and `uv` on the PATH), so bots can run Python scripts and install packages without preparing an interpreter first. -A bot can also work outside its server workspace on connected machines — see [Computers](/guides/computers.md). +A bot can also work outside its server workspace on connected machines — see [Computers](./computers.md). -The underlying runtime is selected globally with `[container].backend` in `config.toml`, with trusted local workspace support controlled separately. The official Docker Compose server deploy uses `containerd`; Docker Engine, Apple, and local workspace modes are documented in [Workspace Backends](/self-hosted/workspace-backends). +The underlying runtime is selected globally with `[container].backend` in `config.toml`, with trusted local workspace support controlled separately. The official Docker Compose server deploy uses `containerd`; Docker Engine, Apple, and local workspace modes are documented in [Workspace Backends](../self-hosted/workspace-backends.md). ## Workspace tabs @@ -48,7 +48,7 @@ Many workspace features, such as terminal access and container display, require The **Desktop** tab prepares and inspects the graphical workspace runtime. It checks for the desktop toolkit, Xvnc/VNC availability, browser availability, and active display sessions. -When enabled, the workspace can run a headed Chrome/Chromium browser inside the container. The Web UI display pane connects to that desktop session so you and the agent can operate the same visible browser. For the tool model, see [Browser / Computer Use](/guides/browser-computer-use). +When enabled, the workspace can run a headed Chrome/Chromium browser inside the container. The Web UI display pane connects to that desktop session so you and the agent can operate the same visible browser. For the tool model, see [Browser / Computer Use](./browser-computer-use.md). ## Container information diff --git a/docs/guides/get-started.md b/docs/guides/get-started.md new file mode 100644 index 0000000..4968de3 --- /dev/null +++ b/docs/guides/get-started.md @@ -0,0 +1,128 @@ +# Get Started + +Memoh gives you bots that can actually do things. Every bot has its own workspace — a real filesystem, an executable terminal, and an optional visible desktop with a browser — plus long-term memory and the chat channels you already use. + +This tutorial takes you from an empty account to a bot that completes real work. It takes about fifteen minutes. + +::: tip Looking for installation? +This page assumes you can already open a Memoh instance. If you need to deploy one yourself, read [Quick Start](./quick-start.md) first. +::: + +## Before You Begin + +You need: + +- Access to a Memoh instance and an account that can create bots. +- An API key for at least one model provider (OpenAI, Anthropic, Gemini, DeepSeek, Zhipu, OpenRouter, Ollama, and others). Skip this if an administrator has already configured providers. + +## 1. Sign In + +Open the Memoh Web UI and sign in. + +If this is a fresh instance, change the initial password immediately under **Settings → Account**. + +Interface language, theme, and similar options can be adjusted at any time in [Preferences](./preferences.md). They do not affect the steps below. + +## 2. Add A Model Provider + +A bot cannot think without a model. Skip this step if your administrator has already configured one. + +1. Open **Providers** in the sidebar and click **Add Provider**. +2. Pick a template, paste your API key, and save. +3. Open the provider and **sync** its model list, or add at least one chat model manually. + +For client types, base URLs, and provider-specific notes, see [LLM Providers](../integrations/providers/llm.md). + +## 3. Create Your First Bot + +Go to **Bots → New Bot**, give it a name and display name, then select your chat model on the **General** tab. + +Now write its instructions. This step matters most, and it is where people most often go wrong — usually by being too vague. Describe one job clearly: + +> **Name:** Digest +> +> **Role:** Weekly reading digest +> +> **Instructions:** Collect the articles I send you during the week. Every Friday, produce a digest grouped by theme: one sentence per article with its original link, followed by a "worth re-reading" section. Keep original links unchanged. Never publish anything publicly. + +A bot with one focused job accumulates far more useful context than a bot that does everything. When work genuinely splits into separate roles, create another bot instead of overloading this one — each bot has its own workspace, memory, and configuration. For a walkthrough of every tab, see [Bot](./bot.md). + +Click **Chat** and say hello. A reply confirms the model path works. + +## 4. Give It A Task + +A good first request answers five questions: + +| Element | The question it answers | +|---------|------------------------| +| **Outcome** | What should exist when this is done? | +| **Source** | Which files, sites, or conversations are relevant? | +| **Constraints** | What must it avoid, and what needs your approval? | +| **Format** | How should the answer be delivered? | +| **Checkpoint** | When should it stop and confirm with you? | + +For a result in minutes with no external logins, upload a document and try: + +```text +Summarize this document into five key points. In a separate section, list every +date, decision, and open question, noting which page or section each came from. +Do not modify the original file. +``` + +The bot reads the file inside its own workspace and writes the result back to the conversation. Everything it produces stays in the workspace, where you can browse and edit it under [Files](./files.md). + +## 5. Let It Use The Workspace And Browser + +The workspace is where a bot stops being a chatbot. It has a Linux filesystem, a terminal, and a preinstalled toolchain (Python, Node.js, uv, npm), so it can actually run the work: + +```text +Remove every row with an empty email column from the CSV I just uploaded. +Give me the cleaned file and tell me how many rows you dropped. +``` + +When a task needs a real browser — a site that breaks in headless mode, or a page behind a login — enable the visible desktop on the bot's **Desktop** tab. Once started, the bot drives a headed Chrome and you can watch it work in the display panel. + +When it hits a login wall, take over the screen yourself: type the password, passkey, or one-time code, then hand control back. The browser session stays in that workspace, so later tasks remain signed in. + +::: warning Grant access deliberately +Workspace access is tiered: chat only, read files, write files, execute commands, and manage the container. Grant the level the job needs and no more. See [Access Control](./access.md). +::: + +For details, see [Workspace](./container.md) and [Browser / Computer Use](./browser-computer-use.md). + +## 6. Connect A Chat Channel + +A bot is most useful where you already talk. + +1. Open the bot's **Platforms** tab and click **Add**. +2. Choose a platform — Telegram, Slack, Discord, Feishu, DingTalk, WeCom, QQ, LINE, Matrix, or Misskey — and paste that platform's credentials. +3. Message it from that platform. The first message creates a session; send `/help` to see the available [slash commands](./slash-commands.md). + +From then on you can hand off a task from your phone and collect the result in the same conversation. For per-platform setup, see [Channels](../integrations/channels/index.md). + +## 7. Review, Then Make It Stick + +When something is not right, say so. Phrase corrections as durable rules rather than one-off fixes: + +```text +For all future digests, use this format: grouped by theme, one line per article, +links inline, and a "worth re-reading" section at the end. +``` + +Once a routine is stable, stop retyping it: + +- Save it as a [Skill](./skills.md) so one sentence invokes the whole routine. +- Turn it into a [Scheduled Task](./schedule.md) that runs on cron with no chat at all. +- Use [Memory](./memory.md) to carry your preferences and project context into every future session. + +## Next Steps + +| Goal | Read | +|------|------| +| Configure a bot tab by tab | [Bot](./bot.md) | +| Understand chat, discuss, and routing | [Sessions](./sessions.md) | +| Connect external tools and data | [MCP](./mcp.md), [Connectors](./connectors.md) | +| Install prebuilt capabilities | [Supermarket](./supermarket.md) | +| Attach your own machine as a work location | [Computers](./computers.md) | +| Hook into lifecycle events | [Hooks](./hooks.md) | +| Control who can talk to a bot | [Access Control](./access.md) | \ No newline at end of file diff --git a/docs/guides/hooks.md b/docs/guides/hooks.md index 6d20e0e..33a6e95 100644 --- a/docs/guides/hooks.md +++ b/docs/guides/hooks.md @@ -267,5 +267,5 @@ Hooks are powerful. Treat them like code that runs inside the bot workspace. ## Related Pages -- [Bot Management](/guides/bot.md) -- [Skills](/guides/skills.md) +- [Bot Management](./bot.md) +- [Skills](./skills.md) diff --git a/docs/guides/index.md b/docs/guides/index.md index 5fb4b3d..b66a663 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -1,32 +1,39 @@ -# Guides +# References -Use these guides to learn Memoh from the product workflow side. They assume you already have access to Memoh and want to create bots, manage sessions, connect tools, and operate day-to-day features. +Welcome to the Memoh references. Everything you need to deploy, configure, and operate Memoh lives here, organized into three sections. -## Start Using Memoh +## Getting Started -- **[Quick Start](/guides/quick-start)**: Deploy a server, add a model, create your first bot, and connect a channel. -- **[Preferences](/guides/preferences)**: Customize language, theme, typography, diagrams, and keyboard shortcuts. -- **[Bot](/guides/bot)**: Create a bot and configure its core tabs. -- **[Sessions](/guides/sessions)**: Understand chat and discuss sessions, routing, and status panels. -- **[Files](/guides/files)**: Browse and edit files in a bot workspace. -- **[Memory](/guides/memory)**: Manage long-term memory entries after a provider is configured. +Start here if you are new to Memoh. Learn how to deploy, add a model, create your first bot, connect a channel, and handle day-to-day basics. -## Extend Bot Capabilities +- **[Get Started](./get-started.md)**: A guided tutorial — sign in, create a bot, give it real work, and connect a channel. +- **[Quick Start](./quick-start.md)**: Deploy a server, add a model, create your first bot, and connect a channel in ten minutes. +- **[Preferences](./preferences.md)**: Customize language, theme, typography, diagrams, and keyboard shortcuts. +- **[Bot](./bot.md)**: Create a bot and configure its core tabs. +- **[Sessions](./sessions.md)**: Understand chat and discuss sessions, routing, and status panels. +- **[Files](./files.md)**: Browse and edit files in a bot workspace. +- **[Slash Commands](./slash-commands.md)**: Use command shortcuts for daily control. +- **[Deployment](../self-hosted/index.md)**: Choose a hosting option and deploy your own instance. +- **[Channels](../integrations/channels/index.md)**: Connect Memoh to Slack, Telegram, Feishu, Discord, and more. -- **[Skills](/guides/skills)** and **[Supermarket](/guides/supermarket)**: Add reusable prompt modules and catalog templates. -- **[Hooks](/guides/hooks)** and **[MCP](/guides/mcp)**: Connect tools, automation rules, and external data sources. -- **[Browser / Computer Use](/guides/browser-computer-use)**: Work with headed browsers and visible desktop sessions. -- **[Slash Commands](/guides/slash-commands)**: Use command shortcuts for daily control. +## Advanced -## Configure Access And Operations +Deepen your usage once the basics are in place. These pages cover capabilities, automation, and external providers. -- **[Access Control](/guides/access)**: Configure ACL presets, rule ordering, and scoped access. -- **[Workspace](/guides/container)**: Understand workspace behavior from the product UI. -- **[Compaction](/guides/compaction)**: Reduce active session context size. -- **[Scheduled Tasks](/guides/schedule)**: Run recurring work on a cron schedule without an active chat. -- **[Email](/guides/email)**: Configure email workflows. +- **[Agents / ACP](./acp.md)**: Build multi-agent workflows and interoperate with the Agent Client Protocol. +- **[Access Control](./access.md)**: Configure ACL presets, rule ordering, and scoped access. +- **[Workspace](./container.md)**: Understand workspace behavior from the product UI. +- **[Computers](./computers.md)**: Register machines as remote runtimes. +- **[Browser / Computer Use](./browser-computer-use.md)**: Work with headed browsers and visible desktop sessions. +- **[Skills](./skills.md)** and **[Supermarket](./supermarket.md)**: Add reusable prompt modules and catalog templates. +- **[Connectors](./connectors.md)**: Connect hosted integrations such as Connect-It. +- **[Hooks](./hooks.md)** and **[MCP](./mcp.md)**: Connect tools, automation rules, and external data sources. +- **[Memory](./memory.md)**: Manage long-term memory after a provider is configured. +- **[Compaction](./compaction.md)**: Reduce active session context size. +- **[Scheduled Tasks](./schedule.md)**: Run recurring work on a cron schedule. +- **[Email](./email.md)**: Configure email workflows. +- **[Providers](../integrations/providers/index.md)**: LLM, web search, video, memory, and TTS providers. -## Other Documentation Areas +## Use Cases -- **[Integrations](/integrations/)**: Connect channels and providers. -- **[Self-hosted](/self-hosted/)**: Deploy and operate your own Memoh instance. +- **[Use Cases](./use-cases.md)**: Ready-to-follow scenarios that combine features to solve real problems. \ No newline at end of file diff --git a/docs/guides/mcp.md b/docs/guides/mcp.md index e87cee9..bde74ba 100644 --- a/docs/guides/mcp.md +++ b/docs/guides/mcp.md @@ -6,7 +6,7 @@ Memoh fully supports the **Model Context Protocol (MCP)**, allowing you to conne MCP provides a standardized way for bots to access external data sources and tools. Each Bot can have its own independent set of MCP connections. -You can configure connections manually from the **MCP** tab, or start from a curated template in **[Supermarket](/guides/supermarket.md)** and then review the prefilled draft in the bot editor. +You can configure connections manually from the **MCP** tab, or start from a curated template in **[Supermarket](./supermarket.md)** and then review the prefilled draft in the bot editor. --- diff --git a/docs/guides/memory.md b/docs/guides/memory.md index 433b738..6c6a756 100644 --- a/docs/guides/memory.md +++ b/docs/guides/memory.md @@ -6,7 +6,7 @@ Memoh's structured long-term memory system allows bots to remember information a Before using the **Memory** tab, make sure your bot already has a **Memory Provider** configured. -1. Create a provider from one of the [Memory Providers](/integrations/providers/memory/index.md) (Built-in, Mem0, or OpenViking). +1. Create a provider from one of the [Memory Providers](../integrations/providers/memory/index.md) (Built-in, Mem0, or OpenViking). 2. Open your bot's **General** tab. 3. Select the provider in the **Memory Provider** field. 4. Click **Save**. @@ -19,7 +19,7 @@ Without a memory provider, the bot will not have an active memory backend config Memories are stored and retrieved through the assigned memory provider. Depending on the provider type, retrieval may use the built-in memory graph, pgvector embeddings, or an external API. When a user sends a message, Memoh finds the most relevant memories and includes them in the bot's runtime context. -This page is about **long-term memory**. It is separate from **session context compaction**, which reduces the prompt footprint of a single conversation session. See [Context Compaction](/guides/compaction). +This page is about **long-term memory**. It is separate from **session context compaction**, which reduces the prompt footprint of a single conversation session. See [Context Compaction](./compaction.md). --- @@ -55,7 +55,7 @@ Parameters: - **Ratio** — Compression ratio such as `0.8`, `0.5`, or `0.3`. Lower values make compaction more aggressive. - **Decay Days** — Optionally restrict compaction to older memories only. -This is different from [Context Compaction](/guides/compaction), which compresses the active prompt for one session rather than rewriting stored memories. +This is different from [Context Compaction](./compaction.md), which compresses the active prompt for one session rather than rewriting stored memories. --- @@ -110,5 +110,5 @@ If you are trying to shorten the currently active conversation history, use **Co - The bot automatically searches and retrieves memories during chat. - The assigned **Memory Provider** controls the memory backend used by the bot. -- Provider-specific settings (such as embedding model or API keys) are configured in the provider itself — see [Memory Providers](/integrations/providers/memory/index.md). +- Provider-specific settings (such as embedding model or API keys) are configured in the provider itself — see [Memory Providers](../integrations/providers/memory/index.md). - Memories provide the long-term knowledge that makes each bot unique to its owner. diff --git a/docs/guides/quick-start.md b/docs/guides/quick-start.md index be28f9b..3ff6b38 100644 --- a/docs/guides/quick-start.md +++ b/docs/guides/quick-start.md @@ -48,7 +48,7 @@ When it finishes you should see: 🔑 Admin login: admin / ``` -Read [Server Deploy](/self-hosted/docker) for production hardening, reverse proxies, and upgrades. +Read [Server Deploy](../self-hosted/docker.md) for production hardening, reverse proxies, and upgrades. ## Step 2: Sign in @@ -60,7 +60,7 @@ Open `http://:8082` and sign in with the admin account you chose du 2. Pick a template (OpenAI, Anthropic, Gemini, DeepSeek, Zhipu, OpenRouter, Ollama, ...) and paste your API key. 3. Open the provider and **sync** or add at least one chat model. -Details and client types are in [LLM Providers](/integrations/providers/llm). +Details and client types are in [LLM Providers](../integrations/providers/llm.md). ## Step 4: Create your first bot @@ -68,7 +68,7 @@ Details and client types are in [LLM Providers](/integrations/providers/llm). 2. In the bot's **General** tab choose the chat model you just added. 3. Click the bot's **Chat** button and say hello. If you get a reply, the pipeline works. -Each bot has its own workspace, memory, and settings; see [Bot](/guides/bot) for every tab. +Each bot has its own workspace, memory, and settings; see [Bot](./bot.md) for every tab. ## Step 5: Connect a channel @@ -76,16 +76,16 @@ Each bot has its own workspace, memory, and settings; see [Bot](/guides/bot) for 2. Pick a platform (Telegram, Discord, Slack, Feishu, DingTalk, WeCom, QQ, LINE, Matrix, Misskey, ...) and paste the platform credentials. 3. Message the bot from that platform. The first message creates a session; use `/help` to see the available slash commands. -Per-platform setup guides live under [Channels](/integrations/channels/). +Per-platform setup guides live under [Channels](../integrations/channels/index.md). ## What's next | Goal | Read | |------|------| -| Let the bot remember users across sessions | [Memory](/guides/memory) | -| Run scheduled or recurring tasks | [Schedule](/guides/schedule) | -| Give the bot files, shell access, and a browser | [Workspace](/guides/container), [Computers](/guides/computers) | -| Add tools via MCP servers | [MCP](/guides/mcp) | -| Teach the bot reusable procedures | [Skills](/guides/skills), [Supermarket](/guides/supermarket) | -| Control who can talk to the bot | [Access Control](/guides/access) | -| Run everything on a Mac with the desktop app | [Desktop](/self-hosted/desktop) | \ No newline at end of file +| Let the bot remember users across sessions | [Memory](./memory.md) | +| Run scheduled or recurring tasks | [Schedule](./schedule.md) | +| Give the bot files, shell access, and a browser | [Workspace](./container.md), [Computers](./computers.md) | +| Add tools via MCP servers | [MCP](./mcp.md) | +| Teach the bot reusable procedures | [Skills](./skills.md), [Supermarket](./supermarket.md) | +| Control who can talk to the bot | [Access Control](./access.md) | +| Run everything on a Mac with the desktop app | [Desktop](../self-hosted/desktop.md) | \ No newline at end of file diff --git a/docs/guides/sessions.md b/docs/guides/sessions.md index 1ef9b10..8d59076 100644 --- a/docs/guides/sessions.md +++ b/docs/guides/sessions.md @@ -14,7 +14,7 @@ Sessions are scoped per bot — each bot manages its own set of sessions indepen ## Session Types -Memoh uses six session types to separate different kinds of bot activity: +Memoh uses five session types to separate different kinds of bot activity: | Type | Description | |------|-------------| @@ -129,7 +129,7 @@ Key fields include: - **Cache Read / Cache Write** — token counts associated with caching - **Skills** — effective skills used by the session -The panel also exposes **Compact Now**, which triggers immediate [Context Compaction](/guides/compaction) for the current session. +The panel also exposes **Compact Now**, which triggers immediate [Context Compaction](./compaction.md) for the current session. --- diff --git a/docs/guides/skills.md b/docs/guides/skills.md index 75d3f3c..c14caf3 100644 --- a/docs/guides/skills.md +++ b/docs/guides/skills.md @@ -1,6 +1,6 @@ # Bot Skills -Skills are reusable prompt modules that extend a bot's behavior, style, and tool-usage guidance. You manage them from the bot's **Skills** tab, and you can either write them yourself or install them from **[Supermarket](/guides/supermarket.md)**. +Skills are reusable prompt modules that extend a bot's behavior, style, and tool-usage guidance. You manage them from the bot's **Skills** tab, and you can either write them yourself or install them from **[Supermarket](./supermarket.md)**. --- @@ -154,4 +154,4 @@ If a discovered skill is useful but you want to fully manage it in Memoh, adopt 2. Prefer clear names and short descriptions. 3. Use **Disable** before **Delete** if you are unsure. 4. Use **Adopt** for legacy skills you plan to keep. -5. Install reusable skills from **[Supermarket](/guides/supermarket.md)** instead of copy-pasting them repeatedly. +5. Install reusable skills from **[Supermarket](./supermarket.md)** instead of copy-pasting them repeatedly. diff --git a/docs/guides/slash-commands.md b/docs/guides/slash-commands.md index 59ab4fc..6347e60 100644 --- a/docs/guides/slash-commands.md +++ b/docs/guides/slash-commands.md @@ -38,7 +38,7 @@ Two commands are **top-level** instead of resource groups: ## Skill Activation And Quick Actions -Besides fixed commands, the slash system can activate the bot's [Skills](/guides/skills.md) on demand: +Besides fixed commands, the slash system can activate the bot's [Skills](./skills.md) on demand: ```text / [optional prompt] @@ -155,7 +155,7 @@ Default behavior: `/new discuss` is not supported in the built-in Web UI local channel. Use a channel adapter such as Telegram or Discord if you want explicit discuss sessions. -See [Sessions](/guides/sessions) for how `chat` and `discuss` differ. +See [Sessions](./sessions.md) for how `chat` and `discuss` differ. ### `/stop` @@ -397,4 +397,4 @@ Actions: |--------|-------| | `run` | `/compact` or `/compact run` | -Use this when the current conversation has grown long and you want Memoh to summarize older turns before continuing. See [Context Compaction](/guides/compaction). +Use this when the current conversation has grown long and you want Memoh to summarize older turns before continuing. See [Context Compaction](./compaction.md). diff --git a/docs/guides/supermarket.md b/docs/guides/supermarket.md index 55f6cc9..2db196e 100644 --- a/docs/guides/supermarket.md +++ b/docs/guides/supermarket.md @@ -7,13 +7,13 @@ The Web UI shows Supermarket under Settings with two tabs: - **Connectors** - **Skills** -**Connectors** comes first and is the default landing tab when the server has [Connect-It configured](/guides/connectors.md#requirements). Without Connect-It, the tab is hidden and **Skills** is the default instead. +**Connectors** comes first and is the default landing tab when the server has [Connect-It configured](./connectors.md#requirements). Without Connect-It, the tab is hidden and **Skills** is the default instead. --- ## Connect A Service -The **Connectors** tab lists services a bot can connect through OAuth or an API key. Pick one, click **Connect**, select the target bot, and complete the authorization. The full flow — authentication methods, connection statuses, and how connector tools reach the bot — is documented in [Connectors](/guides/connectors.md). +The **Connectors** tab lists services a bot can connect through OAuth or an API key. Pick one, click **Connect**, select the target bot, and complete the authorization. The full flow — authentication methods, connection statuses, and how connector tools reach the bot — is documented in [Connectors](./connectors.md). --- @@ -26,7 +26,7 @@ The **Connectors** tab lists services a bot can connect through OAuth or an API 5. Confirm the install. 6. The skill appears in that bot's **Skills** tab. -Skills install into the bot's managed skills directory (`/data/skills/` inside the bot workspace). Skill detail pages show the author, version, registry, and links. See [Skills](/guides/skills.md) for how skills are loaded and used. +Skills install into the bot's managed skills directory (`/data/skills/` inside the bot workspace). Skill detail pages show the author, version, registry, and links. See [Skills](./skills.md) for how skills are loaded and used. --- diff --git a/docs/guides/use-cases.md b/docs/guides/use-cases.md new file mode 100644 index 0000000..e069274 --- /dev/null +++ b/docs/guides/use-cases.md @@ -0,0 +1,5 @@ +# Use Cases + +Ready-to-follow scenarios that combine multiple Memoh features to solve real problems. + +> Coming soon. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 55e1f2e..e8555f0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,6 @@ --- title: Memoh Documentation +description: Learn Memoh, connect external systems, or run your own deployment. --- # Memoh Documentation diff --git a/docs/integrations/channels/index.md b/docs/integrations/channels/index.md index bb97ec1..45ef2f3 100644 --- a/docs/integrations/channels/index.md +++ b/docs/integrations/channels/index.md @@ -6,18 +6,18 @@ Channels connect Memoh bots to messaging platforms. Configure them from the bot | Platform | Guide | Notes | |----------|-------|-------| -| Slack | [Slack Configuration](/integrations/channels/slack) | Workspace messaging with threads | -| Telegram | [Telegram Configuration](/integrations/channels/telegram) | Strong attachment and streaming support | -| Feishu (Lark) | [Feishu Configuration](/integrations/channels/feishu) | Supports webhook-style inbound mode | -| Discord | [Discord Configuration](/integrations/channels/discord) | Good fit for communities and servers | -| QQ | [QQ Configuration](/integrations/channels/qq) | Personal DM oriented | -| Matrix | [Matrix Configuration](/integrations/channels/matrix) | Decentralized homeserver support | -| Misskey | [Misskey Configuration](/integrations/channels/misskey) | Replies and reactions, no streaming | -| DingTalk | [DingTalk Configuration](/integrations/channels/dingtalk) | Enterprise private/group chat | -| WeCom (WeWork) | [WeCom Configuration](/integrations/channels/wecom) | Enterprise workspace integration | -| WeChat | [WeChat Configuration](/integrations/channels/weixin) | Personal QR login flow | -| WeChat Official Account | [WeChat Official Account Configuration](/integrations/channels/wechatoa) | Official account webhook flow | -| Email | [Email](/guides/email) | SMTP, Mailgun, Gmail OAuth, and related email provider flows | +| Slack | [Slack Configuration](./slack.md) | Workspace messaging with threads | +| Telegram | [Telegram Configuration](./telegram.md) | Strong attachment and streaming support | +| Feishu (Lark) | [Feishu Configuration](./feishu.md) | Supports webhook-style inbound mode | +| Discord | [Discord Configuration](./discord.md) | Good fit for communities and servers | +| QQ | [QQ Configuration](./qq.md) | Personal DM oriented | +| Matrix | [Matrix Configuration](./matrix.md) | Decentralized homeserver support | +| Misskey | [Misskey Configuration](./misskey.md) | Replies and reactions, no streaming | +| DingTalk | [DingTalk Configuration](./dingtalk.md) | Enterprise private/group chat | +| WeCom (WeWork) | [WeCom Configuration](./wecom.md) | Enterprise workspace integration | +| WeChat | [WeChat Configuration](./weixin.md) | Personal QR login flow | +| WeChat Official Account | [WeChat Official Account Configuration](./wechatoa.md) | Official account webhook flow | +| Email | [Email](../../guides/email.md) | SMTP, Mailgun, Gmail OAuth, and related email provider flows | | Web | Built-in | Available from the Memoh web interface | ## WeChat Options diff --git a/docs/integrations/channels/matrix.md b/docs/integrations/channels/matrix.md index ff1c04a..cff0a14 100644 --- a/docs/integrations/channels/matrix.md +++ b/docs/integrations/channels/matrix.md @@ -56,7 +56,7 @@ curl -X POST "https:///_matrix/client/v3/login" \ - **Direct Messages**: Private conversations with individual users. - **Streaming**: Responses are streamed as they are generated. - **Markdown**: Support for formatted text. -- **Media/Attachment**: Bots can receive and send files or photo. +- **Media/Attachment**: Bots can receive and send files or photos. - Check [the roadmap](https://github.com/felinics/Memoh/issues/249) for more features of Matrix. ## Official Resources diff --git a/docs/integrations/providers/index.md b/docs/integrations/providers/index.md index 8684c4b..c5bdb1b 100644 --- a/docs/integrations/providers/index.md +++ b/docs/integrations/providers/index.md @@ -4,9 +4,9 @@ Providers connect Memoh to external capability backends. Configure them before a ## Provider Types -- **[LLM Providers](/integrations/providers/llm)**: Chat, embedding, image, and related model configuration. -- **[Memory Providers](/integrations/providers/memory/)**: Long-term memory storage and retrieval backends. -- **[TTS Providers](/integrations/providers/tts/)**: Speech synthesis providers and voices. -- **[Web Search Providers](/integrations/providers/web-search)**: Search providers used by web access tools. +- **[LLM Providers](./llm.md)**: Chat, embedding, image, and related model configuration. +- **[Memory Providers](./memory/index.md)**: Long-term memory storage and retrieval backends. +- **[TTS Providers](./tts/index.md)**: Speech synthesis providers and voices. +- **[Web Search Providers](./web-search.md)**: Search providers used by web access tools. -For product-level usage after provider setup, see **[Bot](/guides/bot)** and **[Memory](/guides/memory)**. +For product-level usage after provider setup, see **[Bot](../../guides/bot.md)** and **[Memory](../../guides/memory.md)**. diff --git a/docs/integrations/providers/llm.md b/docs/integrations/providers/llm.md index a2be8e4..a98e76a 100644 --- a/docs/integrations/providers/llm.md +++ b/docs/integrations/providers/llm.md @@ -7,7 +7,7 @@ To use Memoh effectively, you usually configure: - optional **speech providers** if you want text-to-speech - optional **transcription providers** if you want speech-to-text -The Web UI manages chat and embedding providers/models from the **Models** page. Speech models are managed from [TTS Providers](/integrations/providers/tts/index.md), and transcription models are managed from the Transcription settings page. +The Web UI manages chat and embedding providers/models from the **Models** page. Speech models are managed from [TTS Providers](./tts/index.md), and transcription models are managed from the Transcription settings page. --- @@ -70,7 +70,7 @@ Memoh currently supports these client types: | `microsoft-speech` | Microsoft speech providers | | `google-transcription` | Google transcription providers | -Speech and transcription client types are for audio workflows, not for chat. Configure speech through [TTS Providers](/integrations/providers/tts/index.md) and transcription through the Transcription settings page. Exact model and voice availability depends on the configured provider template and upstream account. +Speech and transcription client types are for audio workflows, not for chat. Configure speech through [TTS Providers](./tts/index.md) and transcription through the Transcription settings page. Exact model and voice availability depends on the configured provider template and upstream account. --- @@ -151,7 +151,7 @@ Memoh distinguishes four model types: Important distinction: - The **Models** page is primarily where you manage `chat` and `embedding` models. -- `speech` models are exposed through [TTS Providers](/integrations/providers/tts/index.md). +- `speech` models are exposed through [TTS Providers](./tts/index.md). - `transcription` models are exposed through the Transcription settings page. --- @@ -188,7 +188,7 @@ If a model supports reasoning, it may also declare `reasoning_efforts` such as ` - calculate session context usage in the Web UI - power `/status` output - decide when a session is approaching its prompt limit -- guide [Context Compaction](/guides/compaction) +- guide [Context Compaction](../../guides/compaction.md) If you leave `context_window` empty, the model can still be used, but Memoh cannot show an exact usage percentage for that model. @@ -216,7 +216,7 @@ Use embedding models with memory providers or any feature that relies on vector ## Speech And Transcription Models -Speech models are managed from [TTS Providers](/integrations/providers/tts/index.md), not from the standard chat provider flow. +Speech models are managed from [TTS Providers](./tts/index.md), not from the standard chat provider flow. Current speech provider categories include: @@ -256,6 +256,6 @@ You do not need to force one model to do everything. ## Next Steps -- To assign chat, image, memory, and TTS settings to a bot, see [Bot Management](/guides/bot). -- To configure speech providers and speech models, see [TTS Providers](/integrations/providers/tts/index.md). +- To assign chat, image, memory, and TTS settings to a bot, see [Bot Management](../../guides/bot.md). +- To configure speech providers and speech models, see [TTS Providers](./tts/index.md). - To configure speech-to-text, open the Transcription settings page in the Web UI. diff --git a/docs/integrations/providers/memory/builtin.md b/docs/integrations/providers/memory/builtin.md index 41b152a..ec39a81 100644 --- a/docs/integrations/providers/memory/builtin.md +++ b/docs/integrations/providers/memory/builtin.md @@ -96,4 +96,4 @@ Once a memory provider is assigned to the bot, you can manage actual memories fr - Search, edit, and delete memories - Compact or rebuild the memory store -For day-to-day memory operations, continue with [Bot Memory Management](/guides/memory.md). \ No newline at end of file +For day-to-day memory operations, continue with [Bot Memory Management](../../../guides/memory.md). \ No newline at end of file diff --git a/docs/integrations/providers/memory/index.md b/docs/integrations/providers/memory/index.md index 66ca1ae..b8514ce 100644 --- a/docs/integrations/providers/memory/index.md +++ b/docs/integrations/providers/memory/index.md @@ -6,9 +6,9 @@ Memoh uses a **Memory Provider** to define how a bot stores, retrieves, and mana Memoh supports the following memory providers: -- [Built-in](/integrations/providers/memory/builtin.md): The default memory system included with Memoh. Stores a memory graph in PostgreSQL and optionally adds pgvector-backed semantic search when an embedding model is configured. -- [Mem0](/integrations/providers/memory/mem0.md): SaaS memory provider via the Mem0 API. Requires an API key. -- [OpenViking](/integrations/providers/memory/openviking.md): Self-hosted or SaaS memory provider with its own API. +- [Built-in](./builtin.md): The default memory system included with Memoh. Stores a memory graph in PostgreSQL and optionally adds pgvector-backed semantic search when an embedding model is configured. +- [Mem0](./mem0.md): SaaS memory provider via the Mem0 API. Requires an API key. +- [OpenViking](./openviking.md): Self-hosted or SaaS memory provider with its own API. --- @@ -24,7 +24,7 @@ Memoh supports the following memory providers: ## Next Steps -- [Built-in Memory Provider](/integrations/providers/memory/builtin.md) — Default, self-hosted; PostgreSQL graph plus optional pgvector semantic index. -- [Mem0 Memory Provider](/integrations/providers/memory/mem0.md) — SaaS via Mem0 API. -- [OpenViking Memory Provider](/integrations/providers/memory/openviking.md) — Self-hosted or SaaS. -- [Bot Memory Management](/guides/memory.md) — Manage memory entries after the provider is assigned. +- [Built-in Memory Provider](./builtin.md) — Default, self-hosted; PostgreSQL graph plus optional pgvector semantic index. +- [Mem0 Memory Provider](./mem0.md) — SaaS via Mem0 API. +- [OpenViking Memory Provider](./openviking.md) — Self-hosted or SaaS. +- [Bot Memory Management](../../../guides/memory.md) — Manage memory entries after the provider is assigned. diff --git a/docs/integrations/providers/memory/mem0.md b/docs/integrations/providers/memory/mem0.md index cf762a7..20afa43 100644 --- a/docs/integrations/providers/memory/mem0.md +++ b/docs/integrations/providers/memory/mem0.md @@ -42,4 +42,4 @@ After creating a provider, select it from the list and configure its settings. Once assigned, the bot will use Mem0 as its memory backend. Memory extraction, search, and management operations are routed through the Mem0 API. -For day-to-day memory operations, see [Bot Memory Management](/guides/memory.md). +For day-to-day memory operations, see [Bot Memory Management](../../../guides/memory.md). diff --git a/docs/integrations/providers/memory/openviking.md b/docs/integrations/providers/memory/openviking.md index 8dc5ce7..a9b4dc4 100644 --- a/docs/integrations/providers/memory/openviking.md +++ b/docs/integrations/providers/memory/openviking.md @@ -40,4 +40,4 @@ After creating a provider, select it from the list and configure its settings. Once assigned, the bot will use OpenViking as its memory backend. Memory extraction, search, and management operations are routed through the OpenViking API. -For day-to-day memory operations, see [Bot Memory Management](/guides/memory.md). +For day-to-day memory operations, see [Bot Memory Management](../../../guides/memory.md). diff --git a/docs/integrations/providers/tts/index.md b/docs/integrations/providers/tts/index.md index 46c2648..6d1c3db 100644 --- a/docs/integrations/providers/tts/index.md +++ b/docs/integrations/providers/tts/index.md @@ -24,7 +24,7 @@ Memoh supports **Text-to-Speech (TTS)** so bots can synthesize spoken audio from | Provider | Description | |----------|-------------| -| [Edge TTS](/integrations/providers/tts/edge.md) | Free, uses Microsoft Edge's public read-aloud API. 256+ voices across 50+ languages. No API key required. | +| [Edge TTS](./edge.md) | Free, uses Microsoft Edge's public read-aloud API. 256+ voices across 50+ languages. No API key required. | | OpenAI-compatible speech | Uses OpenAI-compatible speech APIs when configured with a matching provider template and credentials. | | OpenRouter Speech | Uses OpenRouter speech-capable routes when available to the configured account. | | ElevenLabs Speech | Uses ElevenLabs text-to-speech models and voices. | @@ -42,5 +42,5 @@ Transcription is managed separately from TTS. Memoh also supports transcription ## Next Steps -- To set up the no-key Edge option, continue with [Edge TTS](/integrations/providers/tts/edge.md). -- To understand how audio provider client types relate to models, see [Providers And Models](/integrations/providers/llm). +- To set up the no-key Edge option, continue with [Edge TTS](./edge.md). +- To understand how audio provider client types relate to models, see [Providers And Models](../llm.md). diff --git a/docs/integrations/providers/video.md b/docs/integrations/providers/video.md index 2475ca0..c625382 100644 --- a/docs/integrations/providers/video.md +++ b/docs/integrations/providers/video.md @@ -54,5 +54,5 @@ If the workspace is unreachable when generation finishes, the task still complet ## Related Pages -- [Providers And Models](/integrations/providers/llm.md) -- [Bot Workspace Management](/guides/container.md) +- [Providers And Models](./llm.md) +- [Bot Workspace Management](../../guides/container.md) diff --git a/docs/self-hosted/desktop.md b/docs/self-hosted/desktop.md index 40bcc3c..b205c28 100644 --- a/docs/self-hosted/desktop.md +++ b/docs/self-hosted/desktop.md @@ -2,7 +2,7 @@ Memoh Desktop is the native client for Memoh Cloud or a self-hosted Memoh server. It packages the same Web UI into an Electron shell with native windows, tray, menus, and keyboard integration, and it can register the computer it runs on as a **Computer** that your bots can use. -Desktop does **not** run its own local server or database. You always connect it to a Memoh server: either [Memoh Cloud](https://memoh.ai) or your own [Server Deploy](/self-hosted/docker). +Desktop does **not** run its own local server or database. You always connect it to a Memoh server: either [Memoh Cloud](https://memoh.ai) or your own [Server Deploy](./docker.md). ## When to use Desktop @@ -35,7 +35,7 @@ Switching to a different server clears the local sign-in state, so you will auth Desktop can register the machine it runs on as a **Computer** that server-side bots can work on, without running a separate runtime process. Enable **This computer**, give it a name, and Desktop keeps the connection alive in the background using the embedded Memoh runtime SDK. Credentials are stored with the OS secure storage. -See [Computers](/guides/computers.md) for the permission model, per-bot setup, and what bots can do on a connected computer. +See [Computers](../guides/computers.md) for the permission model, per-bot setup, and what bots can do on a connected computer. ## What Desktop manages @@ -44,4 +44,4 @@ See [Computers](/guides/computers.md) for the permission model, per-bot setup, a - the connection to the selected server and its cached sign-in state - the optional Remote Runtime connection for **This computer** -Everything else (bots, sessions, memory, workspaces, channels) lives on the server you connected to. Workspace runtimes are configured server-side; see [Workspace Backends](/self-hosted/workspace-backends). \ No newline at end of file +Everything else (bots, sessions, memory, workspaces, channels) lives on the server you connected to. Workspace runtimes are configured server-side; see [Workspace Backends](./workspace-backends.md). \ No newline at end of file diff --git a/docs/self-hosted/docker.md b/docs/self-hosted/docker.md index 514ea73..9ca582f 100644 --- a/docs/self-hosted/docker.md +++ b/docs/self-hosted/docker.md @@ -2,11 +2,11 @@ Server Deploy is the self-hosted Memoh stack for always-on, multi-user or multi-tenant usage. Use it when Memoh should run on a server, VM, or NAS, or when bots need to keep serving external channels while your desktop is offline. -This page documents the Docker Compose server deployment. For the native local client, see [Desktop Installation](/self-hosted/desktop). +This page documents the Docker Compose server deployment. For the native local client, see [Desktop Installation](./desktop.md). The default Compose stack includes PostgreSQL, a pgvector database for memory embeddings, a one-shot migration job, the main server with an explicit workspace backend and in-process AI agent, the channel worker, and the web UI. PostgreSQL is the only supported database. -The official Compose stack uses the `containerd` workspace backend. The server image starts an embedded containerd and mounts the runtime files needed by bot workspaces. For Docker Engine and Apple backends, see [Workspace backends](/self-hosted/workspace-backends.md). +The official Compose stack uses the `containerd` workspace backend. The server image starts an embedded containerd and mounts the runtime files needed by bot workspaces. For Docker Engine and Apple backends, see [Workspace backends](./workspace-backends.md). ## Service Architecture @@ -18,10 +18,10 @@ The Docker Compose stack consists of multiple services. Some are always started, | **channel** | *(core)* | Channel worker (`memoh-channel`) that owns platform connections and webhooks; talks to the server over internal RPC | | **web** | *(core)* | Web UI (Vue 3) | | **postgres** | *(core)* | PostgreSQL database (system of record) | -| **pgvector** | *(core)* | PostgreSQL with `pgvector` used for optional memory embeddings; see [Built-in Memory](/integrations/providers/memory/builtin.md) | +| **pgvector** | *(core)* | PostgreSQL with `pgvector` used for optional memory embeddings; see [Built-in Memory](../integrations/providers/memory/builtin.md) | | **migrate** | *(core, one-shot)* | Runs `memoh-server migrate up` before the server starts | | **webhook-tunnel** | `webhook-tunnel` | Optional `cloudflared` quick tunnel that exposes the channel worker's webhook listener to the internet | -| **connect-it** | `connectors` | Co-hosted [Connect-It](https://github.com/memohai/connect-it) service backing bot [connectors](/guides/connectors.md) (see below) | +| **connect-it** | `connectors` | Co-hosted [Connect-It](https://github.com/memohai/connect-it) service backing bot [connectors](../guides/connectors.md) (see below) | ## Prerequisites @@ -152,7 +152,7 @@ Add `--profile connectors` for co-hosted Connect-It and `--profile webhook-tunne > **Important**: `docker-compose.yml` mounts `./config.toml` by default. You must create this file before starting — running without it will fail. -To enable [connectors](/guides/connectors.md) in a manual deployment, generate the Connect-It credentials yourself and add the `connectors` profile: +To enable [connectors](../guides/connectors.md) in a manual deployment, generate the Connect-It credentials yourself and add the `connectors` profile: ```bash MEMOH_CONNECT_IT_BASE_URL="http://connect-it:8421" \ @@ -219,7 +219,7 @@ The `config.toml` file controls all server behavior. Here is a summary of the av | `[internal_rpc]` | Server/channel-worker RPC targets and shared secret for the split deployment | | `[webhook_tunnel]` | Webhook tunnel mode (`disabled` or `external`) and `public_base_url` | | `[registry]` | Provider definitions directory | -| `[connect_it]` | Connect-It endpoint for [connectors](/guides/connectors.md) (`base_url`, `api_token`); both empty disables the feature. The Compose environment overrides these via `MEMOH_CONNECT_IT_BASE_URL` / `MEMOH_CONNECT_IT_API_TOKEN`. | +| `[connect_it]` | Connect-It endpoint for [connectors](../guides/connectors.md) (`base_url`, `api_token`); both empty disables the feature. The Compose environment overrides these via `MEMOH_CONNECT_IT_BASE_URL` / `MEMOH_CONNECT_IT_API_TOKEN`. | | `[web]` | Web frontend host and port | | `[agent]` | Tool output truncation limits: `tool_output_max_bytes` (default 65536), `tool_output_max_lines` (default 2000), `system_files_max_bytes` (default 32768). Oversized tool output keeps head and tail instead of being cut off blindly. | | `[session_runtime]` | Session-state backend for multi-instance deployments; see [Multi-Instance Deployments](#multi-instance-deployments) | diff --git a/docs/self-hosted/index.md b/docs/self-hosted/index.md index ec7abe0..6bc2414 100644 --- a/docs/self-hosted/index.md +++ b/docs/self-hosted/index.md @@ -5,20 +5,20 @@ Memoh runs as a server stack; the Web UI and the Desktop app are clients for it. | Use case | Choose | Why | |----------|--------|-----| | Try Memoh with nothing to install | [Memoh Cloud](https://memoh.ai) | Hosted service, same product, no server to run. | -| Shared server, remote access, public/private channels, production uptime, multi-user or multi-tenant usage | [Server Deploy](/self-hosted/docker) | The Docker Compose stack keeps the backend, Web UI, PostgreSQL (with pgvector for memory), and workspace runtime online. | -| A native app on your own computer, optionally shared with bots as a Computer | [Desktop](/self-hosted/desktop) | Native client that connects to Cloud or your server; it does not run a local server. | +| Shared server, remote access, public/private channels, production uptime, multi-user or multi-tenant usage | [Server Deploy](./docker.md) | The Docker Compose stack keeps the backend, Web UI, PostgreSQL (with pgvector for memory), and workspace runtime online. | +| A native app on your own computer, optionally shared with bots as a Computer | [Desktop](./desktop.md) | Native client that connects to Cloud or your server; it does not run a local server. | ## Server Deploy Use Server Deploy when Memoh should be reachable by multiple users, run continuously, or connect to external channels such as Telegram, Discord, Feishu, WeChat, WeChat Official Account, Email, and more. -Start with the [Quick Start](/guides/quick-start) for the fastest route, then read [Server Deploy](/self-hosted/docker) for the full reference. +Start with the [Quick Start](../guides/quick-start.md) for the fastest route, then read [Server Deploy](./docker.md) for the full reference. ## Desktop -Use Desktop when you want Memoh to behave like a native app with a tray icon and shortcuts, or when you want server-side bots to use your computer's files, shell, and browser. Desktop always connects to a server (Cloud or self-hosted); see [Desktop](/self-hosted/desktop). +Use Desktop when you want Memoh to behave like a native app with a tray icon and shortcuts, or when you want server-side bots to use your computer's files, shell, and browser. Desktop always connects to a server (Cloud or self-hosted); see [Desktop](./desktop.md). ## Related -- [Workspace Backends](/self-hosted/workspace-backends) explains Docker, containerd, Apple, and local workspace runtime choices. -- [Computers](/guides/computers) covers sharing your own machines with bots. \ No newline at end of file +- [Workspace Backends](./workspace-backends.md) explains Docker, containerd, Apple, and local workspace runtime choices. +- [Computers](../guides/computers.md) covers sharing your own machines with bots. \ No newline at end of file diff --git a/docs/self-hosted/workspace-backends.md b/docs/self-hosted/workspace-backends.md index 820f6c3..1f2621e 100644 --- a/docs/self-hosted/workspace-backends.md +++ b/docs/self-hosted/workspace-backends.md @@ -90,7 +90,7 @@ Container workspaces can provide a display runtime: Xvnc/RFB for the workspace d Use this path when a site needs a real graphical browser. Headless Playwright remains available as an ordinary workspace command, but Browser Use and Computer Use target the headed workspace desktop. -Local workspaces do not provide the same container desktop isolation. Use [Browser / Computer Use](/guides/browser-computer-use) for the tool-level model. +Local workspaces do not provide the same container desktop isolation. Use [Browser / Computer Use](../guides/browser-computer-use.md) for the tool-level model. ## Networking and overlays diff --git a/docs/zh/about.md b/docs/zh/about.md index fbde7cf..78912b5 100644 --- a/docs/zh/about.md +++ b/docs/zh/about.md @@ -2,7 +2,7 @@ Memoh v0.13 是开源的多智能体平台。它让你在一台机器上运行多个 AI Agent,并为每个 Agent 提供自己的 workspace、浏览器、网络、工具和长期记忆。 -Agent 可以通过 Telegram、Discord、飞书、微信、Web UI、邮件等渠道对话;也可以记住上下文、操作浏览器或桌面、调用 MCP 工具、安装技能和连接器、执行计划任务,并按机器人配置访问权限。 +Agent 可以通过 Telegram、Discord、飞书、微信、Web UI、邮件等渠道对话;也可以记住上下文、操作浏览器或桌面、调用 MCP 工具、安装技能和连接器、执行定时任务,并按机器人配置访问权限。 Memoh 托管版 SaaS 即将开放。如果你更想使用托管服务,而不是自己运维部署,可以加入 [SaaS waitlist](https://memoh.ai/waitlist)。 @@ -24,11 +24,11 @@ Server Deploy 适合长期在线和多人共享。只要 Memoh 需要服务多 ### Web 产品 -Web UI 覆盖了更多日常操作:机器人设置、会话、供应商、渠道、workspace 文件、终端和显示面板、Supermarket、Hooks、计划任务、访问控制和用户偏好。v0.13 也包含英文、简体中文和日文界面支持。 +Web UI 覆盖了更多日常操作:机器人设置、会话、模型服务商、渠道、workspace 文件、终端和显示面板、应用市场、Hooks、定时任务、访问控制和用户偏好。v0.13 也包含英文、简体中文和日文界面支持。 -### Hooks、计划任务与自动化 +### Hooks、定时任务与自动化 -Hooks 可以围绕支持的事件运行小型自动化规则,Schedule 则让周期性工作不依赖正在进行的聊天。来自 Supermarket 的技能与连接器无需写代码即可扩展机器人的能力。 +Hooks 可以围绕支持的事件运行小型自动化规则,Schedule 则让周期性工作不依赖正在进行的聊天。来自应用市场的技能与连接器无需写代码即可扩展机器人的能力。 ### 访问控制 @@ -36,9 +36,9 @@ Hooks 可以围绕支持的事件运行小型自动化规则,Schedule 则让 ## 从哪开始 -- **[机器人](/zh/guides/bot)** - 创建并配置机器人。 -- **[供应商与模型](/zh/integrations/providers/llm)** - 配置模型访问。 -- **[渠道](/zh/integrations/channels/)** - 选择机器人出现的位置。 -- **[Skills](/zh/guides/skills)** 和 **[Supermarket](/zh/guides/supermarket)** - 安装可复用能力。 -- **[计划任务](/zh/guides/schedule)** 和 **[访问控制](/zh/guides/access)** - 运维周期性工作和权限。 -- **[自托管](/zh/self-hosted/)** - 部署并维护自己的 Memoh 实例。 +- **[机器人](./guides/bot.md)** - 创建并配置机器人。 +- **[模型服务商与模型](./integrations/providers/llm.md)** - 配置模型访问。 +- **[渠道](./integrations/channels/index.md)** - 选择机器人出现的位置。 +- **[技能](./guides/skills.md)** 和 **[应用市场](./guides/supermarket.md)** - 安装可复用能力。 +- **[定时任务](./guides/schedule.md)** 和 **[访问控制](./guides/access.md)** - 运维周期性工作和权限。 +- **[自托管](./self-hosted/index.md)** - 部署并维护自己的 Memoh 实例。 diff --git a/docs/zh/guides/access.md b/docs/zh/guides/access.md index c44cb39..f28289b 100644 --- a/docs/zh/guides/access.md +++ b/docs/zh/guides/access.md @@ -87,7 +87,7 @@ Memoh 的访问控制分成两层: ### 群聊作为成员 -除了单个身份,也可以把整个**群聊**加成一行成员。群聊候选来自机器人在各渠道观测到的会话,行上带"群"标记。 +除了单个身份,也可以把整个**群聊**加成一行成员。群聊候选来自 Bot 在各渠道观测到的会话,行上带"群"标记。 - 群行的**聊天**勾选含义是"这个群里的所有人"——白名单模式下放行全群,黑名单模式下屏蔽全群。 - **群没有管理权限**。管理者永远是单个渠道身份。 diff --git a/docs/zh/guides/acp.md b/docs/zh/guides/acp.md index c09ea00..fabf033 100644 --- a/docs/zh/guides/acp.md +++ b/docs/zh/guides/acp.md @@ -66,7 +66,7 @@ Hermes 用 toolkit 里 pin 死的运行时,不自动升级。 ## 附件 -ACP 智能体会话现在支持消息附件: +ACP 智能体会话支持消息附件: - **图片**:智能体声明支持图片输入时原生发送;不支持时若图片有 workspace 路径可引用,自动降级为文件引用。 - **文件**、长文本粘贴、引用/回复消息里带的附件,以 workspace 路径或公开 URL 的形式传给智能体。 @@ -90,7 +90,7 @@ ACP 工作使用 `acp_agent` 会话类型,由 Agents/ACP 工作流创建和管 ## 相关页面 -- [机器人](/zh/guides/bot.md) -- [会话](/zh/guides/sessions.md) -- [文件](/zh/guides/files.md) -- [提供方与模型](/zh/integrations/providers/llm.md) +- [机器人](./bot.md) +- [会话](./sessions.md) +- [文件](./files.md) +- [模型服务商与模型](../integrations/providers/llm.md) diff --git a/docs/zh/guides/bot.md b/docs/zh/guides/bot.md index fb13505..dea7f0d 100644 --- a/docs/zh/guides/bot.md +++ b/docs/zh/guides/bot.md @@ -22,9 +22,9 @@ | Tab | 内容 | |-----|------| | **Overview** | workspace runtime、库、渠道、记忆等健康检查 | -| **General** | 主模型/标题/生图、记忆/搜索/浏览器/TTS、时区、语言、推理、危险区 | +| **General** | 主模型/标题/生图、记忆/搜索/TTS 绑定、时区、语言、推理、危险区 | | **Desktop** | Workspace display runtime、有头浏览器、实时 display session | -| **Computers** | 远程运行时(运行 Memoh runtime 的自有机器),机器人可在其上读写文件、执行命令 | +| **电脑** | 远程运行时(运行 Memoh runtime 的自有机器),机器人可在其上读写文件、执行命令 | | **Workspace** | 容器型 workspace 起停、快照、导入导出 | | **Network** | Workspace 网络与 overlay provider 状态/动作 | | **Memory** | 浏览、搜、建、改、压记忆 | @@ -32,7 +32,7 @@ | **Access** | ACL 与默认通过/拒绝 | | **Tool Approval** | 需要人类确认的工具审批设置 | | **Agents** | 可为聊天 workspace 启用的 ACP 兼容编码智能体,如 Codex、Claude Code | -| **Email** | 邮服绑定、发件箱 | +| **Email** | 邮箱绑定、发件箱 | | **Connectors** | 经 Connect-It 连接的第三方服务(OAuth 或 API Key):状态、启停、重新授权、断开 | | **Hooks** | 保存在 `/data/.memoh/hooks.json` 的机器人自动化规则 | | **MCP** | 连接(Stdio/Remote/OAuth) | @@ -53,11 +53,11 @@ Files、Terminal、Display、Browser 这些 workspace 工具在聊天 workspace 若这些资源还没有,先建好: -- [供应商与模型](/zh/integrations/providers/llm) -- [内置记忆提供方](/zh/integrations/providers/memory/builtin.md)(如用) -- [搜索提供方](/zh/integrations/providers/web-search) -- [TTS 提供方](/zh/integrations/providers/tts/index) -- [Agents / ACP](/zh/guides/acp.md) +- [模型服务商与模型](../integrations/providers/llm.md) +- [内置记忆提供方](../integrations/providers/memory/builtin.md)(如用) +- [搜索提供方](../integrations/providers/web-search.md) +- [TTS 提供方](../integrations/providers/tts/index.md) +- [Agents / ACP](./acp.md) --- @@ -70,7 +70,7 @@ Files、Terminal、Display、Browser 这些 workspace 工具在聊天 workspace | **Image Generation Model** | 可选,需带 `image-output` 的聊天模型 | | **Memory Provider** | 长期记忆后端;内置类型还可自带记忆/向量模型 | | **Search Provider** | 联网搜索用哪家 | -| **TTS Model** | 来自 TTS 流,不是普通 chat 供应商里选 | +| **TTS Model** | 来自 TTS 提供方流程,不在普通 chat 模型服务商里选 | | **Timezone** | 不填则用户时区再落到系统 | | **Language** | 机器人主用语 | | **Reasoning Effort** | 当前 chat 模型有 `reasoning` 时可用;可选值随模型而定(如 `low` / `medium` / `high`) | @@ -78,8 +78,8 @@ Files、Terminal、Display、Browser 这些 workspace 工具在聊天 workspace 注意: - **生图模型** 故意与主聊天模型分开,好单独换「更擅长出图」的。 -- **TTS** 在 [TTS 提供方](/zh/integrations/providers/tts/index.md) 里用所配置语音提供方的 `speech` 模型。 -- `context_window` 会影响状态栏展示和 [会话压缩](/zh/guides/compaction.md) 的体感。 +- **TTS** 在 [TTS 提供方](../integrations/providers/tts/index.md) 里用所配置语音提供方的 `speech` 模型。 +- 所选聊天模型的 `context_window` 会影响会话状态展示和 [会话压缩](./compaction.md)。 --- @@ -94,7 +94,7 @@ Files、Terminal、Display、Browser 这些 workspace 工具在聊天 workspace | **Compaction Ratio** | 压多狠 | | **Compaction Model** | 可选,专门做摘要的模型 | -细节见 [会话上下文压缩](/zh/guides/compaction.md)。 +细节见 [会话上下文压缩](./compaction.md)。 --- @@ -102,7 +102,7 @@ Files、Terminal、Display、Browser 这些 workspace 工具在聊天 workspace 创建时先给一个 **ACL 预设**,之后在 **Access** 里微调。**预设** 给一版默认策略,**Default Effect** 管「没命中规则时」放行还是挡。 -[会话](/zh/guides/sessions.md) 与 Discuss 的默认行为在那一页。若你用 API/自动化,配置里还可能有 `discuss_probe_model_id` 等进阶项,日常创建不必先动。 +[会话](./sessions.md) 与 Discuss 的默认行为在那一页。若你用 API/自动化,配置里还可能有 `discuss_probe_model_id` 等进阶项,日常创建不必先动。 --- @@ -114,7 +114,7 @@ Workspace 文件和终端在聊天 workspace UI 里使用;前提是该机器 - 打开 workspace 内的终端会话 - 在开启 display 后使用浏览器/桌面相关工具 -文件流程见 [文件](/zh/guides/files.md),有头浏览器和桌面操作见 [Browser / Computer Use](/zh/guides/browser-computer-use.md)。 +文件流程见 [文件](./files.md),有头浏览器和桌面操作见 [Browser / Computer Use](./browser-computer-use.md)。 --- diff --git a/docs/zh/guides/browser-computer-use.md b/docs/zh/guides/browser-computer-use.md index 1b8bc7e..a7fd3a9 100644 --- a/docs/zh/guides/browser-computer-use.md +++ b/docs/zh/guides/browser-computer-use.md @@ -39,7 +39,7 @@ workspace desktop 启用后,agent 可以使用浏览器和电脑操作工具 ### 截图不再自动注入对话 -`browser_observe` 与 `computer_observe` 的截图会落盘到 workspace 路径(如 `/data/computer-screenshots/1716200000.jpg`),工具结果只返回这个路径,不再自动塞到对话里。需要查看图像时显式调用文件读取工具读这个路径,可以让观察成本变低,也把“是否值得花 token 读图”交回模型决定。 +`browser_observe` 与 `computer_observe` 的截图会落盘到 workspace 路径(如 `/data/computer-screenshots/1716200000.jpg`),工具结果只返回这个路径,不会自动塞到对话里。需要查看图像时显式调用文件读取工具读这个路径,可以让观察成本变低,也把“是否值得花 token 读图”交回模型决定。 ### 无障碍辅助二进制 @@ -47,9 +47,9 @@ Computer Use 依赖容器内 `/opt/memoh/toolkit/display/bin/a11y-cli` 以及 wo 这些是 workspace runtime 能力,不是用来自动化 Electron 桌面 App 本身的。 -机器人挂了远程[电脑](/zh/guides/computers.md)时,Browser Use / Computer Use 也仍然在**服务器工作区**里跑,不跟随所选使用位置。 +机器人连接了远程[电脑](./computers.md)时,Browser Use / Computer Use 也仍然在**服务器工作区**里跑,不跟随所选使用位置。 ## 相关页面 -- [容器与 Workspace](/zh/guides/container) -- [Workspace backend](/zh/self-hosted/workspace-backends) +- [容器与 Workspace](./container.md) +- [Workspace backend](../self-hosted/workspace-backends.md) diff --git a/docs/zh/guides/compaction.md b/docs/zh/guides/compaction.md index 0594e45..c2b15f0 100644 --- a/docs/zh/guides/compaction.md +++ b/docs/zh/guides/compaction.md @@ -2,7 +2,7 @@ **上下文压缩**只针对**当前这一会话**:把早先轮次压成摘要,让后面模型调用时带的**活跃窗口**小一点。 -这和**改记忆库里存的长记忆**不是一码事。要动存储条目,看 [长期记忆](/zh/guides/memory.md)。 +这和**改记忆库里存的长记忆**不是一码事。要动存储条目,看 [长期记忆](./memory.md)。 --- @@ -14,7 +14,7 @@ - 后台没追上、涨过约 **75%**:下一轮发送前**同步**压。 - 两条路都把原始历史压回窗口约 **40%**。 -唯一的真前提:聊天模型必须在模型设置里声明 `context_window`。没有它,自动策略没有预算基准,**永远不会触发**。见 [提供方与模型](/zh/integrations/providers/llm.md)。 +唯一的真前提:聊天模型必须在模型设置里声明 `context_window`。没有它,自动策略没有预算基准,**永远不会触发**。见 [模型服务商与模型](../integrations/providers/llm.md)。 默认值变更之前建的机器人保留原有设置、按原语义跑(见下面的 legacy 模式)。 @@ -76,7 +76,7 @@ - 空的、被截断的、压完不比原文小的摘要直接拒收,不会存成结果。 - 跨多个 workspace 的会话里,摘要保留"哪段话在哪台机器上发生"的信息。 -普通 chat、**discuss**、pipeline 类对话现在都会压。 +普通 chat、**discuss**、pipeline 类对话都会压。 --- @@ -90,7 +90,7 @@ --- -## 和 `context_window` +## 与 `context_window` 的关系 Memoh 拿当前 chat 模型的 `context_window` 对照本会话,网页状态区、`/status` 都能看到离上限多近。注意 token 是粗估(约 4 字符/token),百分比当参考就好,别当精确值。 @@ -110,6 +110,6 @@ Memoh 拿当前 chat 模型的 `context_window` 对照本会话,网页状态 ## 接下来 -- 会话、Discuss:[会话](/zh/guides/sessions.md) -- 斜杠与 `/compact`:[斜杠命令](/zh/guides/slash-commands.md) -- 长期记忆维护:[长期记忆](/zh/guides/memory.md) +- 会话、Discuss:[会话](./sessions.md) +- 斜杠与 `/compact`:[斜杠命令](./slash-commands.md) +- 长期记忆维护:[长期记忆](./memory.md) diff --git a/docs/zh/guides/computers.md b/docs/zh/guides/computers.md index 9ded1e0..40716a7 100644 --- a/docs/zh/guides/computers.md +++ b/docs/zh/guides/computers.md @@ -16,7 +16,7 @@ Agent 本体不挪窝。模型调用、聊天、会话、记忆全在 Memoh serv ### 命令行方式 -1. 打开 Web UI 设置里的 **Computers** 页。 +1. 打开 Web UI 设置里的 **电脑** 页。 2. 创建一个 runtime key(形如 `mrk_...`;任何登录用户都能建,电脑归创建 key 的用户所有)。 3. 在要接入的电脑上跑页面生成的命令(Node.js 20+): @@ -72,6 +72,6 @@ Memoh Desktop 内置了这个能力:打开**这台电脑**开关、起个名 ## 相关页面 -- [Workspace](/zh/guides/container.md) -- [Browser / Computer Use](/zh/guides/browser-computer-use.md) -- [自托管总览](/zh/self-hosted/index.md) +- [Workspace](./container.md) +- [Browser / Computer Use](./browser-computer-use.md) +- [自托管总览](../self-hosted/index.md) diff --git a/docs/zh/guides/connectors.md b/docs/zh/guides/connectors.md index 205c3e7..45ae03f 100644 --- a/docs/zh/guides/connectors.md +++ b/docs/zh/guides/connectors.md @@ -18,13 +18,13 @@ api_token = "" # 服务端之间的可信 token 两项留空即关闭该功能。线上环境建议用对应的环境变量(`MEMOH_CONNECT_IT_BASE_URL`、`MEMOH_CONNECT_IT_API_TOKEN`)。 -一键 Server Deploy 会在全新安装时自动带起一个同机部署的 Connect-It,见 [Server Deploy](/zh/self-hosted/docker.md#connect-it-连接器)。没配置 Connect-It 时,应用市场不会显示 **Connectors** tab,连接器相关操作会提示服务器未配置连接器。 +一键 Server Deploy 会在全新安装时自动带起一个同机部署的 Connect-It,见 [Server Deploy](../self-hosted/docker.md#connect-it-连接器)。没配置 Connect-It 时,应用市场不会显示 **Connectors** tab,连接器相关操作会提示服务器未配置连接器。 --- ## 连接一个服务 -1. 在 Web UI 中打开 **Supermarket**。 +1. 在 Web UI 中打开 **应用市场**。 2. 停在 **Connectors** tab——配置了连接器时它排在第一个,也是默认落地的 tab。 3. 选一个连接器,点 **Connect**。 4. 选择目标 Bot。 @@ -67,6 +67,6 @@ OAuth 授权中途放弃的话,这条连接会一直停在 **Waiting for autho ## 相关页面 -- [应用市场](/zh/guides/supermarket.md) —— 发现和连接服务的入口。 -- [MCP](/zh/guides/mcp.md) —— 直接管理 MCP 连接。 -- [Server Deploy](/zh/self-hosted/docker.md#connect-it-连接器) —— 同机部署 Connect-It、凭据管理和 OAuth 回调地址。 +- [应用市场](./supermarket.md) —— 发现和连接服务的入口。 +- [MCP](./mcp.md) —— 直接管理 MCP 连接。 +- [Server Deploy](../self-hosted/docker.md#connect-it-连接器) —— 同机部署 Connect-It、凭据管理和 OAuth 回调地址。 diff --git a/docs/zh/guides/container.md b/docs/zh/guides/container.md index b85e29f..c7bac18 100644 --- a/docs/zh/guides/container.md +++ b/docs/zh/guides/container.md @@ -1,4 +1,4 @@ -# Workspace 与容器 +# 工作区(Workspace)与容器 每个机器人都在一个 workspace 里工作。Server Deploy 里通常是隔离容器、Pod 或类似 VM 的 runtime;在受信任的 Desktop/local 场景里,也可以是宿主机上的本地目录。workspace 提供文件系统、命令执行环境、MCP runtime,以及可选的图形桌面。 @@ -14,9 +14,9 @@ workspace toolkit 自带 **Node.js** 和 **Python** 两套运行时(`pip`、`uv` 都在 PATH 上),机器人跑 Python 脚本、装包不用先折腾解释器。 -机器人还可以在 server workspace 之外、你接入的机器上干活——见 [电脑(远程 Runtime)](/zh/guides/computers.md)。 +机器人还可以在 server workspace 之外、你接入的机器上干活——见 [电脑(远程 Runtime)](./computers.md)。 -底层容器 runtime 由 `config.toml` 的 `[container].backend` 决定,trusted local workspace 另行控制。官方 Docker Compose Server Deploy 使用 `containerd`;Docker Engine、Apple 和 local workspace 的差异见 [Workspace backend](/zh/self-hosted/workspace-backends)。 +底层容器 runtime 由 `config.toml` 的 `[container].backend` 决定,trusted local workspace 另行控制。官方 Docker Compose Server Deploy 使用 `containerd`;Docker Engine、Apple 和 local workspace 的差异见 [Workspace backend](../self-hosted/workspace-backends.md)。 ## Workspace 相关 tab @@ -48,7 +48,7 @@ workspace toolkit 自带 **Node.js** 和 **Python** 两套运行时(`pip`、`u **Desktop** tab 用来准备和检查图形 workspace runtime。它会检查 desktop toolkit、Xvnc/VNC、浏览器和当前 display session。 -启用后,workspace 可以在容器里跑有头 Chrome/Chromium。网页端 Display pane 会连接到同一个桌面会话,你和 agent 看到、操作的是同一个可见浏览器。工具层面的区别见 [Browser / Computer Use](/zh/guides/browser-computer-use)。 +启用后,workspace 可以在容器里跑有头 Chrome/Chromium。网页端 Display pane 会连接到同一个桌面会话,你和 agent 看到、操作的是同一个可见浏览器。工具层面的区别见 [Browser / Computer Use](./browser-computer-use.md)。 ## 运行时信息 @@ -96,7 +96,7 @@ workspace toolkit 自带 **Node.js** 和 **Python** 两套运行时(`pip`、`u ### 注意 - CDI 在**创建**时生效,改配置后常要**重建**容器;只停再起**不会**换已挂设备。 -- 镜像里仍要装对的用户态库,才能真跑算子。 +- 镜像里仍要装对的用户态库和工具,才能真正跑 CUDA/ROCm 软件。 - 建好后 **Container** tab 会显示当前挂上的设备,便于核对。 ## 快照 @@ -109,7 +109,7 @@ workspace toolkit 自带 **Node.js** 和 **Python** 两套运行时(`pip`、`u - **Export Data**:把 workspace 文件系统数据打成包下载。 - **Import Data**:从本地上传归档并解进 workspace 文件系统。 -- **Restore**:在数据目录侧做“清到干净再灌”,适合盘坏了或想从零来而又不删 runtime 实例时。 +- **Restore**:把数据目录重置到干净状态,适合文件系统损坏或想从零开始而又不重建 runtime 实例时。 ## 版本 diff --git a/docs/zh/guides/email.md b/docs/zh/guides/email.md index ad2fd4a..387e802 100644 --- a/docs/zh/guides/email.md +++ b/docs/zh/guides/email.md @@ -22,7 +22,7 @@ Gmail 类提供方的 OAuth 应用凭据(client ID / client secret)不再在 ### 新建 1. **Add Email Provider** -2. 类型如 **Mailgun**(量大)、**泛用 SMTP**(传统邮局) +2. 类型如 **Mailgun**(量大)、**泛用 SMTP**(传统邮件服务器) 3. 按表单填 `domain`/`api_key` 或 `host`/`port` 等 4. 创建 @@ -52,4 +52,4 @@ Gmail 类提供方的 OAuth 应用凭据(client ID / client secret)不再在 ## 和机器人 - 有权限时可用邮件发报告、回邮、或按新邮件做事。 -- 和聊天一样,是另一条通道,但仍是结构化、可审的。 +- 和聊天一样,是另一条渠道,但仍是结构化、可审的。 diff --git a/docs/zh/guides/files.md b/docs/zh/guides/files.md index 50da363..5f96ae0 100644 --- a/docs/zh/guides/files.md +++ b/docs/zh/guides/files.md @@ -1,6 +1,6 @@ # 文件 -每个机器人都有自己的 **workspace 文件系统**。Server Deploy 里通常在容器型 workspace 内;trusted Desktop/local 模式下也可能是本地 workspace 目录。在 **Files** tab 里可以直接管理。 +每个机器人都有自己的 **workspace 文件系统**。服务端部署里通常在容器型 workspace 内;受信任的桌面/本地模式下也可能是本地 workspace 目录。在 **Files** tab 里可以直接管理。 --- diff --git a/docs/zh/guides/get-started.md b/docs/zh/guides/get-started.md new file mode 100644 index 0000000..f7a4f33 --- /dev/null +++ b/docs/zh/guides/get-started.md @@ -0,0 +1,127 @@ +# 入门教程 + +Memoh 给你的机器人是真能干活的:每个机器人都有自己的工作区——完整的文件系统、可执行的终端、以及可选的带浏览器的可视化桌面——外加长期记忆和你本来就在用的聊天渠道。 + +本教程带你从空账号走到一个能完成真实工作的机器人,大约需要十五分钟。 + +::: tip 想找安装方法? +本页假定你已经能打开一个 Memoh 实例。如果你需要自己部署,请先看 [快速开始](./quick-start.md)。 +::: + +## 开始之前 + +你需要: + +- 一个可访问的 Memoh 实例,以及能创建机器人的账号。 +- 至少一个模型提供方的 API Key(OpenAI、Anthropic、Gemini、DeepSeek、智谱、OpenRouter、Ollama 等)。如果管理员已经配好了,跳过即可。 + +## 1. 登录 + +打开 Memoh Web UI 并登录。 + +如果这是一个全新实例,请立刻在 **Settings → Account** 修改初始密码。 + +界面语言、主题等选项随时可以在 [偏好设置](./preferences.md) 里调整,不影响下面的步骤。 + +## 2. 添加模型提供方 + +没有模型,机器人就无法思考。如果管理员已经配置过,跳过这一步。 + +1. 在侧边栏打开 **Providers**,点击 **Add Provider**。 +2. 选择模板,填入 API Key,保存。 +3. 打开该提供方并**同步**模型列表,或手动添加至少一个对话模型。 + +各家的客户端类型、Base URL 和注意事项见 [LLM 提供方](../integrations/providers/llm.md)。 + +## 3. 创建第一个机器人 + +进入 **Bots → New Bot**,填写名称和显示名,然后在 **General** 标签页选择对话模型。 + +接下来写它的指令。这一步最关键,也最容易出错——通常是写得太笼统。把一件事说清楚: + +> **名称:** Digest +> +> **角色:** 每周阅读摘要 +> +> **指令:** 收集我这一周发给你的文章。每周五整理成一份摘要,按主题分组:每篇一句话概括并附原始链接,最后加一节"值得再读"。原始链接保持不变。任何内容都不要公开发布。 + +职责单一的机器人能积累的有效上下文,远多于什么都干的机器人。当工作确实分成不同角色时,请新建一个机器人,而不是把这个越堆越重——每个机器人都有独立的工作区、记忆和配置。逐个标签页的说明见 [机器人](./bot.md)。 + +点击 **Chat** 打个招呼。收到回复就说明模型链路是通的。 + +## 4. 交给它第一个任务 + +一个好的首次请求会回答五个问题: + +| 要素 | 它回答的问题 | +|------|------------| +| **结果** | 做完之后应该存在什么? | +| **来源** | 涉及哪些文件、网站或对话? | +| **约束** | 什么不能碰,什么需要你批准? | +| **形式** | 结果以什么形式交付? | +| **确认点** | 什么时候该停下来跟你确认? | + +想在几分钟内看到结果、又不需要任何外部登录,可以上传一份文档试试: + +```text +把这份文档总结成五个要点。另起一节,列出其中所有的日期、决定和待解决问题, +并标注每条来自哪一页或哪一节。不要修改原文件。 +``` + +机器人会在自己的工作区里读取文件,并把结果写回对话。它产出的一切都留在工作区,你可以在 [文件](./files.md) 里浏览和编辑。 + +## 5. 让它用上工作区和浏览器 + +工作区是机器人不再只是聊天机器人的地方。它有 Linux 文件系统、终端和预装工具链(Python、Node.js、uv、npm),能真正把活干完: + +```text +把我刚上传的 CSV 里 email 列为空的行全部删掉。 +给我清洗后的文件,并告诉我删了多少行。 +``` + +当任务需要真实浏览器时——比如无头模式下会出错的站点,或需要登录才能访问的页面——在机器人的 **Desktop** 标签页启用可视化桌面。启动后,机器人会驱动一个有头 Chrome,你可以在 display 面板里看着它操作。 + +遇到登录墙时,你可以自己接管屏幕:输入密码、通行密钥或一次性验证码,然后把控制权交还给它。浏览器会话保留在该工作区中,后续任务依然是登录状态。 + +::: warning 按需授权 +工作区权限是分级的:仅聊天、读文件、写文件、执行命令、管理容器。任务需要哪一级就给哪一级,不要多给。参见 [访问控制](./access.md)。 +::: + +详见 [工作区](./container.md) 与 [浏览器 / 电脑操作](./browser-computer-use.md)。 + +## 6. 接入聊天渠道 + +机器人在你本来就聊天的地方最有用。 + +1. 打开机器人的 **Platforms** 标签页,点击 **Add**。 +2. 选择平台——Telegram、Slack、Discord、飞书、钉钉、企业微信、QQ、LINE、Matrix 或 Misskey——并填入该平台的凭据。 +3. 从该平台给它发消息。第一条消息会创建会话;发送 `/help` 可以看到可用的 [斜杠命令](./slash-commands.md)。 + +从此你可以在手机上派活,然后在同一个对话里收结果。各平台的具体配置见 [渠道](../integrations/channels/index.md)。 + +## 7. 复盘,然后固化下来 + +有问题就直接说。把纠正写成长期规则,而不是一次性修补: + +```text +以后所有的摘要都用这个格式:按主题分组,每篇一行,链接放在行内, +最后加一节"值得再读"。 +``` + +当一套流程稳定下来后,就别再重复输入了: + +- 存成 [技能](./skills.md),以后一句话唤起整套流程。 +- 变成 [定时任务](./schedule.md),按 cron 自动运行,完全不需要聊天。 +- 用 [长期记忆](./memory.md) 把你的偏好和项目上下文带进之后的每一次会话。 + +## 下一步 + +| 目标 | 阅读 | +|------|------| +| 逐个标签页配置机器人 | [机器人](./bot.md) | +| 理解聊天、讨论与消息路由 | [会话](./sessions.md) | +| 接入外部工具和数据 | [MCP](./mcp.md)、[连接器](./connectors.md) | +| 安装现成的能力 | [应用市场](./supermarket.md) | +| 把自己的机器接为工作地点 | [电脑](./computers.md) | +| 在生命周期节点挂自己的逻辑 | [钩子](./hooks.md) | +| 控制谁能跟机器人说话 | [访问控制](./access.md) | \ No newline at end of file diff --git a/docs/zh/guides/hooks.md b/docs/zh/guides/hooks.md index f31c7d7..2e776cd 100644 --- a/docs/zh/guides/hooks.md +++ b/docs/zh/guides/hooks.md @@ -198,7 +198,7 @@ action 可以返回这些 decision: ## 事件目录 -Hooks tab 会从 `/bots/{bot_id}/hooks/events` 加载事件目录。标记为 runtime-supported 的事件已经接入 v0.13.0 执行路径。catalog-only 事件可以通过配置解析和测试接口,但 v0.13.0 没有实时运行路径会自动发出这些事件。 +Hooks tab 会从 `/bots/{bot_id}/hooks/events` 加载事件目录。标记为 runtime-supported 的事件已经接入 v0.13.0 执行路径。catalog-only 事件可以通过配置解析和测试接口,但 v0.13.0 没有实际的运行时路径会发出这些事件。 | Event | 区域 | 已接入运行时 | 说明 | |-------|------|--------------|------| @@ -257,7 +257,7 @@ Hooks tab 会从 `/bots/{bot_id}/hooks/events` 加载事件目录。标记为 ru Hooks 很强大。请把它们当成会在机器人 workspace 里运行的代码来对待。 - 启用前审查每个 command action。 -- 小心使用 `PreToolUse`、`BeforeWorkspaceCommand` 和 `BeforeFileWrite`;它们会阻断机器人的正常工作。 +- 小心使用 `PreToolUse`、`BeforeWorkspaceCommand` 和 `BeforeFileWrite`;它们可能阻断机器人的正常工作。 - 保持较短 timeout,并明确设置 `on_error`。 - 不要把长期有效的 secrets 直接写进 `hooks.json`。 - 对高风险 hooks 使用尽量窄的 `matcher`。 @@ -267,5 +267,5 @@ Hooks 很强大。请把它们当成会在机器人 workspace 里运行的代码 ## 相关页面 -- [机器人](/zh/guides/bot.md) -- [技能](/zh/guides/skills.md) +- [机器人](./bot.md) +- [技能](./skills.md) diff --git a/docs/zh/guides/index.md b/docs/zh/guides/index.md index 47d8f11..cf5db2f 100644 --- a/docs/zh/guides/index.md +++ b/docs/zh/guides/index.md @@ -1,32 +1,39 @@ -# 教程 +# 参考文档 -这些教程从产品使用流程出发,默认你已经能访问 Memoh,需要创建机器人、管理会话、连接工具,并使用日常功能。 +欢迎查阅 Memoh 参考文档。部署、配置和运维 Memoh 所需的一切都在这里,按三大板块组织。 -## 开始使用 Memoh +## 新手入门 -- **[快速开始](/zh/guides/quick-start)**:部署服务端、添加模型、创建第一个机器人并接入渠道。 -- **[用户偏好](/zh/guides/preferences)**:配置界面语言、主题、字体、图表和快捷键。 -- **[机器人](/zh/guides/bot)**:创建机器人并配置核心标签页。 -- **[会话](/zh/guides/sessions)**:理解 chat、discuss、路由和状态区。 -- **[文件](/zh/guides/files)**:浏览和编辑机器人 workspace 文件。 -- **[长期记忆](/zh/guides/memory)**:在配置好记忆提供方后管理长期记忆条目。 +刚接触 Memoh?从这里开始。学习如何部署、添加模型、创建第一个机器人、接入渠道,并处理日常基础操作。 -## 扩展机器人能力 +- **[入门教程](./get-started.md)**:手把手教程——登录、创建机器人、交给它真实任务、接入渠道。 +- **[快速开始](./quick-start.md)**:十分钟内部署服务端、添加模型、创建第一个机器人并接入渠道。 +- **[用户偏好](./preferences.md)**:配置界面语言、主题、字体、图表和快捷键。 +- **[机器人](./bot.md)**:创建机器人并配置核心标签页。 +- **[会话](./sessions.md)**:理解 chat、discuss、路由和状态区。 +- **[文件](./files.md)**:浏览和编辑机器人 workspace 文件。 +- **[斜杠命令](./slash-commands.md)**:用命令快捷完成日常控制。 +- **[部署](../self-hosted/index.md)**:选择托管方式并部署自己的实例。 +- **[渠道](../integrations/channels/index.md)**:把 Memoh 接入 Slack、Telegram、飞书、Discord 等平台。 -- **[技能](/zh/guides/skills)** 和 **[应用市场](/zh/guides/supermarket)**:添加可复用提示模块和模板。 -- **[Hooks](/zh/guides/hooks)** 和 **[MCP](/zh/guides/mcp)**:连接工具、自动化规则和外部数据源。 -- **[Browser / Computer Use](/zh/guides/browser-computer-use)**:使用有头浏览器和可见桌面会话。 -- **[斜杠命令](/zh/guides/slash-commands)**:用命令快捷完成日常控制。 +## 进阶教程 -## 权限与运行 +基础就绪后深入使用。这些页面涵盖高级能力、自动化与外部提供方。 -- **[访问控制](/zh/guides/access)**:配置 ACL 预设、规则顺序和来源限定。 -- **[Workspace](/zh/guides/container)**:从产品界面理解 workspace 行为。 -- **[上下文压缩](/zh/guides/compaction)**:缩小当前会话上下文占用。 -- **[计划任务](/zh/guides/schedule)**:按 cron 计划运行周期性工作,无需活跃聊天。 -- **[邮件](/zh/guides/email)**:配置邮件相关工作流。 +- **[Agents / ACP](./acp.md)**:构建多智能体工作流,并接入 Agent Client Protocol。 +- **[访问控制](./access.md)**:配置 ACL 预设、规则顺序和来源限定。 +- **[Workspace](./container.md)**:从产品界面理解 workspace 行为。 +- **[电脑(远程 Runtime)](./computers.md)**:把机器注册为远程运行时。 +- **[Browser / Computer Use](./browser-computer-use.md)**:使用有头浏览器和可见桌面会话。 +- **[技能](./skills.md)** 和 **[应用市场](./supermarket.md)**:添加可复用提示模块和模板。 +- **[连接器](./connectors.md)**:接入 Connect-It 等托管集成。 +- **[Hooks](./hooks.md)** 和 **[MCP](./mcp.md)**:连接工具、自动化规则和外部数据源。 +- **[长期记忆](./memory.md)**:配置好记忆提供方后管理长期记忆。 +- **[上下文压缩](./compaction.md)**:缩小当前会话上下文占用。 +- **[定时任务](./schedule.md)**:按 cron 计划运行周期性工作。 +- **[邮件](./email.md)**:配置邮件相关工作流。 +- **[提供方](../integrations/providers/index.md)**:模型、搜索、视频、记忆与 TTS 提供方。 -## 其他文档区域 +## 使用场景 -- **[集成](/zh/integrations/)**:连接渠道和提供方。 -- **[自托管](/zh/self-hosted/)**:部署和运维自己的 Memoh 实例。 +- **[使用场景](./use-cases.md)**:组合多种功能解决实际问题的即用型示例。 \ No newline at end of file diff --git a/docs/zh/guides/mcp.md b/docs/zh/guides/mcp.md index 297d65a..e26a29d 100644 --- a/docs/zh/guides/mcp.md +++ b/docs/zh/guides/mcp.md @@ -4,7 +4,7 @@ Memoh 支持 **Model Context Protocol (MCP)**,让机器人接外部工具与 ## 在做什么 -MCP 把「外部数据、外部工具」用相对统一的方式接进来。你在机器人 **MCP** tab 里手配,或从 [应用市场](/zh/guides/supermarket.md) 装模板再进编辑器改。 +MCP 把「外部数据、外部工具」用相对统一的方式接进来。你在机器人 **MCP** tab 里手配,或从 [应用市场](./supermarket.md) 装模板再进编辑器改。 --- @@ -35,7 +35,7 @@ MCP 把「外部数据、外部工具」用相对统一的方式接进来。你 ## OAuth -有的 MCP 服要走 OAuth。Memoh 会: +有的 MCP 服要走 OAuth。Memoh 支持完整的 MCP OAuth 流程: 1. 在需要认证的连接上点 **OAuth**。 2. 自动 **discover** 服务方 OAuth 配置。 diff --git a/docs/zh/guides/memory.md b/docs/zh/guides/memory.md index 1f03311..77bb70c 100644 --- a/docs/zh/guides/memory.md +++ b/docs/zh/guides/memory.md @@ -4,7 +4,7 @@ Memoh 的结构化长期记忆让机器人在**多路会话**里也能用上以 ## 先决条件 -1. 在 [记忆提供方](/zh/integrations/providers/memory/index.md) 里建一个(内置、Mem0、OpenViking 等)。 +1. 在 [记忆提供方](../integrations/providers/memory/index.md) 里建一个(内置、Mem0、OpenViking 等)。 2. 打开机器人 **General**。 3. **Memory Provider** 里选中。 4. 保存。 @@ -17,7 +17,7 @@ Memoh 的结构化长期记忆让机器人在**多路会话**里也能用上以 记忆条目的存、取、搜都由当前提供方实现;按提供方类型,可能是内置记忆图、pgvector 向量、或外接 API。用户发消息时,Memoh 会尝试取出相关记忆塞进当次上下文。 -本页说 **长期记忆**;**会话写太长** 要压短,是另一件事,见 [会话上下文压缩](/zh/guides/compaction.md)。 +本页说 **长期记忆**;**会话写太长** 要压短,是另一件事,见 [会话上下文压缩](./compaction.md)。 --- @@ -40,7 +40,7 @@ Memoh 的结构化长期记忆让机器人在**多路会话**里也能用上以 积累多了可以在 **Memory** tab 对**存储侧**做 **Compact**:合并重复、去陈旧、压噪声。有 **Ratio**、**Decay Days** 等参数。 -这和 [会话上下文压缩](/zh/guides/compaction.md) 不同:后者是**单路会话**里把 prompt 压短,不改库里长期记忆条目的存法与合并结果。 +这和 [会话上下文压缩](./compaction.md) 不同:后者是**单路会话**里把 prompt 压短,不改库里长期记忆条目的存法与合并结果。 --- @@ -70,12 +70,12 @@ Memoh 的结构化长期记忆让机器人在**多路会话**里也能用上以 | **上下文压缩** | 当前这一路会话 | 状态区或 `/compact` | 用摘要把**本会话**历史变短,给后面轮次用 | 要减「跨会话噪声」、整理记忆库 → 用 **记忆压缩**。 -要减「这一路聊太长了」→ 用 [会话上下文压缩](/zh/guides/compaction.md)。 +要减「这一路聊太长了」→ 用 [会话上下文压缩](./compaction.md)。 --- ## 和机器人的关系 - 聊的时候会按配置去搜记忆。 -- 具体用哪种后端、embedding 等,在**提供方**上配,见 [记忆提供方](/zh/integrations/providers/memory/index.md)。 +- 具体用哪种后端、embedding 等,在**提供方**上配,见 [记忆提供方](../integrations/providers/memory/index.md)。 - 长期记忆是机器人「个性与事实」里很大一块来源。 diff --git a/docs/zh/guides/quick-start.md b/docs/zh/guides/quick-start.md index dc84d5b..1a4c081 100644 --- a/docs/zh/guides/quick-start.md +++ b/docs/zh/guides/quick-start.md @@ -1,15 +1,15 @@ # 快速开始 -大约十分钟即可跑通 Memoh:部署服务端、登录、添加模型供应商、创建第一个机器人,并把它接到一个聊天平台。 +大约十分钟即可跑通 Memoh:部署服务端、登录、添加模型服务商、创建第一个机器人,并把它接到一个聊天平台。 ::: tip 不想自托管? -[Memoh Cloud](https://memoh.ai) 提供与开源版一致的托管服务。登录后可直接跳到 [第 3 步](#第-3-步添加模型供应商)。 +[Memoh Cloud](https://memoh.ai) 提供与开源版一致的托管服务。登录后可直接跳到 [第 3 步](#第-3-步添加模型服务商)。 ::: ## 前置条件 - 一台安装了 **Docker** 与 **Docker Compose** 的 Linux 服务器或工作站。 -- 至少一个 LLM 供应商的 API Key(OpenAI、Anthropic、DeepSeek、智谱……),或本地 Ollama。 +- 至少一个模型服务商的 API Key(OpenAI、Anthropic、DeepSeek、智谱……),或本地 Ollama。 - 浏览器可以访问服务器的 **8080**(API)与 **8082**(Web UI)端口。 ## 第 1 步:部署服务端 @@ -48,19 +48,19 @@ docker compose up -d 🔑 Admin login: admin / <你的密码> ``` -生产环境加固、反向代理与升级方式见 [服务端部署](/zh/self-hosted/docker)。 +生产环境加固、反向代理与升级方式见 [服务端部署](../self-hosted/docker.md)。 ## 第 2 步:登录 打开 `http://<你的服务器>:8082`,使用安装时设置的管理员账号登录(`conf/app.docker.toml` 中的默认值为 `admin` / `admin123`)。登录后请立即在 **设置 → 账户** 中修改密码。 -## 第 3 步:添加模型供应商 +## 第 3 步:添加模型服务商 -1. 在侧边栏进入 **供应商**,点击 **添加供应商**。 +1. 在侧边栏进入 **模型服务商**,点击 **添加模型服务商**。 2. 选择模板(OpenAI、Anthropic、Gemini、DeepSeek、智谱、OpenRouter、Ollama……)并填入 API Key。 -3. 进入该供应商,**同步** 或手动添加至少一个对话模型。 +3. 进入该模型服务商,**同步** 或手动添加至少一个对话模型。 -更多细节与客户端类型见 [LLM 供应商](/zh/integrations/providers/llm)。 +更多细节与客户端类型见 [模型服务商](../integrations/providers/llm.md)。 ## 第 4 步:创建第一个机器人 @@ -68,7 +68,7 @@ docker compose up -d 2. 在机器人的 **通用** 标签页中选择刚添加的对话模型。 3. 点击机器人的 **聊天** 按钮打个招呼。收到回复即说明链路已打通。 -每个机器人都有独立的工作区、记忆与设置,各标签页说明见 [机器人](/zh/guides/bot)。 +每个机器人都有独立的工作区、记忆与设置,各标签页说明见 [机器人](./bot.md)。 ## 第 5 步:接入聊天平台 @@ -76,16 +76,16 @@ docker compose up -d 2. 选择平台(Telegram、Discord、Slack、飞书、钉钉、企业微信、QQ、LINE、Matrix、Misskey……)并填写平台凭据。 3. 在该平台上给机器人发消息。第一条消息会创建会话;输入 `/help` 查看可用的斜杠命令。 -各平台的详细配置见 [渠道](/zh/integrations/channels/)。 +各平台的详细配置见 [渠道](../integrations/channels/index.md)。 ## 下一步 | 目标 | 阅读 | |------|------| -| 让机器人跨会话记住用户 | [记忆](/zh/guides/memory) | -| 运行定时或周期任务 | [定时任务](/zh/guides/schedule) | -| 赋予机器人文件、Shell 与浏览器能力 | [Workspace](/zh/guides/container)、[Computers](/zh/guides/computers) | -| 通过 MCP 服务器添加工具 | [MCP](/zh/guides/mcp) | -| 教会机器人可复用的流程 | [Skills](/zh/guides/skills)、[Supermarket](/zh/guides/supermarket) | -| 控制谁可以和机器人对话 | [访问控制](/zh/guides/access) | -| 在 Mac 上用桌面版运行 | [Desktop](/zh/self-hosted/desktop) | \ No newline at end of file +| 让机器人跨会话记住用户 | [记忆](./memory.md) | +| 运行定时或周期任务 | [定时任务](./schedule.md) | +| 赋予机器人文件、Shell 与浏览器能力 | [Workspace](./container.md)、[电脑](./computers.md) | +| 通过 MCP 服务器添加工具 | [MCP](./mcp.md) | +| 教会机器人可复用的流程 | [Skills](./skills.md)、[应用市场](./supermarket.md) | +| 控制谁可以和机器人对话 | [访问控制](./access.md) | +| 在 Mac 上用桌面版运行 | [Desktop](../self-hosted/desktop.md) | \ No newline at end of file diff --git a/docs/zh/guides/schedule.md b/docs/zh/guides/schedule.md index 8898f4f..b1a61fd 100644 --- a/docs/zh/guides/schedule.md +++ b/docs/zh/guides/schedule.md @@ -1,4 +1,4 @@ -# 计划任务 +# 定时任务 用 **cron 表达式** 在固定时间让机器人干一件事:发报告、查外网、维护、或任何能交给智能体+工具完成的活。 @@ -24,7 +24,7 @@ ## Cron(五段) -在服务器时区下算;默认 Memoh 常用 **UTC**,可用顶层 `timezone` 改。五段为:分、时、日、月、周。 +在服务器时区下算;Memoh 默认使用 **UTC**,可用顶层 `timezone` 改。五段为:分、时、日、月、周。 ``` ┌ 分 0–59 diff --git a/docs/zh/guides/sessions.md b/docs/zh/guides/sessions.md index 27e4f68..ab45237 100644 --- a/docs/zh/guides/sessions.md +++ b/docs/zh/guides/sessions.md @@ -14,12 +14,12 @@ ## 会话类型 -Memoh 用六类会话区分不同活动: +Memoh 用五类会话区分不同活动: | 类型 | 说明 | |------|------| | **Chat** | 最常见的用户发起对话,默认就它。 | -| **Discuss** | 偏「旁观」:机器人默认可以不吱声,把模型输出当内心戏,只有用发送类动作时才算对频道真说话。 | +| **Discuss** | 偏「旁观」:机器人默认可以不吱声,把模型输出当内心戏,只有用发送类动作时才算对渠道真说话。 | | **Schedule** | cron 触发。 | | **Subagent** | 子智能体被委派时。 | | **ACP Agent** | 从聊天 workspace 使用已启用 ACP 兼容编码智能体时生成。 | @@ -38,7 +38,7 @@ Memoh 用六类会话区分不同活动: - 常出现在群里:机器人**看着**大家聊 - 直接文本多算内部独白 -- 真发到频道要显式 `send` 之类动作 +- 真发到渠道要显式 `send` 之类动作 - **保持沉默是正常选项** 有 Discuss,机器人才更像「要不要接话我自己决定」的群成员,而不是每句都回的客服。 @@ -55,7 +55,7 @@ Memoh 用六类会话区分不同活动: ACP Agent 会话不通过 `/new` 创建。要先在机器人详情的 **Agents** tab 启用 ACP 兼容智能体,再从聊天 workspace 启动。 -**网页本地频道** 默认 `chat`;**私聊** 多 `chat`;**外接群聊** 多 `discuss`。 +**网页本地渠道** 默认 `chat`;**私聊** 多 `chat`;**外接群聊** 多 `discuss`。 **内置网页本地** 不支持 `/new discuss`,要 discuss 请用 Telegram、Discord、Misskey 等真实渠道。 @@ -83,7 +83,7 @@ ACP Agent 会话不通过 `/new` 创建。要先在机器人详情的 **Agents** ## 状态区 -状态区和 `/status` 是同一份信息:本会话消息数、**上下文占用**(相对 `context_window`)、**缓存命中**、读写量、**本路用到的技能** 等。这里有 **立即压缩**,触发的是 [会话上下文压缩](/zh/guides/compaction.md),不是改记忆条目的那种。 +状态区和 `/status` 是同一份信息:本会话消息数、**上下文占用**(相对 `context_window`)、**缓存命中**、读写量、**本路用到的技能** 等。这里有 **立即压缩**,触发的是 [会话上下文压缩](./compaction.md),不是改记忆条目的那种。 --- @@ -93,4 +93,4 @@ ACP Agent 会话不通过 `/new` 创建。要先在机器人详情的 **Agents** - **Schedule** 到点也会生成会话,可看 cron 命令跑的结果。 - **Subagent** 各自会话,跟委派任务对齐。子智能体几乎能用主机器人的全套工具——workspace、浏览器、记忆、MCP 都在——但不能直接给用户发消息、不能向用户提问、不能再套子智能体。委派时机器人可以给每个子智能体单独挑聊天模型,也可以选择把当前会话上下文 fork 给它。会话信息面板能看到当前活跃的子智能体。 - **ACP Agent** 记录从聊天 workspace 启动的编码智能体工作。 -- **长期记忆**在机器人整级共享,从哪一路抽出来,别路也能检索到(在你配置允的前提下)。 +- **长期记忆**在机器人整级共享,从哪一路抽出来,别路也能检索到(在你配置允许的前提下)。 diff --git a/docs/zh/guides/skills.md b/docs/zh/guides/skills.md index 5d1a646..d55dc1f 100644 --- a/docs/zh/guides/skills.md +++ b/docs/zh/guides/skills.md @@ -1,6 +1,6 @@ # 技能 -**技能**是可复用的提示模块,用来改机器人的语气、行为方式、工具使用习惯。在机器人的 **Skills** tab 里管;可手写,也可从 [应用市场](/zh/guides/supermarket.md) 装。 +**技能**是可复用的提示模块,用来改机器人的语气、行为方式、工具使用习惯。在机器人的 **Skills** tab 里管;可手写,也可从 [应用市场](./supermarket.md) 装。 --- @@ -127,4 +127,4 @@ Memoh 随 workspace 模板带了几个内置技能(如 `skill-creator`、`hook 1. 先少而精,名字和描述写清楚。 2. 不确定删不删时先 **Disable**。 3. 要长期留用的发现项用 **Adopt**。 -4. 能复用就从 [应用市场](/zh/guides/supermarket.md) 装,少复制粘贴多份。 +4. 能复用就从 [应用市场](./supermarket.md) 装,少复制粘贴多份。 diff --git a/docs/zh/guides/slash-commands.md b/docs/zh/guides/slash-commands.md index 02d7d93..ab14a9d 100644 --- a/docs/zh/guides/slash-commands.md +++ b/docs/zh/guides/slash-commands.md @@ -36,7 +36,7 @@ Memoh 支持 **斜杠命令**,在进 LLM 之前截获。用来快速看状态 ## 技能激活与快捷操作 -固定命令之外,斜杠还能按需激活机器人的[技能](/zh/guides/skills.md): +固定命令之外,斜杠还能按需激活机器人的[技能](./skills.md): ```text /<技能名> [可选的提示词] @@ -108,7 +108,7 @@ Memoh 支持 **斜杠命令**,在进 LLM 之前截获。用来快速看状态 | 组 | 说明 | 默认动作 | |----|------|----------| -| `/schedule` | 计划任务 | 无 | +| `/schedule` | 定时任务 | 无 | | `/mcp` | 看 MCP 连接 | 无 | | `/settings` | 机器人设置 | `get` | | `/model` | 聊天模型 | 无 | @@ -142,7 +142,7 @@ Memoh 支持 **斜杠命令**,在进 LLM 之前截获。用来快速看状态 **内置网页本地** 没有 `/new discuss`,要 discuss 请用 Telegram、Discord 等。 -细节见 [会话](/zh/guides/sessions.md)。 +细节见 [会话](./sessions.md)。 ### `/stop` @@ -304,7 +304,7 @@ Memoh 支持 **斜杠命令**,在进 LLM 之前截获。用来快速看状态 ## `/compact` -立刻对**当前会话**做 [会话上下文压缩](/zh/guides/compaction.md),**不是**改记忆库里条目的那种记忆压缩。 +立刻对**当前会话**做 [会话上下文压缩](./compaction.md),**不是**改记忆库里条目的那种记忆压缩。 | 动作 | 用法 | |------|------| diff --git a/docs/zh/guides/supermarket.md b/docs/zh/guides/supermarket.md index ffdb7d2..e689702 100644 --- a/docs/zh/guides/supermarket.md +++ b/docs/zh/guides/supermarket.md @@ -1,38 +1,38 @@ -# Supermarket +# 应用市场(Supermarket) -Supermarket 是 Memoh 内置的**连接器**和 **Skills** 目录。连接器把第三方服务(GitHub、Notion 这类)绑到 Bot 上;Skills 是 Agent 可按需加载的可复用流程。 +应用市场是 Memoh 内置的**连接器**和 **Skills** 目录。连接器把第三方服务(GitHub、Notion 这类)绑到 Bot 上;Skills 是 Agent 可按需加载的可复用流程。 -Web UI 会在 Settings 下显示 Supermarket,提供两个 tab: +Web UI 会在 Settings 下显示应用市场,提供两个 tab: - **Connectors** - **Skills** -服务器[配置了 Connect-It](/zh/guides/connectors.md#前提) 时,**Connectors** 排在第一个,也是默认落地的 tab;没配置时这个 tab 不显示,默认落在 **Skills**。 +服务器[配置了 Connect-It](./connectors.md#前提) 时,**Connectors** 排在第一个,也是默认落地的 tab;没配置时这个 tab 不显示,默认落在 **Skills**。 --- ## 连接一个服务 -**Connectors** tab 列出可以通过 OAuth 或 API Key 连给 Bot 的服务。挑一个点 **Connect**,选目标 Bot,完成授权即可。完整流程——认证方式、连接状态、工具怎么到 Bot 手上——见[连接器](/zh/guides/connectors.md)。 +**Connectors** tab 列出可以通过 OAuth 或 API Key 连给 Bot 的服务。挑一个点 **Connect**,选目标 Bot,完成授权即可。完整流程——认证方式、连接状态、工具怎么到 Bot 手上——见[连接器](./connectors.md)。 --- ## 安装 Skill -1. 在 Web UI 中打开 **Supermarket**。 +1. 在 Web UI 中打开 **应用市场**。 2. 切到 **Skills** tab。 3. 选择一个 Skill 并点击 **Install**,或进入 Skill 详情页点击 **Install to Bot**。 4. 选择目标 Bot。 5. 确认安装。 6. Skill 会出现在该 Bot 的 **Skills** tab 中。 -Skill 会安装到 Bot 工作区内的 managed skills 目录(`/data/skills/`)。Skill 详情页展示作者、版本、来源 registry 和链接。加载与使用方式见 [Skills](/zh/guides/skills.md)。 +Skill 会安装到 Bot 工作区内的 managed skills 目录(`/data/skills/`)。Skill 详情页展示作者、版本、来源 registry 和链接。加载与使用方式见 [Skills](./skills.md)。 --- -## 配置 Supermarket +## 配置应用市场 -默认情况下,Memoh 会从这里读取 Supermarket 内容: +默认情况下,Memoh 会从这里读取应用市场内容: ```toml [supermarket] diff --git a/docs/zh/guides/use-cases.md b/docs/zh/guides/use-cases.md new file mode 100644 index 0000000..6cd2526 --- /dev/null +++ b/docs/zh/guides/use-cases.md @@ -0,0 +1,5 @@ +# 使用场景 + +组合多种 Memoh 功能解决实际问题的即用型示例。 + +> 敬请期待。 \ No newline at end of file diff --git a/docs/zh/index.md b/docs/zh/index.md index 578ccee..366f091 100644 --- a/docs/zh/index.md +++ b/docs/zh/index.md @@ -1,9 +1,10 @@ --- -title: Memoh 中文文档 +title: Memoh 文档 +description: 学习 Memoh、连接外部系统,或部署你自己的实例。 --- -# Memoh 中文文档 +# Memoh 文档 -学习 Memoh、连接外部系统,或部署自己的服务。 +学习 Memoh、连接外部系统,或部署你自己的实例。 diff --git a/docs/zh/integrations/channels/dingtalk.md b/docs/zh/integrations/channels/dingtalk.md index cb73a7d..a1a4adc 100644 --- a/docs/zh/integrations/channels/dingtalk.md +++ b/docs/zh/integrations/channels/dingtalk.md @@ -14,7 +14,7 @@ 2. 填 **App Key**、**App Secret**。 3. **Save and Enable**。 -Memoh 会维护与钉钉的 **stream 长连接**。常规部署**不用**你再去配一层 webhook 回调地址(与飞书公众号那种不同)。 +Memoh 会维护与钉钉的 **stream 长连接**。常规部署**不用**你再去配一层 webhook 回调地址(与飞书、微信公众号那种 webhook 模式不同)。 ## 3. 验证 diff --git a/docs/zh/integrations/channels/discord.md b/docs/zh/integrations/channels/discord.md index baa0c6b..fb77347 100644 --- a/docs/zh/integrations/channels/discord.md +++ b/docs/zh/integrations/channels/discord.md @@ -36,5 +36,5 @@ ## 支持的能力 - 读**完整消息正文**。 -- **附件**图片、文件。 +- **附件**:图片、文件。 - 若用 MCP 等可扩展 slash;具体以你 Memoh 版本与配置为准。 diff --git a/docs/zh/integrations/channels/feishu.md b/docs/zh/integrations/channels/feishu.md index 4ef3acd..5c26599 100644 --- a/docs/zh/integrations/channels/feishu.md +++ b/docs/zh/integrations/channels/feishu.md @@ -1,6 +1,6 @@ # 飞书(Lark) -通过飞书开放平台接企业内机器人在群/私聊里用。 +通过飞书开放平台接入,让企业机器人在群聊/私聊里与用户交互。 ## 1. 建飞书应用 @@ -16,7 +16,7 @@ **应用能力** → **权限管理**,至少可开(按组织要求可能需审批): -- `im:message`(收发信息) +- `im:message`(收发消息) - `im:chat`(群信息等) 需时点 **申请权限**。 diff --git a/docs/zh/integrations/channels/index.md b/docs/zh/integrations/channels/index.md index c328af1..0bfdb08 100644 --- a/docs/zh/integrations/channels/index.md +++ b/docs/zh/integrations/channels/index.md @@ -6,18 +6,18 @@ | 平台 | 指南 | 备注 | |------|------|------| -| Slack | [Slack](/zh/integrations/channels/slack) | Workspace 消息、thread | -| Telegram | [Telegram](/zh/integrations/channels/telegram) | 附件、流式较好 | -| 飞书 | [飞书](/zh/integrations/channels/feishu) | 可走 webhook 入站 | -| Discord | [Discord](/zh/integrations/channels/discord) | 社群、服务器 | -| QQ | [QQ](/zh/integrations/channels/qq) | 偏个人 DM | -| Matrix | [Matrix](/zh/integrations/channels/matrix) | 自建 homeserver | -| Misskey | [Misskey](/zh/integrations/channels/misskey) | 回复、反应;无流式 | -| 钉钉 | [钉钉](/zh/integrations/channels/dingtalk) | 企业私聊/群 | -| 企微 | [企微](/zh/integrations/channels/wecom) | 企业微信工作区 | -| 微信 | [微信](/zh/integrations/channels/weixin) | 个人扫码登录 | -| 微信公众号 | [微信公众号](/zh/integrations/channels/wechatoa) | 公众号 webhook | -| 邮件 | [邮件](/zh/guides/email) | SMTP、Mailgun、Gmail OAuth 等邮件流程 | +| Slack | [Slack](./slack.md) | Workspace 消息、thread | +| Telegram | [Telegram](./telegram.md) | 附件、流式较好 | +| 飞书 | [飞书](./feishu.md) | 可走 webhook 入站 | +| Discord | [Discord](./discord.md) | 社群、服务器 | +| QQ | [QQ](./qq.md) | 偏个人 DM | +| Matrix | [Matrix](./matrix.md) | 自建 homeserver | +| Misskey | [Misskey](./misskey.md) | 回复、反应;无流式 | +| 钉钉 | [钉钉](./dingtalk.md) | 企业私聊/群 | +| 企微 | [企微](./wecom.md) | 企业微信工作区 | +| 微信 | [微信](./weixin.md) | 个人扫码登录 | +| 微信公众号 | [微信公众号](./wechatoa.md) | 公众号 webhook | +| 邮件 | [邮件](../../guides/email.md) | SMTP、Mailgun、Gmail OAuth 等邮件流程 | | Web | 内置 | Memoh 网页端自带 | ## 微信选项 @@ -27,7 +27,7 @@ Memoh 支持两种微信相关适配: - **微信(`weixin`)**:个人号扫码登录。 - **微信公众号(`wechatoa`)**:公众号 webhook,需要 `App ID`、`App Secret`、`Token`,可选 AES 设置。 -按实际部署模型选择,不要混用。 +按实际部署模式选择,不要混用。 ## 通用配置流程 diff --git a/docs/zh/integrations/channels/qq.md b/docs/zh/integrations/channels/qq.md index c3aa02c..032600d 100644 --- a/docs/zh/integrations/channels/qq.md +++ b/docs/zh/integrations/channels/qq.md @@ -5,7 +5,7 @@ ## 1. 建 QQ 机器人 1. 打开 [QQ 机器人开放平台](https://q.qq.com/qqbot/openclaw/),用 QQ 登录。 -2. **创建机器人**(创建机器人),一般无需审批;每号最多约 5 个。 +2. **创建机器人**,一般无需审批;每号最多约 5 个。 3. 记下 **AppID**、**AppSecret**。 > **注意**:AppSecret 往往只显示一次,存好。再看一次常会被迫重置。 diff --git a/docs/zh/integrations/channels/slack.md b/docs/zh/integrations/channels/slack.md index 4eab422..4d29e3b 100644 --- a/docs/zh/integrations/channels/slack.md +++ b/docs/zh/integrations/channels/slack.md @@ -22,9 +22,9 @@ - `channels:history` / `groups:history` / `im:history` / `mpim:history`:读各场景消息 - `chat:write`:在频道/线程/DM 里发 - `files:read` / `files:write`:收、发文件 -- `reactions:write`:动反应 +- `reactions:write`:添加/移除反应 -建议再加(名子、元数据更齐): +建议再加(名字、元数据更齐): - `channels:read` / `groups:read` / `im:read` / `mpim:read` @@ -54,9 +54,9 @@ - DM:在 Slack 里和该 app 开对话并发一条。 - 公开频道:把 app **邀请**进频道。 -- 私聊频道:装好后**显式邀请**进频道。 +- 私有频道:装好后**显式邀请**进频道。 -能发不能收图/文件,多半缺 `files:read`;能连上没人任何入站,查 **Event** 和 **history** 类 scope 是否配对。 +能发不能收图/文件,多半缺 `files:read`;能连上但收不到任何入站消息,查 **Event** 和 **history** 类 scope 是否配对。 ## 支持的能力 diff --git a/docs/zh/integrations/channels/telegram.md b/docs/zh/integrations/channels/telegram.md index 60d7d0e..1ede426 100644 --- a/docs/zh/integrations/channels/telegram.md +++ b/docs/zh/integrations/channels/telegram.md @@ -27,4 +27,4 @@ - **流式**:边生成边出字。 - **Markdown**:粗体、斜体、代码块、链接等。 - **附件**:收图/文件,机器人也可发文件。 -- **回复链**:跟贴上下文能用于推理。 +- **回复链**:机器人能理解回复消息中的上下文。 diff --git a/docs/zh/integrations/channels/wechatoa.md b/docs/zh/integrations/channels/wechatoa.md index 12f4933..c888644 100644 --- a/docs/zh/integrations/channels/wechatoa.md +++ b/docs/zh/integrations/channels/wechatoa.md @@ -17,13 +17,13 @@ 1. 机器人 **Platforms** → **Add Channel** → **WeChat Official Account**(名称以界面为准)。 2. 填 **App ID**、**App Secret**、**Token**。 3. 选 **加解密方式**(与微信后台一致)。 -4. 若用 `safe` / `compatible` 等要密钥的模式,再填 **Encoding AES Key**。 +4. 若用 `safe` / `compat` 等要密钥的模式,再填 **Encoding AES Key**。 5. 先**保存**渠道。保存后 Memoh 会生成 **URL(服务器配置)** 用的回调地址,复制到微信平台。 ## 3. 在微信平台填回调 1. 把 Memoh 的 **Webhook 回调 URL** 粘到公众号后台「服务器配置」的 URL。 -2. **Token**、**Encoding**、**EncodingAESKey** 两边必须**完全一致**。 +2. **Token**、**加解密方式**、**EncodingAESKey** 两边必须**完全一致**。 3. 微信会先做一次**验证**,通过后才真正推消息。 ## 4. 启用与试发 diff --git a/docs/zh/integrations/providers/index.md b/docs/zh/integrations/providers/index.md index 22de380..8b4ebdb 100644 --- a/docs/zh/integrations/providers/index.md +++ b/docs/zh/integrations/providers/index.md @@ -4,9 +4,9 @@ ## 提供方类型 -- **[LLM 提供方](/zh/integrations/providers/llm)**:聊天、embedding、生图等模型配置。 -- **[记忆提供方](/zh/integrations/providers/memory/)**:长期记忆的存储和检索后端。 -- **[TTS 提供方](/zh/integrations/providers/tts/)**:语音合成提供方和音色。 -- **[搜索提供方](/zh/integrations/providers/web-search)**:网页访问工具使用的搜索提供方。 +- **[模型服务商](./llm.md)**:聊天、embedding、生图等模型配置。 +- **[记忆提供方](./memory/index.md)**:长期记忆的存储和检索后端。 +- **[TTS 提供方](./tts/index.md)**:语音合成提供方和音色。 +- **[搜索提供方](./web-search.md)**:网页访问工具使用的搜索提供方。 -配置完成后,产品侧使用方式见 **[机器人](/zh/guides/bot)** 和 **[长期记忆](/zh/guides/memory)**。 +配置完成后,产品侧使用方式见 **[机器人](../../guides/bot.md)** 和 **[长期记忆](../../guides/memory.md)**。 diff --git a/docs/zh/integrations/providers/llm.md b/docs/zh/integrations/providers/llm.md index 02411a8..93f60b2 100644 --- a/docs/zh/integrations/providers/llm.md +++ b/docs/zh/integrations/providers/llm.md @@ -1,19 +1,19 @@ -# 供应商与模型 +# 模型服务商与模型 日常用 Memoh,多半要配好: -- 一个或多个 **供应商**(怎么连上游 API) +- 一个或多个 **模型服务商**(怎么连上游 API) - 其下的 **模型** -- 若要朗读,再配 **语音合成**(见 [TTS](/zh/integrations/providers/tts/index.md)) +- 若要朗读,再配 **语音合成**(见 [TTS](./tts/index.md)) - 若要把语音转文字,再配 **语音转写** 聊天与 embedding 在 **Models** 页管理;语音合成模型在 TTS 流程里单走,语音转写模型在 Transcription 设置页管理。 --- -## 供应商基础 +## 模型服务商基础 -**供应商**里存的是某一类上游的连法,例如: +**模型服务商**里存的是某一类上游的连法,例如: - 协议(`client_type`) - 需要时的 base URL @@ -21,25 +21,25 @@ 常见有 OpenAI 兼容站、Anthropic、Google、Codex、GitHub Copilot 等。 -### 新建供应商 +### 新建模型服务商 -供应商现在从**模板目录**建。模板自带对的 client type、base URL 和一份精选模型清单,通常你只需要填个 API Key。 +模型服务商现在从**模板目录**建。模板自带对的 client type、base URL 和一份精选模型清单,通常你只需要填个 API Key。 1. 侧栏打开 **Models**。 2. 点 **Add Provider**,从模板列表挑——只显示你还没配过的,可搜索(中文厂商名也能搜到)。 3. 填模板要的凭据。 -4. 保存。供应商和它的预置模型在保存时一起生成。 +4. 保存。模型服务商和它的预置模型在保存时一起生成。 内置模板包括 OpenAI、Anthropic、Google、OpenRouter、DeepSeek、**智谱 AI(bigmodel.cn)**、Z.AI、Azure OpenAI、Cerebras、Cloudflare、Fireworks、Perplexity、Together 等。注意**智谱 AI**(`open.bigmodel.cn`,国内账号)和 **Z.AI**(`api.z.ai`,国际账号)是两个模板、两套 key 体系——按你的 key 是哪边发的来选。 -没有合适模板时,仍可以建全自定义供应商。 +没有合适模板时,仍可以建全自定义模型服务商。 常用字段: | 字段 | 说明 | |------|------| | **Name** | 展示名,如 `OpenAI`。 | -| **Client Type** | 本供应商用的协议。 | +| **Client Type** | 本模型服务商用的协议。 | | **Base URL** | 部分协议必填的根地址。 | | **API Key** | 走密钥时填。 | @@ -68,21 +68,21 @@ | `microsoft-speech` | Microsoft 语音合成 | | `google-transcription` | Google 语音转写 | -语音合成与语音转写类型不能当主聊天用。语音合成走 [TTS 提供方](/zh/integrations/providers/tts/index.md),语音转写走 Transcription 设置页。具体模型、音色和语言取决于 provider 模板与上游账号。 +语音合成与语音转写类型不能当主聊天用。语音合成走 [TTS 提供方](./tts/index.md),语音转写走 Transcription 设置页。具体模型、音色和语言取决于 provider 模板与上游账号。 --- -## 走 OAuth 的供应商 +## 走 OAuth 的模型服务商 多数类型用普通 API Key。`openai-codex` 和 `github-copilot` 例外——两个都走**设备码授权**,同一套流程,都没有 API Key 输入框: -1. 先建好并**保存**供应商——授权入口只在已保存供应商的详情面板里。 +1. 先建好并**保存**模型服务商——授权入口只在已保存模型服务商的详情面板里。 2. **Account** 区点 **Connect**,界面给出验证 URL、一次性用户码和过期倒计时。 3. 点 **Copy & Open**,去验证页输码,Memoh 自动完成收尾。 > 一次性码只在显示的官方验证 URL 上输——设备码可能被用于钓鱼。 -连上后供应商上会显示当前账号,**Revoke** 断开。 +连上后模型服务商上会显示当前账号,**Revoke** 断开。 ### OpenAI Codex @@ -99,12 +99,12 @@ 你本来就有 Copilot 时,可复用进 Memoh。 ::: warning 升级提醒 -Copilot 凭据以前按用户存,现在和 Codex 一样是供应商级的一份。老部署升级后要把 Copilot 供应商**重新授权一次**。 +Copilot 凭据以前按用户存,现在和 Codex 一样是模型服务商级的一份。老部署升级后要把 Copilot 模型服务商**重新授权一次**。 ::: ### 托管模型目录 -两个 OAuth 供应商的模型列表都是**托管目录**,从上游实时拉取(Codex 干脆没有静态清单,永远反映你 ChatGPT 账号实际能用什么): +两个 OAuth 模型服务商的模型列表都是**托管目录**,从上游实时拉取(Codex 干脆没有静态清单,永远反映你 ChatGPT 账号实际能用什么): - 设备授权完成后目录自动同步,之后也可以随时重新导入。 - 上游目录里消失的模型标记为不可用,不会被删。 @@ -114,11 +114,11 @@ Copilot 凭据以前按用户存,现在和 Codex 一样是供应商级的一 ## 导入模型 -建完供应商后可以导入或手加模型。常见:选中供应商 → **Import Models**(若上游有目录)→ 勾要保存的。已知上游 id 时也可手填。 +建完模型服务商后可以导入或手加模型。常见:选中模型服务商 → **Import Models**(若上游有目录)→ 勾要保存的。已知上游 id 时也可手填。 ### 模型启用开关 -供应商详情页里每个模型一行,各带**启用开关**。禁用的模型仍留在这页方便再开,但会从所有模型选择器(机器人设置、聊天、embedding 等)里消失。 +模型服务商详情页里每个模型一行,各带**启用开关**。禁用的模型仍留在这页方便再开,但会从所有模型选择器(机器人设置、聊天、embedding 等)里消失。 默认值看模型怎么来的: @@ -136,7 +136,7 @@ Copilot 凭据以前按用户存,现在和 Codex 一样是供应商级的一 | `speech` | 朗读,挂在 TTS | | `transcription` | 语音转文字,挂在 Transcription | -**Models** 页主要管 chat / embedding;speech 在 [TTS](/zh/integrations/providers/tts/index.md),transcription 在 Transcription 设置页。 +**Models** 页主要管 chat / embedding;speech 在 [TTS](./tts/index.md),transcription 在 Transcription 设置页。 --- @@ -168,7 +168,7 @@ Memoh 用来: - 在网页上算当前会话占了多少上下文 - 驱动 `/status` 等 - 判断是否逼近上限 -- 决定何时需要 [会话上下文压缩](/zh/guides/compaction) +- 决定何时需要 [会话上下文压缩](../../guides/compaction.md) 不填也能用,但**百分比**会没法精确给。 @@ -186,7 +186,7 @@ Memoh 用来: ## 语音合成与转写模型 -语音合成在 [TTS 提供方](/zh/integrations/providers/tts/index.md) 配,不跟普通 chat 供应商混流。当前语音合成类别包括: +语音合成在 [TTS 提供方](./tts/index.md) 配,不跟普通 chat 模型服务商混流。当前语音合成类别包括: - Edge:`edge-speech` - OpenAI 兼容:`openai-speech` @@ -224,6 +224,6 @@ Memoh 用来: ## 接下来 -- 给机器人绑聊天、生图、浏览器、记忆、朗读等:[机器人](/zh/guides/bot.md) -- 配语音提供方与语音模型:[TTS 提供方](/zh/integrations/providers/tts/index.md) +- 给机器人绑聊天、生图、记忆、朗读等:[机器人](../../guides/bot.md) +- 配语音提供方与语音模型:[TTS 提供方](./tts/index.md) - 配语音转文字:打开 Web UI 的 Transcription 设置页 diff --git a/docs/zh/integrations/providers/memory/builtin.md b/docs/zh/integrations/providers/memory/builtin.md index c94d9e9..4e53445 100644 --- a/docs/zh/integrations/providers/memory/builtin.md +++ b/docs/zh/integrations/providers/memory/builtin.md @@ -37,7 +37,7 @@ | 字段 | 说明 | |------|------| -| **Embedding Model** | 可选。来自某个 LLM 提供方的 embedding 模型。选了(且 `pgvector` 可用)就会给记忆节点做向量并开启语义检索;留空即纯 graph 模式。 | +| **Embedding Model** | 可选。来自某个模型服务商的 embedding 模型。选了(且 `pgvector` 可用)就会给记忆节点做向量并开启语义检索;留空即纯 graph 模式。 | **Edit**、**Delete** 如常。 @@ -64,7 +64,7 @@ database = "memoh_vector" sslmode = "disable" ``` -然后在提供方里选一个 **Embedding Model**。向量由所选 LLM 提供方(OpenAI、Gemini、Ollama……)生成,因此该提供方需要有 embedding 模型可用。 +然后在提供方里选一个 **Embedding Model**。向量由所选模型服务商(OpenAI、Gemini、Ollama……)生成,因此该提供方需要有 embedding 模型可用。 --- @@ -87,4 +87,4 @@ sslmode = "disable" - 搜索、编辑、删除 - 压缩或重建记忆库 -日常操作见 [记忆管理](/zh/guides/memory.md)。 \ No newline at end of file +日常操作见 [记忆管理](../../../guides/memory.md)。 \ No newline at end of file diff --git a/docs/zh/integrations/providers/memory/index.md b/docs/zh/integrations/providers/memory/index.md index f17eadd..6be9d6e 100644 --- a/docs/zh/integrations/providers/memory/index.md +++ b/docs/zh/integrations/providers/memory/index.md @@ -4,9 +4,9 @@ ## 有哪些 -- [内置](/zh/integrations/providers/memory/builtin.md):默认自带:记忆图存 PostgreSQL,配了 embedding 模型后可加 pgvector 语义检索,全可自建。 -- [Mem0](/zh/integrations/providers/memory/mem0.md):走 Mem0 云 API,要密钥。 -- [OpenViking](/zh/integrations/providers/memory/openviking.md):自建或 SaaS,自有 API。 +- [内置](./builtin.md):默认自带:记忆图存 PostgreSQL,配了 embedding 模型后可加 pgvector 语义检索,全可自建。 +- [Mem0](./mem0.md):走 Mem0 云 API,要密钥。 +- [OpenViking](./openviking.md):自建或 SaaS,自有 API。 --- @@ -22,7 +22,7 @@ ## 接下来 -- [内置](/zh/integrations/providers/memory/builtin.md) -- [Mem0](/zh/integrations/providers/memory/mem0.md) -- [OpenViking](/zh/integrations/providers/memory/openviking.md) -- 条目级操作:[长期记忆](/zh/guides/memory.md) +- [内置](./builtin.md) +- [Mem0](./mem0.md) +- [OpenViking](./openviking.md) +- 条目级操作:[长期记忆](../../../guides/memory.md) diff --git a/docs/zh/integrations/providers/memory/mem0.md b/docs/zh/integrations/providers/memory/mem0.md index 5be1301..98ecd53 100644 --- a/docs/zh/integrations/providers/memory/mem0.md +++ b/docs/zh/integrations/providers/memory/mem0.md @@ -33,4 +33,4 @@ ## 使用 -绑上后,抽取、搜索、管理都走 Mem0 API。日常见 [长期记忆](/zh/guides/memory.md)。 +绑上后,抽取、搜索、管理都走 Mem0 API。日常见 [长期记忆](../../../guides/memory.md)。 diff --git a/docs/zh/integrations/providers/memory/openviking.md b/docs/zh/integrations/providers/memory/openviking.md index eaa91df..e7d2d3a 100644 --- a/docs/zh/integrations/providers/memory/openviking.md +++ b/docs/zh/integrations/providers/memory/openviking.md @@ -31,4 +31,4 @@ ## 使用 -绑上后,记忆相关 API 都走 OpenViking。日常见 [长期记忆](/zh/guides/memory.md)。 +绑上后,记忆相关 API 都走 OpenViking。日常见 [长期记忆](../../../guides/memory.md)。 diff --git a/docs/zh/integrations/providers/tts/index.md b/docs/zh/integrations/providers/tts/index.md index 5cf3243..60448a9 100644 --- a/docs/zh/integrations/providers/tts/index.md +++ b/docs/zh/integrations/providers/tts/index.md @@ -23,7 +23,7 @@ Memoh 支持把字变成声音。可以分三层想: | 提供方 | 说明 | |--------|------| -| [Edge TTS](/zh/integrations/providers/tts/edge.md) | 走 Edge 公开朗读接口,无 key,多语音 | +| [Edge TTS](./edge.md) | 走 Edge 公开朗读接口,无 key,多语音 | | OpenAI 兼容语音合成 | 使用 OpenAI 兼容的语音合成 API,需要匹配 provider 模板和凭据。 | | OpenRouter Speech | 使用 OpenRouter 可用的语音合成路线,具体取决于账号能力。 | | ElevenLabs Speech | 使用 ElevenLabs 语音合成模型和音色。 | @@ -41,5 +41,5 @@ Memoh 支持把字变成声音。可以分三层想: ## 接下来 -- 配无 key 的 Edge 选项:[Edge TTS](/zh/integrations/providers/tts/edge.md) -- 了解音频 provider client type 与模型关系:[供应商与模型](/zh/integrations/providers/llm) +- 配无 key 的 Edge 选项:[Edge TTS](./edge.md) +- 了解音频 provider client type 与模型关系:[模型服务商与模型](../llm.md) diff --git a/docs/zh/integrations/providers/video.md b/docs/zh/integrations/providers/video.md index 707f261..7befe2a 100644 --- a/docs/zh/integrations/providers/video.md +++ b/docs/zh/integrations/providers/video.md @@ -54,5 +54,5 @@ OpenRouter 支持 **Import Models** 在线拉模型列表;ModelArk 和火山 ## 相关页面 -- [提供方与模型](/zh/integrations/providers/llm.md) -- [Workspace](/zh/guides/container.md) +- [模型服务商与模型](./llm.md) +- [Workspace](../../guides/container.md) diff --git a/docs/zh/integrations/providers/web-search.md b/docs/zh/integrations/providers/web-search.md index 73c3037..1be10d5 100644 --- a/docs/zh/integrations/providers/web-search.md +++ b/docs/zh/integrations/providers/web-search.md @@ -43,6 +43,6 @@ --- -## 和机器人 +## 机器人怎么用 需要**较新、较贴问题**的公开信息时,会走搜索,再把结果融进回答;可多结果综合。具体策略由模型和工具设计决定。 diff --git a/docs/zh/self-hosted/desktop.md b/docs/zh/self-hosted/desktop.md index fcff2d1..ff5cd0c 100644 --- a/docs/zh/self-hosted/desktop.md +++ b/docs/zh/self-hosted/desktop.md @@ -2,7 +2,7 @@ Memoh Desktop 是面向 Memoh Cloud 或自托管 Memoh 服务端的原生客户端。它把同一套 Web UI 打包进 Electron 外壳,提供原生窗口、托盘、菜单与快捷键,并且可以把所在的这台电脑注册为机器人可用的 **Computer**。 -Desktop **不会**自己运行本地服务端或数据库。你始终需要把它连到一个 Memoh 服务端:[Memoh Cloud](https://memoh.ai) 或你自己的 [Server Deploy](/zh/self-hosted/docker)。 +Desktop **不会**自己运行本地服务端或数据库。你始终需要把它连到一个 Memoh 服务端:[Memoh Cloud](https://memoh.ai) 或你自己的 [Server Deploy](./docker.md)。 ## 何时使用 Desktop @@ -35,7 +35,7 @@ Desktop **不会**自己运行本地服务端或数据库。你始终需要把 Desktop 可以把它所在的机器注册成服务端机器人可用的 **Computer**,不用另跑 runtime 进程:打开 **这台电脑** 开关,起个名字,Desktop 会通过内嵌的 Memoh runtime SDK 在后台维持连接。凭据使用操作系统的安全存储保存。 -权限模型、按机器人授权以及机器人在电脑上能做什么,见 [Computers](/zh/guides/computers.md)。 +权限模型、按机器人授权以及机器人在电脑上能做什么,见 [电脑](../guides/computers.md)。 ## Desktop 负责什么 @@ -44,4 +44,4 @@ Desktop 可以把它所在的机器注册成服务端机器人可用的 **Comput - 到所选服务端的连接及其缓存的登录状态 - **这台电脑** 对应的可选 Remote Runtime 连接 -其它一切(机器人、会话、记忆、工作区、渠道)都在你连接的服务端上。工作区运行时在服务端配置,见 [Workspace Backends](/zh/self-hosted/workspace-backends)。 \ No newline at end of file +其它一切(机器人、会话、记忆、工作区、渠道)都在你连接的服务端上。工作区运行时在服务端配置,见 [Workspace Backends](./workspace-backends.md)。 \ No newline at end of file diff --git a/docs/zh/self-hosted/docker.md b/docs/zh/self-hosted/docker.md index 4b74dfe..ed94548 100644 --- a/docs/zh/self-hosted/docker.md +++ b/docs/zh/self-hosted/docker.md @@ -1,12 +1,12 @@ -# Server Deploy +# 服务器部署(Server Deploy) Server Deploy 是 Memoh 的自托管服务端部署形态,适合长期在线、多人、多租户、远程访问,或需要机器人在桌面离线时继续服务外部渠道的场景。 -本页说明 Docker Compose 版 Server Deploy。要安装本地原生客户端,请看 [Desktop 桌面版](/zh/self-hosted/desktop)。 +本页说明 Docker Compose 版 Server Deploy。要安装本地原生客户端,请看 [Desktop 桌面版](./desktop.md)。 默认编排里包含 PostgreSQL、用于记忆向量的 pgvector 库、一次性迁移任务、主服务(显式配置 workspace backend,智能体也在同一进程)、渠道 worker 和网页前端。数据库仅支持 PostgreSQL。 -官方 Compose 栈使用 `containerd` workspace backend。server 镜像会启动内置 containerd,并挂好机器人 workspace 需要的 runtime 文件。Docker Engine 和 Apple 后端见 [Workspace backend](/zh/self-hosted/workspace-backends.md)。 +官方 Compose 栈使用 `containerd` workspace backend。server 镜像会启动内置 containerd,并挂好机器人 workspace 需要的 runtime 文件。Docker Engine 和 Apple 后端见 [Workspace backend](./workspace-backends.md)。 ## 服务结构 @@ -18,15 +18,15 @@ Compose 里有多组服务。有的默认就起,有的通过 `--profile` 打 | **channel** | *(核心)* | 渠道 worker(`memoh-channel`),持有各平台连接与 webhook,通过内部 RPC 与主服务通信 | | **web** | *(核心)* | 网页端(Vue 3) | | **postgres** | *(核心)* | PostgreSQL(主数据) | -| **pgvector** | *(核心)* | 带 `pgvector` 的 PostgreSQL,供可选的记忆向量使用;见 [内置记忆](/zh/integrations/providers/memory/builtin.md) | +| **pgvector** | *(核心)* | 带 `pgvector` 的 PostgreSQL,供可选的记忆向量使用;见 [内置记忆](../integrations/providers/memory/builtin.md) | | **migrate** | *(核心,一次性)* | 在主服务启动前执行 `memoh-server migrate up` | | **webhook-tunnel** | `webhook-tunnel` | 可选的 `cloudflared` 快速隧道,把渠道 worker 的 webhook 监听暴露到公网 | -| **connect-it** | `connectors` | 同机部署的 [Connect-It](https://github.com/memohai/connect-it),支撑 Bot [连接器](/zh/guides/connectors.md)(见下) | +| **connect-it** | `connectors` | 同机部署的 [Connect-It](https://github.com/memohai/connect-it),支撑 Bot [连接器](../guides/connectors.md)(见下) | ### Connect-It 连接器 -**connect-it** 容器跑的是 [Connect-It](https://github.com/memohai/connect-it),Bot [连接器](/zh/guides/connectors.md)背后的服务——通过 OAuth 或 API Key 把第三方服务(GitHub、Notion 这类)连给 Bot。它共用 Memoh 的 PostgreSQL,数据隔离在单独的 `connect_it` schema 里,迁移自己管。 +**connect-it** 容器跑的是 [Connect-It](https://github.com/memohai/connect-it),Bot [连接器](../guides/connectors.md)背后的服务——通过 OAuth 或 API Key 把第三方服务(GitHub、Notion 这类)连给 Bot。它共用 Memoh 的 PostgreSQL,数据隔离在单独的 `connect_it` schema 里,迁移自己管。 安装脚本把 Connect-It 全程管起来: @@ -59,7 +59,7 @@ curl -fsSL https://memoh.sh | sh 需要提权,脚本会只对 `docker` 命令使用 `sudo`。如果确实要以 root 运行整个安装脚本,需要显式设置 `MEMOH_ALLOW_ROOT_INSTALL=true`。 -脚本会:检查 Docker/Compose;判断首次安装、升级或重装;交互问配置(工作区、数据目录、管理员、JWT、Postgres 密码、workspace backend 提示);升级时自动复用已有 `config.toml`,保持数据库凭据和已有 PostgreSQL volume 一致;可选择清理重装并删除 Memoh 容器、volume 和 network;从 GitHub 取最新发布并克隆;按 Docker 模板生成 `config.toml`;拒绝升级遗留的 SQLite 安装(仅支持 PostgreSQL,需选择重装);把 Memoh 镜像钉到发布版本(例如 `v0.13.0` 对应镜像 tag `0.13.0`);全新安装时带起同机部署的 Connect-It——凭据只生成一次、写进 `.env`,并加上 `connectors` profile(见[上面](#connect-it-连接器));默认带 `qdrant` profile 启动,启用 sparse 时再加 `sparse` profile;启动失败时打印数据库、迁移和 server 的近期日志。 +脚本会:检查 Docker/Compose;判断首次安装、升级或重装;交互问配置(工作区、数据目录、管理员、JWT、Postgres 密码、workspace backend 提示);升级时自动复用已有 `config.toml`,保持数据库凭据和已有 PostgreSQL volume 一致;可选择清理重装并删除 Memoh 容器、volume 和 network;从 GitHub 取最新发布并克隆;按 Docker 模板生成 `config.toml`;拒绝升级遗留的 SQLite 安装(仅支持 PostgreSQL,需选择重装);把 Memoh 镜像钉到发布版本(例如 `v0.13.0` 对应镜像 tag `0.13.0`);全新安装时带起同机部署的 Connect-It——凭据只生成一次、写进 `.env`,并加上 `connectors` profile(见[上面](#connect-it-连接器));启动失败时打印数据库、迁移和 server 的近期日志。 **静默安装**(全默认、无提问): @@ -147,7 +147,7 @@ POSTGRES_PASSWORD=你的库密码 docker compose up -d > **重要**:`docker-compose.yml` 默认挂 `./config.toml`,先建好文件再 `up`,否则起不来。 -手动部署要开[连接器](/zh/guides/connectors.md)的话,自己生成 Connect-It 凭据并加 `connectors` profile: +手动部署要开[连接器](../guides/connectors.md)的话,自己生成 Connect-It 凭据并加 `connectors` profile: ```bash MEMOH_CONNECT_IT_BASE_URL="http://connect-it:8421" \ @@ -201,7 +201,7 @@ docker compose -f docker-compose.yml -f docker/docker-compose.cn.yml up -d | `[server]` | 监听,默认 `:8080` | | `[admin]` | 管理员账号 | | `[auth]` | JWT 与过期时间 | -| `timezone` | 服时区,默认 `UTC` | +| `timezone` | 服务器时区,默认 `UTC` | | `[database]` | 数据库驱动;仅支持 `postgres` | | `[container]` | Workspace backend 选择,以及通用 workspace 镜像、拉取策略、数据路径、runtime 路径、CNI 设置 | | `[containerd]` | socket 与 namespace | @@ -211,11 +211,11 @@ docker compose -f docker-compose.yml -f docker/docker-compose.cn.yml up -d | `[pgvector]` | 可选的 pgvector 库,用于记忆向量(`enabled`、host、port、user、password、database、sslmode) | | `[internal_rpc]` | 主服务/渠道 worker 拆分部署的 RPC 地址与共享密钥 | | `[webhook_tunnel]` | webhook 隧道模式(`disabled` 或 `external`)与 `public_base_url` | -| `[registry]` | 供应商定义目录 | -| `[connect_it]` | [连接器](/zh/guides/connectors.md)用的 Connect-It 地址(`base_url`、`api_token`);两项都空即关闭该功能。Compose 环境里由 `MEMOH_CONNECT_IT_BASE_URL` / `MEMOH_CONNECT_IT_API_TOKEN` 覆盖 | +| `[registry]` | 模型服务商定义目录 | +| `[connect_it]` | [连接器](../guides/connectors.md)用的 Connect-It 地址(`base_url`、`api_token`);两项都空即关闭该功能。Compose 环境里由 `MEMOH_CONNECT_IT_BASE_URL` / `MEMOH_CONNECT_IT_API_TOKEN` 覆盖 | | `[web]` | 前端 host/port | | `[agent]` | 工具输出截断上限:`tool_output_max_bytes`(默认 65536)、`tool_output_max_lines`(默认 2000)、`system_files_max_bytes`(默认 32768)。超限时保留头尾,不是盲切。 | -| `[session_runtime]` | 多实例部署的会话状态后端,见上面「多实例部署」 | +| `[session_runtime]` | 多实例部署的会话状态后端,见下方[多实例部署](#多实例部署) | ## 多实例部署 diff --git a/docs/zh/self-hosted/index.md b/docs/zh/self-hosted/index.md index 2a34fa5..5a93e15 100644 --- a/docs/zh/self-hosted/index.md +++ b/docs/zh/self-hosted/index.md @@ -5,20 +5,20 @@ Memoh 以服务端形态运行,Web UI 和 Desktop 桌面版都是它的客户 | 场景 | 选择 | 原因 | |------|------|------| | 什么都不想装,先试试 | [Memoh Cloud](https://memoh.ai) | 托管服务,功能一致,无需运维服务器。 | -| 共享服务器、远程访问、生产长期在线、对接 Telegram/Discord/飞书/微信/邮件等渠道、多用户或多租户 | [Server Deploy](/zh/self-hosted/docker) | Docker Compose 栈会持续运行后端、网页端、PostgreSQL(含 pgvector 记忆存储)和 workspace runtime。 | -| 想在自己电脑上用原生 App,或把这台电脑作为 Computer 共享给机器人 | [Desktop 桌面版](/zh/self-hosted/desktop) | 连接 Cloud 或自托管服务端的原生客户端;不会在本地运行服务端。 | +| 共享服务器、远程访问、生产长期在线、对接 Telegram/Discord/飞书/微信/邮件等渠道、多用户或多租户 | [Server Deploy](./docker.md) | Docker Compose 栈会持续运行后端、网页端、PostgreSQL(含 pgvector 记忆存储)和 workspace runtime。 | +| 想在自己电脑上用原生 App,或把这台电脑作为 Computer 共享给机器人 | [Desktop 桌面版](./desktop.md) | 连接 Cloud 或自托管服务端的原生客户端;不会在本地运行服务端。 | ## Server Deploy Server Deploy 适合多人、远程、长期在线或多租户场景。机器人需要持续接入 Telegram、Discord、飞书、微信、公众号、邮件等外部渠道时,也应该用这一形态。 -最快的路径见 [快速开始](/zh/guides/quick-start),完整参考见 [Server Deploy](/zh/self-hosted/docker)。 +最快的路径见 [快速开始](../guides/quick-start.md),完整参考见 [Server Deploy](./docker.md)。 ## Desktop 桌面版 -Desktop 适合想要托盘图标与快捷键的原生体验,或者想让服务端机器人使用你电脑上的文件、Shell 和浏览器的场景。Desktop 始终连接一个服务端(Cloud 或自托管),详见 [Desktop](/zh/self-hosted/desktop)。 +Desktop 适合想要托盘图标与快捷键的原生体验,或者想让服务端机器人使用你电脑上的文件、Shell 和浏览器的场景。Desktop 始终连接一个服务端(Cloud 或自托管),详见 [Desktop](./desktop.md)。 ## 相关页面 -- [Workspace backend](/zh/self-hosted/workspace-backends) 解释 Docker、containerd、Apple 和本地 workspace 的差异。 -- [Computers](/zh/guides/computers) 介绍如何把自己的机器共享给机器人。 \ No newline at end of file +- [Workspace backend](./workspace-backends.md) 解释 Docker、containerd、Apple 和本地 workspace 的差异。 +- [电脑](../guides/computers.md) 介绍如何把自己的机器共享给机器人。 \ No newline at end of file diff --git a/docs/zh/self-hosted/workspace-backends.md b/docs/zh/self-hosted/workspace-backends.md index 88d5186..2f99d43 100644 --- a/docs/zh/self-hosted/workspace-backends.md +++ b/docs/zh/self-hosted/workspace-backends.md @@ -1,4 +1,4 @@ -# Workspace backend +# 工作区后端(Workspace backend) 每个 Memoh 机器人都在一个 workspace 里工作。workspace 可以是隔离容器,也可以是在 Desktop/local 场景下明确受信任的本机目录。Backend 决定 workspace 跑在哪里,以及隔离、网络、快照和 display 能力是否可用。 @@ -90,7 +90,7 @@ Apple backend 用于通过 socktainer 和 Apple Containerization 做 macOS 本 当网站需要真实图形浏览器时,用这条路径。Headless Playwright 仍然可以作为普通 workspace 命令运行,但 Browser Use 和 Computer Use 面向的是有头 workspace 桌面。 -Local workspace 不提供同样的容器桌面隔离。工具层面的区别见 [Browser / Computer Use](/zh/guides/browser-computer-use)。 +Local workspace 不提供同样的容器桌面隔离。工具层面的区别见 [Browser / Computer Use](../guides/browser-computer-use.md)。 ## 网络和 overlay