導入パスを選ぶ
公式イメージ・自前の runner プロジェクト・実例のどれで始めるかを決める
Crowi の本番構成は api (Hono) + web (Next.js) + MongoDB の 3 つが最小単位で、その前段に 1 つのオリジンを見せるリバースプロキシを置きます。どこまで自分で組むかによって、始め方は 4 通りあります。
どれで始めるか
| 導入パス | 向いている場合 | 手順 |
|---|---|---|
| 公式イメージ + 同梱の compose | 1 台のホストで動かす。最短で本番相当の構成にしたい | 公式イメージで動かす |
| 公式イメージ + 自前のプロキシ / オーケストレータ | 既存の nginx や Kubernetes に載せる。TLS も自分で終端する | 公式イメージで動かす → デプロイ構成 |
| 自前の runner プロジェクト | 公式イメージに入っていないプラグインを使う。ドライバの組み合わせを固定してイメージを自社でビルドする | セルフホスティング (自前の runner プロジェクト) |
| 実例をなぞる | 具体的なクラウド上の手順を通しで見たい | AWS Lightsail で動かす |
まず触ってみたいだけなら、サーバを立てずに クイックスタート の compose 構成で動かせます。
どの道でも必要になるもの
| 依存 | 必須か | 用途 |
|---|---|---|
| MongoDB | 必須 | ページ・リビジョン・ユーザーなどの保存先 |
| Redis | 単一インスタンスなら任意、複数レプリカでは必須 | レプリカ間の連携 (Redis のキーと ACL) |
| Elasticsearch / OpenSearch | 任意 | 全文検索。既定では MongoDB だけで検索できます (検索バックエンドのセットアップ) |
| S3 / GCS | 任意 | 添付ファイルの保存先。既定はローカルディスク (ストレージ設定) |
| SMTP / SES / Resend | 任意 | 招待メール・パスワード再設定メールの送信 (メール送信の設定) |
いずれも 環境変数 と crowi.config.json、および管理画面から指定します。