stoatchat/self-hosted

这是什么？

核心功能

• 01通过 Docker Compose 一起部署后端、Web 前端、文件服务器以及元数据和图片代理。
• 02使用 generate_config.sh 生成密钥和 Revolt.toml 配置文件。
• 03支持自定义 S3 存储、邮箱验证、验证码以及移动端推送通知。
• 04提供反向代理、仅邀请注册及 NGINX 等配置指南。
• 05记录了升级步骤以及历史破坏性变更的迁移方法。

适用场景

• 在自有 VPS 上为社区或团队搭建私有聊天服务器。
• 在自己控制的域名下托管 Stoat 实例，数据和存储由自己掌控。
• 在更大范围部署前测试或评估 Stoat 技术栈。

快速上手

1. 1

   克隆仓库

   git clone https://github.com/stoatchat/self-hosted stoat
2. 2

   进入项目目录

   cd stoat
3. 3

   使用你的域名生成配置

   ./generate_config.sh your.domain
4. 4

   在后台启动实例

   docker compose up -d

使用前须知

• !需要一台安装了 Docker 并已将域名指向它的服务器，自托管需要一定的配置工作。
• !大多数官方客户端不支持自托管实例；网页客户端和 PWA 体验最好。
• !采用 AGPL-3.0 许可证，属于 Copyleft 许可证，对网络使用场景有源代码公开要求。

收录于专题

标签

常见问题

self-hosted 是什么？

基于 Docker 的 Stoat 聊天服务自部署配置，包含后端、Web 前端、文件服务与代理。 本仓库提供 Docker Compose 配置和分步说明，用于在自有服务器上运行完整的 Stoat 实例。部署内容包括后端、Web 前端、文件服务器，以及元数据和图片代理。

self-hosted 可以免费使用吗？用的什么许可证？

self-hosted 以 AGPL-3.0 许可证开源。用于商业产品前，请先确认许可证条款。

self-hosted 还在维护吗？

半年内有更新。self-hosted 最近一次提交是在 2026年10月7日。

self-hosted 适合用来做什么？

在自有 VPS 上为社区或团队搭建私有聊天服务器。 在自己控制的域名下托管 Stoat 实例，数据和存储由自己掌控。 在更大范围部署前测试或评估 Stoat 技术栈。

self-hosted 怎么安装和运行？

克隆仓库: git clone https://github.com/stoatchat/self-hosted stoat 进入项目目录: cd stoat 使用你的域名生成配置: ./generate_config.sh your.domain 在后台启动实例: docker compose up -d

在哪里获取 self-hosted？

源代码和安装说明在 GitHub 上：https://github.com/stoatchat/self-hosted