クイックスタート

Crowi を手元で動かし、管理者アカウントを作って最初のページを書くまでの手順です。所要時間はおよそ 5 分。必要なのは Docker と Docker Compose、そして git だけです。

1. 起動する

リポジトリを取得し、環境変数ファイルを用意して、アプリごとまとめて起動します。

git clone https://github.com/crowi/crowi.git
cd crowi
cp .env.example .env
docker compose --profile app up -d --build

--profile app は Crowi 本体 (api / web) と前段のリバースプロキシに加えて、MongoDB・Redis・Elasticsearch・メール確認用の Mailpit をまとめて起動します。初回はイメージのビルドが走るため数分かかります。

起動したらブラウザで http://localhost:4302 を開いてください。これが唯一の入口です。リアルタイム共同編集や通知の WebSocket は前段のプロキシ経由でのみつながるため、他のポートを直接開かないでください。

2. 管理者アカウントを作る

初回アクセスではインストーラ画面が表示されます。ここで作るユーザーがそのまま 最初の管理者 になります。サイト名・ユーザー名・メールアドレス・パスワードを入力して進めてください。

3. 最初のページを書く

ヘッダの「新規」からページを作成します。パスは / 区切りの階層で、/dev/api/setup のように書くだけで階層ができます (フォルダを先に作る必要はありません)。

本文は Markdown で書きます。表・チェックリスト・コードブロックのほか、[[ページ名]] で他のページへリンクできます。書ける記法は Markdown 記法 にまとめてあります。

保存すると履歴が 1 件残ります。過去の版との差分を見たり、任意の版に戻したりできます (リビジョンとロールバック)。

4. チームを招待する

管理画面 (/admin) の「ユーザー管理」でメールアドレスを入力すると、招待メールが届きます。招待されたユーザーはメール内のリンクからユーザー名とパスワードを決めて参加します。

メールを送るには送信設定が必要です。手元での確認だけなら、--profile app で一緒に起動している Mailpit を宛先にできます。管理画面のプラグイン設定で SMTP の送信先をホスト mailpit・ポート 1025 (認証なし) にすると、送られたメールが Mailpit の受信箱 (http://localhost:8025) に溜まります。実際のメール送信の設定は メール送信の設定 を参照してください。

5. 入口になるページを作る

末尾が / で終わるパス (例: /dev/) は ポータルページ と呼ばれ、本文と一緒にその配下のページ一覧が表示されます。チームやプロジェクトごとにポータルを 1 枚作っておくと、そこが入口になります。

ルートの / もポータルです。ここに全体の案内を書いておくと、参加した人が最初に読む場所になります。

次のステップ

• ページの作成と編集 — パスの考え方・公開範囲・ポータル
• Markdown 記法 — 書ける記法の一覧
• 検索 — ページを探す
• 導入パスを選ぶ — チームで使うサーバを立てる