Bencher コンポーズ

Bencher Self-Hostedをデプロイする最も簡単な方法は、bencher CLIのサブコマンド3つを使用することです：

bencher up: Bencher Self-Hostedのコンテナを起動します。これはdocker compose upを実行するのと似ています。
bencher logs: --detachフラグを付けたbencher upが実行された場合、Bencher Self-Hostedコンテナの出力を表示します。これはdocker compose logsを実行するのと似ています。
bencher down: --detachフラグを付けたbencher upが実行された場合、Bencher Self-Hostedのコンテナを停止して削除します。これはdocker compose downを実行するのと似ています。

`bencher up`

Bencher セルフホスト型コンテナを作成して開始します。これは docker compose up を実行するのと似ています。

bencher up [OPTIONS] [SERVICE]

サービス

実行するコンテナを選択します。選択肢は、all、api、および console です。デフォルトでは all が選択されます。 docker compose up の SERVICE 引数に類似しています。

オプション

`--detach`

デタッチモードで実行します。コンテナはバックグラウンドで実行されます。 docker compose upの--detachフラグと似ています。

`--pull <WHEN>`

実行する前にイメージをプルします。選択肢は always、missing、never です。デフォルトでは always が選ばれます。 docker compose up の --pull オプションに似ています。

`--tag <TAG>`

コンテナのイメージタグを指定します。デフォルトでは、イメージタグは bencher CLI のバージョンと一致します。最新の bencher CLI のバージョンは v0.5.6 です。

`--console-port <PORT>`

Consoleサーバーコンテナのポート番号を指定します。デフォルトでは、ポート3000が使用されます。 docker runの--exposeオプションのポートのみの形式と類似しています。

`--api-port <PORT>`

APIサーバーコンテナのポート番号を指定します。デフォルトでは、ポート61016が使用されます。 docker runの --exposeオプションのポートのみの形式に似ています。

`--console-env <KEY_VALUE>`

環境変数をコンソールサーバーコンテナに渡します。期待されるフォーマットは KEY=value です。コンソールサーバーの設定で作業する際に役立ちます。 docker run の --env オプションと似ています。

`--api-env <KEY_VALUE>`

環境変数をAPIサーバーコンテナに渡します。期待されるフォーマットはKEY=valueです。これはAPIサーバー設定を扱う際に便利です。docker runの --envオプションと似ています。

`--console-volume <HOST_CONTAINER>`

マウントボリュームをコンソールサーバーコンテナに渡します。期待される形式は /host/path:/container/path です。これは、コンソールサーバーの設定を操作する際に役立ちます。docker run の --volume オプションと似ています。

`--api-volume <HOST_CONTAINER>`

APIサーバーコンテナにマウントボリュームを渡します。期待される形式は /host/path:/container/path です。これはAPIサーバーの設定を扱う際に便利です。 docker run の --volume オプションに似ています。

`--help`

ヘルプを表示します。

`bencher logs`

Bencherセルフホスト型コンテナからの出力を表示します。もしもbencher upが --detach フラグを使用して実行された場合です。これはdocker compose logsを実行することに似ています。

bencher up [OPTIONS] [SERVICE]

サービス

実行するコンテナを選択します。選択可能なオプションは、all、api、および console です。デフォルトでは all が選択されています。 docker compose logs の SERVICE 引数と似ています。

オプション

`--help`

ヘルプを表示します。

`bencher down`

Bencherのセルフホスティングコンテナを停止し、削除します。ただし、 --detach フラグと共にbencher upを実行した場合に限ります。これはdocker compose downを実行するのと類似しています。

bencher down [OPTIONS] [SERVICE]

サービス

実行するコンテナを選択します。選択肢は all、api、console です。デフォルトでは all が選択されます。 docker compose down の SERVICE 引数に似ています。

オプション

`--help`

ヘルプを表示します。

Docker Compose

services:
  bencher_api_compose:
    image: ghcr.io/bencherdev/bencher-api:latest
    container_name: bencher_api
    ports:
      - 61016:61016
    volumes:
      # Mount the configuration directory
      - "./services/api/etc:/etc/bencher"
      # Mount the database directory
      - "./services/api/data:/var/lib/bencher/data"
    # environment:
      # Set configuration string or file path
      # - BENCHER_CONFIG=
      # - BENCHER_CONFIG_PATH=

  bencher_console_compose:
    image: ghcr.io/bencherdev/bencher-console:latest
    container_name: bencher_console
    ports:
      - 3000:3000
    environment:
      # Set the API URL to the localhost IPv4 address
      - BENCHER_API_URL=http://127.0.0.1:61016
      # This is needed for Docker-to-Docker communication when using a local `BENCHER_API_URL`
      # Do not set this when using a remote `BENCHER_API_URL`, such as https://bencher.example.com
      - INTERNAL_API_URL=http://host.docker.internal:61016
    depends_on:
      - bencher_api_compose

Published: Sun, February 16, 2025 at 9:33:00 PM UTC