Bencher Compose

La façon la plus simple de déployer Bencher en auto-hébergement est d’utiliser un triptyque de sous-commandes du CLI bencher :

bencher up

Créer et démarrer les conteneurs Bencher en auto-hébergement. Ceci est similaire à l’exécution de docker compose up.

bencher up [OPTIONS] [SERVICE]

Service

Sélectionnez les conteneurs à exécuter. Les choix possibles sont : all, api, et console. Par défaut, all est choisi. Semblable à l’argument SERVICE pour docker compose up.

Options

--detach

Exécuter en mode détaché. Les conteneurs seront exécutés en arrière-plan. Similaire au drapeau --detach pour docker compose up.

--pull <WHEN>

Tirez les images avant de les exécuter. Les choix possibles sont : always, missing, et never. Par défaut, always est choisi. Semblable à l’option --pull pour docker compose up.

--tag <TAG>

Spécifiez le tag de l’image pour les conteneurs. Par défaut, le tag de l’image correspond à la version du CLI bencher. La version la plus récente du CLI bencher est v0.5.4.

--console-port <PORT>

Spécifiez un numéro de port pour le conteneur du serveur Console. Par défaut, le port 3000 est utilisé. Semblable à la forme uniquement port de l’option --expose pour docker run.

--api-port <PORT>

Spécifiez un numéro de port pour le conteneur du serveur API. Par défaut, le port 61016 est utilisé. Similaire à la forme de port uniquement de l’option --expose pour docker run.

--console-env <KEY_VALUE>

Passez une variable d’environnement au conteneur du serveur Console. Le format attendu est KEY=value. Cela peut être utile lors de la configuration du serveur Console. Similaire à l’option --env pour docker run.

--api-env <KEY_VALUE>

Passez une variable d’environnement au conteneur du serveur API. Le format attendu est KEY=value. Cela peut être utile lors de l’utilisation de la configuration du serveur API. Similaire à l’option --env pour docker run.

--console-volume <HOST_CONTAINER>

Passez un volume de montage au conteneur du serveur Console. Le format attendu est /host/path:/container/path. Cela peut être utile lors du travail avec la configuration du serveur Console. Similaire à l’option --volume pour docker run.

--api-volume <HOST_CONTAINER>

Passez un volume de montage au conteneur du serveur API. Le format attendu est /host/path:/container/path. Cela peut être utile lors de l’utilisation de la configuration du serveur API. Similaire à l’option --volume pour docker run.

--help

Imprimer l’aide.

bencher logs

Afficher la sortie des conteneurs Bencher en auto-hébergement, si bencher up a été exécuté avec le drapeau --detach. Ceci est similaire à l’exécution de docker compose logs.

bencher up [OPTIONS] [SERVICE]

Service

Sélectionnez les conteneurs à exécuter. Les choix possibles sont : all, api et console. Par défaut, all est choisi. Similaire à l’argument SERVICE pour docker compose logs.

Options

--help

Imprimer l’aide.

bencher down

Arrêter et supprimer les conteneurs Bencher Self-Hosted, si bencher up a été exécuté avec l’option --detach. Ceci est similaire à l’exécution de docker compose down.

bencher down [OPTIONS] [SERVICE]

Service

Sélectionnez les conteneurs à exécuter. Les choix possibles sont : all, api, et console. Par défaut, all est choisi. Similaire à l’argument SERVICE pour docker compose down.

Options

--help

Imprimer l’aide.

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