Bencher Compose

Der einfachste Weg, Bencher Self-Hosted bereitzustellen, ist die Verwendung eines Triptychons von bencher CLI-Unterbefehlen:

bencher up

Erstellen und starten Sie die Bencher Self-Hosted-Container. Dies ist ähnlich wie das Ausführen von docker compose up.

bencher up [OPTIONS] [SERVICE]

Service

Wählen Sie die Container aus, die ausgeführt werden sollen. Die möglichen Optionen sind: all, api und console. Standardmäßig ist all ausgewählt. Ähnlich dem SERVICE-Argument für docker compose up.

Optionen

--detach

Im getrennten Modus ausführen. Die Container werden im Hintergrund ausgeführt. Ähnlich wie das --detach Flag für docker compose up.

--pull <WHEN>

Zieht Images, bevor sie ausgeführt werden. Die möglichen Optionen sind: always, missing und never. Standardmäßig ist always ausgewählt. Ähnlich zur --pull Option für docker compose up.

--tag <TAG>

Geben Sie das Image-Tag für die Container an. Standardmäßig entspricht das Image-Tag der bencher CLI-Version. Die neueste bencher CLI-Version ist v0.4.36.

--console-port <PORT>

Geben Sie eine Portnummer für den Console-Servercontainer an. Standardmäßig wird Port 3000 verwendet. Ähnlich wie das Port-Only-Format der Option --expose für docker run.

--api-port <PORT>

Geben Sie eine Portnummer für den API-Server-Container an. Standardmäßig wird der Port 61016 verwendet. Ähnlich zur Port-only-Form der --expose-Option für docker run.

--console-env <KEY_VALUE>

Übergebe eine Umgebungsvariable an den Console-Server-Container. Das erwartete Format ist KEY=Wert. Dies kann nützlich sein, wenn man mit der Console Server-Konfiguration arbeitet. Ähnlich wie die Option --env für docker run.

--api-env <KEY_VALUE>

Eine Umgebungsvariable an den API-Server-Container übergeben. Das erwartete Format ist SCHLÜSSEL=Wert. Dies kann nützlich sein, wenn Sie mit der API-Server-Konfiguration arbeiten. Ähnlich wie die die --env-Option für docker run.

--console-volume <HOST_CONTAINER>

Übergeben Sie ein Mount-Volume an den Console-Server-Container. Das erwartete Format ist /host/path:/container/path. Dies kann nützlich sein, wenn Sie mit der Console Server-Konfiguration arbeiten. Ähnlich zur Option --volume für docker run.

--api-volume <HOST_CONTAINER>

Ein Volume-Mount an den API-Server-Container übergeben. Das erwartete Format ist /host/path:/container/path. Dies kann nützlich sein, wenn Sie mit der API-Server-Konfiguration arbeiten. Ähnlich wie die Option --volume bei docker run.

--help

Hilfe drucken.

bencher logs

Zeigen Sie die Ausgabe von den Bencher Self-Hosted Containern an, wenn bencher up mit dem --detach-Flag ausgeführt wurde. Dies ist ähnlich dem Ausführen von docker compose logs.

bencher up [OPTIONS] [SERVICE]

Dienst

Wählen Sie die zu startenden Container aus. Die möglichen Optionen sind: all, api und console. Standardmäßig ist all ausgewählt. Ähnlich dem SERVICE-Argument für docker compose logs.

Optionen

--help

Hilfe drucken.

bencher down

Stoppen und entfernen der Bencher Self-Hosted Container, wenn bencher up mit dem --detach-Flag ausgeführt wurde. Dies ist ähnlich wie das Ausführen von docker compose down.

bencher down [OPTIONS] [SERVICE]

Service

Wählen Sie die Container, die ausgeführt werden sollen. Die möglichen Optionen sind: all, api und console. Standardmäßig ist all ausgewählt. Ähnlich dem SERVICE Argument für docker compose down.

Optionen

--help

Hilfe drucken.

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