Console Server Config

The Bencher Console UI does not require any configuration. However, some defaults can be customized to suite your needs using the following environment variables:

• BENCHER_API_URL: The URL for the Bencher API server. By default, this is set to http://localhost:61016.
• INTERNAL_API_URL: When using Docker based networking, such as with docker compose, 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. By default, this is not set.
• OAUTH_GITHUB: Set to true to enable Login with GitHub using a Self-Hosted GitHub App. This requires a Bencher Plus Enterprise plan. By default, this is not set.
• OAUTH_GOOGLE: Set to true to enable Login with Google using a Self-Hosted Google OAuth2. This requires a Bencher Plus Enterprise plan. By default, this is not set.

HTTPS

By default, the Bencher Console server uses HTTP. This works well if you have a proxy server in front of it to handle HTTPS. If you need a standalone Console server to handle HTTPS itself then you need to provide an SSL key and certificate.

You can configure HTTPS using the following environment variables:

• SERVER_KEY_PATH: The file path to your TLS key.
• SERVER_CERT_PATH: The file path to your TLS certificate.

Console URL

By default, the Bencher API server expects the Bencher Console server to be running at http://localhost:3000. If your Bencher Console server is running elsewhere, then you need to set the console.url option.