Repolode
stoatchat

stoatchat/self-hosted

バックエンド、Webフロントエンド、ファイルサーバー、プロキシを含むStoatの完全なセルフホスト環境を構築するDockerベースの設定。

代替できる製品:Discord

スター
2,682
フォーク
302
未解決の Issue
20
最終コミット
先月

これは何?

このリポジトリには、自分のサーバーで完全なStoatインスタンスを動かすためのDocker Compose設定と、手順を追ったガイドが用意されています。デプロイには、バックエンド、Webフロントエンド、ファイルサーバー、メタデータおよび画像用プロキシが含まれます。

セットアップの中心となるのはgenerate_config.shスクリプトです。必要なシークレットをsecrets.envファイルに生成し、Revolt.toml設定ファイルを作成します。このファイルは、メール認証、captcha、独自のS3サーバー、iOSおよびAndroidのプッシュ通知などの設定に合わせて編集できます。ガイドでは、Ubuntu VPSの用意、ファイアウォールルールの設定、ドメインのサーバーへの割り当て、Dockerのインストールまでを説明しています。また、別のリバースプロキシの背後にインスタンスを配置する方法、古いハードウェアやARMハードウェアでMongoDBのバージョンを固定したりKeyDBをValkeyまたはRedisに置き換えたりする方法、既存のデプロイを更新する方法も、任意の項目として扱っています。

公式クライアントのほとんどは、まだセルフホストインスタンスに対応していません。そのため、PWAとしての利用も含め、主なアクセス手段はWebクライアントです。

主な機能

  • 01バックエンド、Webフロントエンド、ファイルサーバー、メタデータ/画像用プロキシをDocker Composeでまとめてデプロイできます。
  • 02generate_config.shでシークレットとRevolt.toml設定ファイルを生成します。
  • 03独自のS3ストレージ、メール認証、captcha、モバイルプッシュ通知に対応しています。
  • 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を実行でき、ドメイン名が割り当てられたサーバーが必要なため、セルフホスティングにはセットアップの手間がかかります。
  • 公式クライアントの多くはセルフホストインスタンスに対応していません。WebクライアントとPWAが最も快適に動作します。
  • AGPL-3.0ライセンス(コピーレフト)で提供されており、ネットワーク経由での利用時にソースコードの開示が求められます。

収録されている特集

トピック

よくある質問

self-hosted とは?
バックエンド、Webフロントエンド、ファイルサーバー、プロキシを含むStoatの完全なセルフホスト環境を構築するDockerベースの設定。 このリポジトリには、自分のサーバーで完全なStoatインスタンスを動かすためのDocker Compose設定と、手順を追ったガイドが用意されています。デプロイには、バックエンド、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

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト