Crowi

導入パスを選ぶ

公式イメージ・自前の runner プロジェクト・実例のどれで始めるかを決める

Crowi の本番構成は api (Hono) + web (Next.js) + MongoDB の 3 つが最小単位で、その前段に 1 つのオリジンを見せるリバースプロキシを置きます。どこまで自分で組むかによって、始め方は 4 通りあります。

どれで始めるか

導入パス向いている場合手順
公式イメージ + 同梱の compose1 台のホストで動かす。最短で本番相当の構成にしたい公式イメージで動かす
公式イメージ + 自前のプロキシ / オーケストレータ既存の nginx や Kubernetes に載せる。TLS も自分で終端する公式イメージで動かすデプロイ構成
自前の runner プロジェクト公式イメージに入っていないプラグインを使う。ドライバの組み合わせを固定してイメージを自社でビルドするセルフホスティング (自前の runner プロジェクト)
実例をなぞる具体的なクラウド上の手順を通しで見たいAWS Lightsail で動かす

まず触ってみたいだけなら、サーバを立てずに クイックスタート の compose 構成で動かせます。

どの道でも必要になるもの

依存必須か用途
MongoDB必須ページ・リビジョン・ユーザーなどの保存先
Redis単一インスタンスなら任意、複数レプリカでは必須レプリカ間の連携 (Redis のキーと ACL)
Elasticsearch / OpenSearch任意全文検索。既定では MongoDB だけで検索できます (検索バックエンドのセットアップ)
S3 / GCS任意添付ファイルの保存先。既定はローカルディスク (ストレージ設定)
SMTP / SES / Resend任意招待メール・パスワード再設定メールの送信 (メール送信の設定)

いずれも 環境変数crowi.config.json、および管理画面から指定します。

立ち上げたあとに読むもの

On this page