Docker Compose デプロイ

このドキュメントでは、Docker Compose を使用して New API をデプロイする詳細な手順を説明します。

前提条件

• Docker および Docker Compose がインストール済みであること
• 推奨システム: Linux (Ubuntu/CentOS/Debian など)

Docker Compose を使用したデプロイ

方法1：Git でプロジェクトをクローンする（推奨）

GitHub に正常にアクセスできる場合は、この方法を推奨します。プロジェクトには完全な docker-compose.yml 設定ファイルが含まれています。

# 下载项目源码
git clone https://github.com/QuantumNous/new-api.git

# 进入项目目录
cd new-api

# 根据需要编辑 docker-compose.yml 文件
# 使用nano编辑器
nano docker-compose.yml
# 或使用vim编辑器
# vim docker-compose.yml

方法2：手動で設定ファイルを作成する

GitHub にアクセスできない、またはリポジリをクローンできない場合は、手動で設定ファイルを作成できます。

1. New API デプロイ用のディレクトリを作成します。

mkdir new-api
cd new-api

1. そのディレクトリ内に docker-compose.yml ファイルを作成します。

   Docker Compose 設定説明 ドキュメントの設定例を参考に、ご自身の要件に応じて選択してください。

   • 本番環境では完全な設定（MySQL と Redis を含む）の使用を推奨します。
   • テスト環境では簡略化された設定を使用できます。

2. テキストエディタを使用してファイルを作成します。

# 使用nano编辑器
nano docker-compose.yml

# 或使用vim编辑器
vim docker-compose.yml

選択した設定内容をこのファイルにコピーし、必要に応じてカスタマイズしてください。

サービスの起動

設定ファイルの準備ができたら、Git でクローンした場合でも手動で作成した場合でも、以下のコマンドを使用してサービスを起動できます。

# 使用Docker Compose启动服务
docker compose up -d

このコマンドは、必要なイメージを自動的にプルし、バックグラウンドでサービスを起動します。

ログの確認

• 全サービスのリアルタイムログ

docker compose logs -f

• 指定サービスのログ（例：new-api、mysql、redis）

docker compose logs -f new-api
docker compose logs -f mysql
docker compose logs -f redis

• 直近 N 行のみ表示

docker compose logs --tail=100 new-api

• 直近の一定期間内のログを表示

docker compose logs --since=10m new-api

• タイムスタンプを表示

docker compose logs -f -t new-api

• フォアグラウンドモードでのデバッグ（起動と同時にリアルタイムでログを出力）

docker compose up
# 或仅启动并跟随某个服务
docker compose up new-api

Ctrl+C を押してフォアグラウンドモードを終了します（対応するサービスが停止します）。バックグラウンドで実行するには -d を使用してください。

• サービスリスト/ステータスの表示

docker compose ps

• コンテナ名を使用してログを表示（container_name が設定されている場合、例：設定内の new-api）

docker logs -f new-api

サービスの停止

# 停止服务
docker compose down

システムへのアクセス

サービスの起動が成功したら、http://サーバーIP:3000 にアクセスすると、自動的に初期化ページにリダイレクトされます。ページの手順に従って、管理者アカウントとパスワードを手動で設定してください（初回インストール時のみ必要）。初期化が完了すると、設定した管理者アカウントでシステムにログインできるようになります。