# クイックスタート

> 2 つのコマンドでセルフホスティングの Nodaro Community エディションを起動し、/setup ページで状態を確認します。生成するには、プロバイダーキーか Nodaro Cloud への接続を追加します。

Source: https://nodaro.ai/ja/docs/self-hosting/quickstart

**Community エディションのクイックスタート**では、2 つのコマンドだけで、何もない状態からセルフホスティングの Nodaro を起動できます。Docker Compose のスタックにはデータベース、ログイン機能、ストレージ、キューがそろっているため、クラウドのアカウント作成も、API キーの用意も、設定作業も必要ありません。必要なのは、Docker Compose v2 を含む Docker 24 以降です。

## Nodaro を起動する
### リポジトリをクローンしてスタックを起動する
```bash
git clone https://github.com/nodaroai/app.nodaro.ai.git nodaro
cd nodaro
docker compose -f docker-compose.community.yml up
```

初回起動では、ビルド済みのアプリのイメージ（約 2.4 GB）と、同梱のサービスをダウンロードします。行うのはダウンロードで、コンパイルではないため、CPU に負荷はかかりません。2 回目以降の起動は数秒で終わります。

### アプリを開いてアカウントを作成する
`http://localhost:3000` を開き、任意のメールアドレスとパスワードでアカウントを登録します。ローカルのスタックは確認メールを送らないため、アカウントはすぐに使えます。

初めてアクセスすると、ホーム画面に **Welcome Demo** ワークフローが追加されます。脚本、画像、動画、音声、最終編集までの実行が完了していて、すべての結果がそろったワークフローです。何も設定しなくても、ノードを開いたり、完成したクリップを再生したりできます。

### /setup で環境を確認する
`http://localhost:3000/setup` を開きます。このページには、データベース、Redis、ストレージ、暗号化キー、プロバイダーキーの現在の状態が表示されます。ログインは必要ありません。起動したばかりのスタックでは、プロバイダーキー以外のカードはすべて緑色です。

### モデルプロバイダーを追加する
下の 3 つの方法から 1 つを選びます。プロバイダーを追加したら、デモの **Scene Image** ノードで**実行**をクリックします。このノードは最も安い画像モデルである [Z-Image](https://nodaro.ai/docs/models/image/z-image) を使い、数秒で結果を返します。

## 起動するサービス
| サービス | 役割 | データの保存場所 |
| --- | --- | --- |
| **Postgres**（Supabase のイメージ） | データベース。マイグレーションは初回起動時に自動で適用されます。 | `db-data` ボリューム |
| **GoTrue** | メールアドレスとパスワードによるログイン。メールサーバーは必要ありません。 | — |
| **PostgREST** | エディターが通信するデータ API | — |
| **MinIO** | メディアのストレージ。生成された画像、動画、オーディオは自分のディスクに保存されます。 | `minio-data` ボリューム |
| **Redis** | ジョブキュー | `redis-data` ボリューム |
| **Nodaro** | アプリ：エディター、API、ワーカー（ポート `3000`） | `app-data` ボリューム |

スタックがマシン上で公開するポートは 2 つです。アプリ用の `3000` と、MinIO コンソール用の `9001`（ループバックインターフェースのみ）です。

## モデルプロバイダーを追加する
デモの閲覧は無料で、オフラインでも動作します。自分でノードを実行するには、環境にモデルプロバイダーが必要です。プロバイダーが追加されるまで、ホーム画面には「**このインストールではまだ生成できません**」という、閉じることのできる案内が表示され、方法ごとのボタンが並びます。

3 つの方法は併用できますが、ルールが 1 つあります。環境が Nodaro Cloud に接続されていて、`NODARO_API_KEY` も設定されている場合は、接続が使われ、キーは無視されます。

**キーを貼り付ける**

ファイルの編集も再起動も必要ありません。

1. `/setup` を開き、ステップ 1 の**サーバーのログインアカウントを作成**を完了します。状態カードの表示にログインは必要ありませんが、キーの保存にはログインが必要です。
2. **インストールの状態**セクションで、プロバイダーのタイルを探します。同じタイルは、アプリの**連携 › モデルプロバイダー**にもあります。
3. タイルの**キーを貼り付け**をクリックし、キーを貼り付けて保存します。

各タイルには、そのキーで使えるようになる機能と、キーの入手先が表示されます。キーは暗号化されて自分のデータベースに保存され、すぐに有効になります。Nodaro Cloud に接続する場合は、どのタイルも設定する必要はありません。接続がそれらをカバーします。

**Nodaro Cloud に接続する**

キーを管理する必要はありません。

1. `/setup` のステップ 2、**モデルプロバイダーを接続**で、**nodaro.ai を接続**をクリックします。
2. ブラウザーで Nodaro Cloud の同意画面が開きます。ログインするか、1,500 クレジット付きの無料アカウントを作成して、接続を承認します。
3. 接続された状態で、環境に戻ります。

以降、画像、動画、音声、テキストのモデルは Nodaro Cloud アカウントを通じて実行され、クレジットで請求されます。詳しくは、[Nodaro Cloud への接続](https://nodaro.ai/docs/self-hosting/cloud-connect)を参照してください。

**.env に設定する**

Infrastructure as Code で管理する場合の方法です。Compose ファイルと同じ場所に、`.env` という名前のファイルを作成します。

```bash
KIE_API_KEY=...            # broadest model coverage
# or
REPLICATE_API_TOKEN=...
# or
NODARO_API_KEY=...         # a personal API token from app.nodaro.ai, Settings › API Tokens
```

次に、設定を反映します。

```bash
docker compose -f docker-compose.community.yml up -d
```

`.env` のキーは、画面で貼り付けたキーより優先されます。そのタイルには `set (env)` と表示され、その場では編集できません。

すべてのプロバイダーと、それぞれで使える機能については、[プロバイダーキー](https://nodaro.ai/docs/self-hosting/provider-keys)を参照してください。

料金はプロバイダーに直接支払います。Community エディションには、クレジットの仕組みも、Nodaro の手数料も、ウォーターマークもありません。

## 無料でエディターを学ぶ
ホーム画面の**チュートリアル**には、初回起動時に追加されるガイド付きウォークスルーのセットが、はじめから用意されています。閲覧は無料です。画像、動画、オーディオは Nodaro の CDN から読み込まれるため、インターネット接続が必要です。[チュートリアルとテンプレート](https://nodaro.ai/docs/get-started/tutorials-and-templates)を参照してください。

## コマンドラインで環境を確認する
`/setup` よりも詳しく確認するには、クローンしたリポジトリでコントラクトプローブを実行します。Node.js が必要です。

```bash
node tools/community-smoke.mjs http://localhost:3000
```

プローブは、使い捨てのアカウントを登録し、ワークフローを作成し、生成を送信して、ジョブが最終状態になるまで追跡し、どのチェックに合格したかを報告します。すでにプロバイダーキーを追加している場合など、環境に当てはまらないチェックは、スキップとして報告されます。フラグを追加しなければ、プローブが料金を発生させることはありません。

実際の生成もテストするには、`--keyed` を付けます。

```bash
node tools/community-smoke.mjs http://localhost:3000 --keyed
```

`--keyed` を使うには、環境に `KIE_API_KEY` か `REPLICATE_API_TOKEN` が必要です。`.env` で設定しても、`/setup` で貼り付けてもかまいません。プローブは、そのキーで使える最も安いモデルで生成を 1 回実行します。`KIE_API_KEY` なら [Z-Image](https://nodaro.ai/docs/models/image/z-image)、`REPLICATE_API_TOKEN` なら [Flux 2 Klein](https://nodaro.ai/docs/models/image/flux-2-klein-open) です。プロバイダーでの費用は、通常 1 セント未満です。そのあと、メディアが環境自身のストレージに保存されたことを確認します。Nodaro Cloud への接続やトークンは、別途チェックされます。

## よく使うコマンド
| 作業 | コマンド |
| --- | --- |
| バックグラウンドで起動する | `docker compose -f docker-compose.community.yml up -d` |
| ログを表示し続ける | `docker compose -f docker-compose.community.yml logs -f` |
| スタックを停止する | `docker compose -f docker-compose.community.yml down` |
| 変更した `.env` を反映する | `docker compose -f docker-compose.community.yml up -d` |

意図して行う場合を除き、`down` に `-v` を付けないでください。`docker compose down -v` はボリュームを削除し、それとともにデータベースとメディアも失われます。

**ほかの人がアクセスできるようにする前に:** 
Compose のデフォルト値はローカルでの利用を前提としたもので、その内容は公開されています。スタックをネットワークに公開する前に、新しい認証キーを発行し、データベースとストレージのパスワードを変更して、環境を HTTPS で配信してください。手順は、[環境のセキュリティを強化する](https://nodaro.ai/docs/self-hosting/install#harden-the-install-before-you-expose-it)と[リバースプロキシと HTTPS](https://nodaro.ai/docs/self-hosting/reverse-proxy) を参照してください。

## 次のステップ
- [インストール](https://nodaro.ai/docs/self-hosting/install)：マネージドサービス、ストレージ、シークレットを含む、完全なセットアップ手順です。
- [リバースプロキシと HTTPS](https://nodaro.ai/docs/self-hosting/reverse-proxy)：自分のドメインで環境を配信します。
- [アップデート](https://nodaro.ai/docs/self-hosting/updating)：イメージのタグとアップデートについて説明します。
- [バックアップと復元](https://nodaro.ai/docs/self-hosting/backups)：バックアップも復元も、コマンド 1 つで実行できます。
- [トラブルシューティング](https://nodaro.ai/docs/self-hosting/troubleshooting)：`/setup` のカードが赤いときに参照します。

## Frequently asked questions

### セルフホスティングの Nodaro は、初回の起動にどのくらい時間がかかりますか？

初回起動では、ビルド済みのアプリのイメージ（約 2.4 GB）と同梱のサービスをダウンロードするため、一般的な回線で数分かかります。行うのはダウンロードで、コンパイルではありません。2 回目以降の起動は数秒で終わります。

### Community エディションを動かすのに、.env ファイルは必要ですか？

いいえ。docker-compose.community.yml のすべての値には、そのまま動くデフォルト値があります。.env ファイルを作成するのは、プロバイダーキーを追加する場合、公開 URL を変更する場合、自分で用意したマネージドサービスを使う場合だけです。

### 新しい環境で何も生成できないのはなぜですか？

モデルプロバイダーがまだないためです。/setup でプロバイダーキーを貼り付けるか、.env でキーを設定するか、環境を Nodaro Cloud アカウントに接続してください。プロバイダーが追加されるまで、ホーム画面には両方の方法を示す案内が表示されます。

### デフォルトのままの環境を、インターネットに公開しても安全ですか？

いいえ。Compose ファイルにあるデフォルトのキーとパスワードは公開されています。ほかの人がアクセスできるようにする前に、新しい認証キーを発行し、パスワードを変更して、リバースプロキシの背後で HTTPS で配信してください。

### Community エディションの料金はいくらですか？

Nodaro への支払いはありません。クレジットの仕組みも、Nodaro の手数料も、ウォーターマークもありません。モデルプロバイダーに直接支払うか、Nodaro Cloud への接続を通じて実行した分をクレジットで支払います。
