HQBase

HQBase

团队的邮件工作空间。运行在你自己的基础设施上。

一个开源的共享邮件工作空间，运行在你的 Cloudflare 账户中，并将邮件和凭据保存在由你掌控的基础设施中。

网站 · 文档 · 发行版本 · 参与贡献

关于 HQBase

HQBase 为团队提供一个处理共享邮箱的工作空间，同时将应用程序、邮件和 Cloudflare 凭据保存在客户自己的基础设施中。它包含：

• 共享邮箱和团队访问控制。
• 多域名设置、草稿和审计历史记录。
• 安装、更新、备份和恢复操作。
• 受 OAuth 保护的远程 MCP 服务。

请参阅产品文档，了解安装、日常使用、架构和运维。

社区作品

我们很高兴看到大家围绕 HQBase 开展开发。独立客户端为你提供了更多使用工作空间的方式：

• Herald — 面向 HQBase 的原生 macOS 邮件客户端。

HQBase 已测试 Herald 的兼容性。该项目由独立社区开发者制作和维护，因此其发行版本、支持和行为均由他们负责，而非 HQBase。请仔细评估该项目，并判断它是否适合你的工作空间。

本地开发

启动应用程序

pnpm install
pnpm db:migrate:local
pnpm db:seed:local
pnpm dev

运行可选的种子数据命令之前，请将以下值添加到 .dev.vars：

• BETTER_AUTH_SECRET
• HQBASE_LOCAL_SEED_PASSWORD，长度为 8 到 128 个字符

种子数据命令只会写入本地 D1，不会联系 Cloudflare OAuth。打开 http://127.0.0.1:5173/，使用 [email protected] 和该 密码登录。Vite 会在 5173 端口提供支持实时重载的前端，并将 API 请求代理到 8787 端口上的 Wrangler Worker。

若要使用首次运行设置流程，请省略种子数据命令，并打开 http://localhost:5173/setup。

重置本地数据

若要丢弃所有本地 D1 数据、重新构建架构并重新创建演示工作空间：

pnpm db:reset:local
pnpm db:seed:local

重置命令具有破坏性，且仅作用于本地。它不会更改已部署的数据库。

预览设置界面

用于仅供展示的引导设置工作：

pnpm dev:setup-ui

打开 http://127.0.0.1:5173/__ui/setup。

查看视觉系统

若要检查共享组件、交互状态、产品模式和本地屏幕路由：

pnpm dev:ui

打开 http://127.0.0.1:5173/__ui/design。该图库使用确定性的展示样例，不会调用产品 API。

验证更改

运行完整的本地质量检查：

pnpm check
pnpm deploy:dry-run

更改 wrangler.jsonc 后，运行 pnpm cf:typegen。

推送到 main 会运行相同的质量检查和部署试运行。暂存环境的部署需手动进行，也会在已签名的发布工作流中运行。发布版本会保持草稿状态，直到上一个稳定版本升级到精确匹配的已签名候选版本并通过检查。客户安装和更新会在部署前验证已签名清单和构件摘要。

文档

hqbase.io/docs 是用户和运维指南、产品规格以及维护者流程的公开来源。

贡献

提交拉取请求前，请阅读贡献指南。

安全

如需报告漏洞，请按照安全政策中的私密流程操作。

许可证

HQBase 仅依据 GNU Affero General Public License v3.0 提供。