Skip to content

Installation

Haisu Zuo edited this page Oct 10, 2026 · 2 revisions

自托管安装与升级

这是自托管部署的文档入口。第一次安装可先按仓库 README 的 Compose 快速开始 完成数据库、Web 应用和 worker 的启动,再按本页检查长期运维要求。

版本说明

本项目以 AGPL-3.0 提供源码。设置 APP_EDITION=selfhost(默认值)时,可由使用者自行部署和运维;自托管版不要求购买、试用或订阅,也不会因商业订阅到期而停止服务,不继承云托管版的月度导出额度。自托管部署仍保留身份验证、租户隔离、审计、加密和安全写入保护。

自托管版不等于由 Crowntime 代管或提供运维服务。服务器、数据库、网络、密钥保管、备份、监控和升级由部署者负责。发行包和一键安装器是否提供,以仓库实际发布内容为准。

部署参考

请先阅读仓库根目录的 README、.env.example 和 部署参考。部署参考介绍当前版本的应用初始化、数据库迁移、环境变量、后台任务和健康检查;其中示例路径和服务配置仅供参考,部署者必须替换为自己的环境配置,不能复制任何其他环境的 .env 或凭据。

基本要求包括:

  • Python 3.11 及项目要求的系统依赖;
  • PostgreSQL 数据库和可用的持久化媒体存储;
  • 能安全保存企业微信及其他集成凭据的受控配置渠道;
  • HTTPS、访问控制、备份与恢复方案,以及定期安全更新。

Edition 与资源策略

  • APP_EDITION 只选择运行策略,不是许可证或源码可见性开关;仅接受 selfhost 和 cloud。
  • 自托管版没有云托管订阅的月度文本/媒体导出次数限制。部署者仍应根据本地磁盘、数据库和网络能力设置资源预算。
  • 自托管版默认不施加云托管套餐的存储额度;可按自身容量规划配置可选的存储保护上限。容量保护不会授权静默删除已归档数据。
  • 不要为了绕过付费策略关闭租户隔离、访问控制、审计或安全写入保护。

凭据和数据安全

企业微信 CorpID、Secret、回调 Token/AES Key、数据库连接串、邮件 API Key 和对象存储密钥都是敏感凭据。只写入部署者自己的受保护配置,不要提交到 Git、工单、聊天或日志;示例文件只应使用占位值。备份应加密,并定期演练恢复。

升级

  1. 阅读目标版本的发布说明和迁移说明。
  2. 确认数据库及媒体备份可用;在维护窗口按部署文档执行升级和数据库迁移。
  3. 部署后检查健康状态、迁移版本、后台任务和媒体读写。
  4. 保留可执行的回滚方案;不要对生产数据库直接运行未经审核的降级或删除操作。

云托管服务的价格、试用和商业配额不适用于自托管版。云托管套餐见「价格与套餐」;自托管版的具体部署结果取决于部署者自己的基础设施和运维措施。

Clone this wiki locally