Конфигурация API сервера

Бенчер API сервер требует настройки в формате JSON при запуске. Конфигурация может быть предоставлена тремя способами:

• BENCHER_CONFIG переменная окружения: Значение должно быть установлено на конфигурацию в формате JSON
• BENCHER_CONFIG_PATH переменная окружения: Значение должно быть установлено на путь к файлу, содержащему конфигурацию JSON
• Файл, содержащий конфигурацию на JSON, расположенный в ./bencher.json, относительно исполняемого файла сервера

Если конфигурация не найдена, загружается конфигурация по умолчанию.

Чтобы обновить конфигурацию во время работы сервера, администратор может использовать команду CLI bencher server config update, которая обращается по маршруту PUT /v0/server/config. Все обновленные конфигурации сохраняются в переменной окружения BENCHER_CONFIG и на диске по пути BENCHER_CONFIG_PATH.

Пример конфигурации JSON:

{
  "console": {
    "url": "https://bencher.example.com"
  },
  "security": {
    "issuer": "https://api.bencher.example.com",
    "secret_key": "UJu7Cpxb-zFaJYqXD-3mDDSDyj-ZvfxZFZs-X58xjxPy"
  },
  "server": {
    "bind_address": "0.0.0.0:61016",
    "request_body_max_bytes": 1048576,
    "tls": {
      "type": "as_file",
      "cert_file": "/path/to/cert.pem",
      "key_file": "/path/to/key.pem"
    }
  },
  "logging": {
    "name": "Bencher API",
    "log": {
      "stderr_terminal": {
        "level": "info"
      }
    },
  },
  "database": {
    "file": "/var/lib/bencher/data/bencher.db",
    "data_store": {
      "service": "aws_s3"
      "access_key_id": "ABC123DoRemMiABC123",
      "secret_access_key": "AA3Chr-JSF5sUQqKwayx-FvCfZKsMev-5BqPpcFC3m7",
      "access_point": "arn:aws:s3:some-region-1:123456789:accesspoint/my-bucket/path/to/backup/dir"
    }
  },
  "smtp": {
    "hostname": "mailbonobo.com",
    "port": 587,
    "starttls": true,
    "username": "bencher"
    "secret": "WM3F2u9cqSNdBPLfy9sJ5kk9",
    "from_name": "Bencher",
    "from_email": "info@bencher.example.com"
  },
  "plus": {
    "disaster_recovery": {
      "replicas": [
        {
          "scheme": "s3",
          "bucket": "my-bucket",
          "path": "path/to/replicate",
          "access_key_id": "ABC123DoRemMiABC123",
          "secret_access_key": "AA3Chr-JSF5sUQqKwayx-FvCfZKsMev-5BqPpcFC3m7"
        }
      ]
    },
    "stats": {
      "offset": 11242,
      "enabled": true
    }
  }
}

console

security

server

Этот раздел основан на конфигурации сервера Dropshot.

logging

Этот раздел основан на конфигурации журнала Dropshot.

database

smtp

В этом разделе указывается конфигурация сервиса SMTP. Весь раздел является необязательным. Если он не указан, все сообщения будут отправляться в logging.

plus

Этот раздел посвящен функциям, которые покрываются лицензией Bencher Plus.

plus.github

В этом разделе указывается конфигурация приложения GitHub, используемого для аутентификации OAuth2. У вас должна быть действующая лицензия Bencher Plus Enterprise для хотя бы одной организации на сервере. Весь раздел является необязательным. Если он не указан, то аутентификация с помощью GitHub не будет включена.

plus.stats

В этом разделе указывается, собираются ли и когда статистические данные сервера. Весь раздел является необязательным. Если он не указан, будут использованы перечисленные значения по умолчанию. То есть, статистика сервера собирается, если вы на это не отказываетесь. Установите значение enabled в false, чтобы отключить сбор статистики сервера.