This documentation page is a work in progress.

​
Runtime

​
OPENGB_HOSTNAME

Default: 127.0.0.1 Defines the hostname to listen on. Change this to 0.0.0.0 if you want to allow requests from outside of your machine.

​
OPENGB_PORT

Default: 6420

​
OPENGB_PUBLIC_ENDPOINT

Default: http://127.0.0.1:6420 The endpoint that this server can be connected to externally.

​
_OPENGB_LOG_SPILT_OBJECT

Experimental Set to 1 to enable logging some objects split in to individual keys.

​
_OPENGB_LOG_ERROR_STACK

Experimental Set to 1 to enable logging the full JavaScript stack trace for errors. This is different than trace.

​
_OPENGB_LOG_SCRIPT_BODY

Experimental Set to 1 to enable logging the body for script requests & responses. Intended primarily for debugging, since this may unintentionally expose sensitive data.

​
_OPENGB_LOG_ACTOR_BODY

Experimental Set to 1 to enable logging the body for actor requests & responses. Intended primarily for debugging, since this may unintentionally expose sensitive data.

​
_OPENGB_LOG_SQL_QUERIES

Experimental Set to 1 to enable logging SQL queries and the input parameters.

​
DATABASE_URL

Default: postgres://postgres:postgres@localhost:5432/postgres?sslmode=disable

​
CLI

​
VERBOSE

Experimental Enable detailed logging.

​
_OPENGB_ESBUILD_META

Experimental Set to 1 to print detailed information about the output bundle.

​
_OPENGB_ESBUILD_NO_MINIFY

Experimental Set to 1 to disable minifying the output bundle.

​
CLI & Runtime

​
OPENGB_TERM_COLOR

Default: unset Values:
  • never Never use color
  • always Always use color
Defines if logs are printed with color. By default, OpenGB attempts to automatically determine if your terminal supports this. This also respects NO_COLOR

​
NO_COLOR

See here