Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

DockerでのSpecForgeのセットアップ

このガイドでは、スタンドアロン実行ファイルの代わりにDockerを使用してSpecForgeをセットアップする方法を説明します。

前提条件

サーバーを起動する前に、有効なライセンスを取得して設定する必要があります。ライセンスをお持ちでない場合は、SpecForgeチームにご連絡いただくか、トライアルライセンスのリクエストをお願い致します。

1. Docker Composeファイルの取得

SpecForgeサーバーは、GHCR(GitHub Container Registry)を介してDockerイメージとして配布されています。Dockerイメージを実行する方法としては、Docker Composeを用いての実行を推奨します。

最新のdocker-compose-x.y.z.ymlファイルをSpecForgeリリースページからダウンロードしてください。

2. ライセンスの設定

SpecForgeサーバーには有効なライセンスファイルが必要です。ライセンスファイルをDockerコンテナで利用可能にする必要があります。

  1. license.jsonファイルをホストマシン上の既知の場所に配置します(例:~/.config/specforge/license.json)。

  2. docker-compose-x.y.z.ymlファイルの次の行を変更して、ライセンスファイルを指すようにします:

    - type: bind
      source: ~/.config/specforge/license.json # このパスがライセンスファイルを指すようにしてください
      target: /app/license.json # このパスは変更しないでください
      read_only: true
    

    注意: 多くの場合、dockerをrootとして、つまりsudoを使用して実行することが一般的です。その場合、~/で始まるパスはシステムによって/root/として解釈されます。混乱を避けるために、絶対パスを使用するか、dockerをrootとして実行しないようにすることができます。

3. LLMプロバイダーの設定(オプション)

自然言語による仕様生成やエラー説明などのLLMベースの機能を使用するには、サーバーを起動する前にdocker-compose.ymlファイルで環境変数を変更してLLMプロバイダーを設定します。

OpenAIの場合(推奨):

- LLM_PROVIDER=openai
- LLM_MODEL=gpt-5-nano-2025-08-07
- OPENAI_API_KEY=${OPENAI_API_KEY}

APIキーはplatform.openai.com/api-keysから取得できます。

APIキーを直接ファイルに挿入することもできますが、セキュリティのために環境変数を使用する方が推奨されます。

他のプロバイダー(Gemini、Ollama)および詳細な設定オプションについては、LLMプロバイダーの設定ガイドを参照してください。

4. サーバーの起動

次のコマンドを実行します。/path/to/docker-compose-x.y.z.ymlを、ダウンロードしたファイルへの実際のパスに置き換えてください:

docker compose -f /path/to/docker-compose-x.y.z.yml up --abort-on-container-exit

起動時にエラーが生じた場合にコンテナがすみやかに異常終了できるようにするために、--abort-on-container-exitフラグを付加しておくことを推奨します。

サーバーが起動していることを確認するには、http://localhost:8080/healthにアクセスして、バージョン情報が表示されることを確認してください。

注意: ライセンスが見つからないか無効な場合、サーバーはすぐに終了します。起動時に問題が発生した場合は、ライセンス設定を確認してください。

5. VSCode拡張機能のインストール

SpecForge VSCode拡張機能をVisual Studio Marketplaceからインストールするか、VSCode拡張機能セットアップガイドを参照してください。

Dockerイメージの更新

SpecForgeサーバーの新しいバージョンが定期的にリリースされます。最新バージョンは次のいずれかの方法で使用できます:

  1. リリースページから更新されたdocker-composeファイルを使用する、または

  2. Docker Composeファイルのimageフィールドをlatestに設定する

    image: ghcr.io/imiron-io/specforge/specforge-backend:latest
    

    その後、最新のイメージをプルします:

    docker compose -f /path/to/docker-compose.yml pull
    

次のステップ