Bencher Compose

A maneira mais fácil de implantar o Bencher Self-Hosted é usando um tríptico de subcomandos do bencher CLI:

bencher up

Crie e inicie os contêineres Bencher Self-Hosted. Isso é semelhante a executar docker compose up.

bencher up [OPTIONS] [SERVICE]

Serviço

Selecione os contêineres para executar. As opções possíveis são: all, api e console. Por padrão, all é escolhido. Semelhante ao argumento SERVICE para docker compose up.

Opções

--detach

Execute em modo destacado. Os contêineres serão executados em segundo plano. Semelhante à flag --detach para docker compose up.

--pull <WHEN>

Puxa as imagens antes de executar. As opções possíveis são: always, missing e never. Por padrão, always é escolhido. Semelhante à opção --pull para docker compose up.

--tag <TAG>

Especifique a tag da imagem para os containers. Por padrão, a tag da imagem corresponde à versão do CLI bencher. A versão mais recente do CLI bencher é v0.5.6.

--console-port <PORT>

Especifique um número de porta para o container do servidor do Console. Por padrão, a porta 3000 é utilizada. Semelhante à forma apenas de porta da opção --expose para o docker run.

--api-port <PORT>

Especifique um número de porta para o contêiner do servidor API. Por padrão, a porta 61016 é usada. Semelhante à forma apenas de porta da opção --expose para docker run.

--console-env <KEY_VALUE>

Passe uma variável de ambiente para o contêiner do servidor Console. O formato esperado é KEY=value. Isso pode ser útil ao trabalhar com a configuração do Servidor Console. Semelhante à opção --env para docker run.

--api-env <KEY_VALUE>

Passe uma variável de ambiente para o contêiner do servidor de API. O formato esperado é KEY=value. Isso pode ser útil ao trabalhar com a configuração do Servidor de API. Semelhante à opção --env para docker run.

--console-volume <HOST_CONTAINER>

Passe um volume de montagem para o contêiner do servidor Console. O formato esperado é /host/path:/container/path. Isso pode ser útil ao trabalhar com a configuração do Servidor Console. Semelhante à opção --volume para docker run.

--api-volume <HOST_CONTAINER>

Transfira um volume de montagem para o contêiner do servidor API. O formato esperado é /host/path:/container/path. Isso pode ser útil ao trabalhar com a configuração do Servidor API. Semelhante à opção --volume para docker run.

--help

Imprimir ajuda.

bencher logs

Visualize a saída dos contêineres do Bencher Self-Hosted, se bencher up foi executado com a flag --detach. Isso é semelhante a executar docker compose logs.

bencher up [OPTIONS] [SERVICE]

Serviço

Selecione os contêineres para executar. As opções possíveis são: all, api e console. Por padrão, all é escolhido. Semelhante ao argumento SERVICE para docker compose logs.

Opções

--help

Imprimir ajuda.

bencher down

Pare e remova os contêineres do Bencher Self-Hosted, se bencher up foi executado com a flag --detach. Isso é semelhante a executar docker compose down.

bencher down [OPTIONS] [SERVICE]

Serviço

Selecione os contêineres para executar. As opções possíveis são: all, api e console. Por padrão, all é escolhido. Semelhante ao argumento SERVICE para docker compose down.

Opções

--help

Imprimir ajuda.

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