Skip to content

Latest commit

 

History

History
207 lines (143 loc) · 5.05 KB

00_quickstart.md

File metadata and controls

207 lines (143 loc) · 5.05 KB

LabCode クイックスタートガイド

このガイドでは、LabCodeを最低限動かすための手順を説明します。

1. 事前準備

以下のソフトウェアがインストールされていることを確認してください:

  • Docker (v20.10以上)
  • Docker Compose (v2.0以上)
  • Git

2. セットアップ

Step 1: リポジトリのクローン

git clone --recurse-submodules <repository-url>
cd labcode-test-environment

Step 2: Dockerイメージのビルド

docker compose build

Step 3: コンテナの起動

docker compose up -d

起動完了まで数秒お待ちください。

3. 初回設定（必須）

新規インストールの場合、最初のユーザーを作成する必要があります。

curl -X POST "http://localhost:8000/api/users/" -d "email=your-email@example.com"

※ your-email@example.com を実際のメールアドレスに置き換えてください。

4. アクセス

サービス URL
Web UI http://localhost:5173
Admin Panel http://localhost:5173/admin
API (Swagger UI) http://localhost:8000/docs

5. 基本的な使い方

  1. ブラウザで http://localhost:5173 にアクセス
  2. Googleアカウントでログイン（作成したユーザーのメールアドレスで）
  3. Run Listページが表示されます

Admin Panelを使う

  1. 画面右上の「Admin」バッジをクリック
  2. ユーザー管理、プロジェクト管理、実験実行ができます

6. コンテナの操作

# 停止
docker compose down

# 再起動
docker compose restart

# ログ確認
docker compose logs -f

7. S3ストレージ設定（オプション）

S3を使用する場合は、以下の手順で設定してください。

Step 1: S3バケットの作成

  1. AWS Management Console にログイン
  2. サービス検索で「S3」を検索してS3コンソールを開く
  3. 「バケットを作成」をクリック
  4. 以下を設定:
    • バケット名: labcode-dev-artifacts（任意の名前に変更可）
    • リージョン: アジアパシフィック (東京) ap-northeast-1
    • パブリックアクセス: 「パブリックアクセスをすべてブロック」にチェック
  5. 「バケットを作成」をクリック

Step 2: IAMユーザーとアクセスキーの作成

  1. AWSコンソールで「IAM」を検索してIAMコンソールを開く
  2. 左メニューから「ユーザー」→「ユーザーを作成」
  3. ユーザー名: labcode-s3-user
  4. 「許可を設定」→「ポリシーを直接アタッチする」→「ポリシーを作成」
  5. 「JSON」タブで以下を貼り付け:
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "s3:GetObject",
                "s3:PutObject",
                "s3:DeleteObject",
                "s3:ListBucket"
            ],
            "Resource": [
                "arn:aws:s3:::labcode-dev-artifacts",
                "arn:aws:s3:::labcode-dev-artifacts/*"
            ]
        }
    ]
}
  1. ポリシー名: LabCodeS3Policy →「ポリシーを作成」
  2. 作成したポリシーをユーザーにアタッチして「ユーザーを作成」
  3. ユーザーを選択 →「セキュリティ認証情報」→「アクセスキーを作成」
  4. アクセスキーIDとシークレットアクセスキーをメモ

Step 3: 環境変数ファイルの作成

labcode-log-server/.env を作成:

AWS_ACCESS_KEY_ID=<取得したアクセスキーID>
AWS_SECRET_ACCESS_KEY=<取得したシークレットアクセスキー>
AWS_DEFAULT_REGION=ap-northeast-1
S3_BUCKET_NAME=labcode-dev-artifacts

Step 4: コンテナの再起動

docker compose down
docker compose up -d

詳細は S3ストレージ設定手順書 を参照してください。

8. トラブルシューティング

「Internal Error」が表示される

原因: ユーザーが作成されていない

解決策: Step 3の初回設定を実行してください。

curl -X POST "http://localhost:8000/api/users/" -d "email=your-email@example.com"

コンテナが起動しない

解決策:

# ログを確認
docker compose logs log_server

# 再ビルド
docker compose build --no-cache
docker compose up -d

ポートが使用中

解決策: 他のサービスが5173, 8000, 8888ポートを使用していないか確認してください。

lsof -i :5173
lsof -i :8000
lsof -i :8888

関連ドキュメント

詳細な情報については、以下のドキュメントを参照してください: