Skip to content

Backend

Minimal

API_PREFIX

Optional, default value: /brickapi/v1

DOCS_URL

Optional, default value: /brickapi/v1/docs

OPENAPI_URL

Optional, default value: /brickapi/v1/openapi.json

REDOC_URL

Optional, default value: /brickapi/v1/redoc

OPENAPI_PREFIX

Optional, default value: ``

SERVER_HOST

Optional, default value: 0.0.0.0

Bind socket to this host.

SERVER_PORT

Optional, default value: 9000

Bind socket to this port. If 0, an available port will be picked

SERVER_WORKERS

Optional, default value: 1

Number of worker processes.

FRONTEND_URL

Optional, default value: /brickapi/v1/docs

URL to frontend. Usually used for auth redirection.

CACHE

Optional, default value: True

Enable caching.

Brick

BRICK_VERSION

Optional, default value: 1.3

Brick version used.

DEFAULT_BRICK_URL

Optional, default value: https://brickschema.org/schema/Brick

Brick schema URL.

DEFAULT_REF_SCHEMA_URL

Optional, default value: https://gist.githubusercontent.com/tc-imba/714c2043e893b1538406a9113140a4fe/raw/2fa8df840f3e4f1deb647b14fe524976f004e321/ref-schema.ttl

Ref schema URL.

Playground

DEFAULT_ADMIN

Optional, default value: example@gmail.com

The email of default admin user. (deprecated, we should remove it in future version)

ISOLATED_NETWORK_NAME

Optional, default value: isolated_nw

The name of the isolated network in docker.

DOCKER_PREFIX

Optional, default value: sbos-playground

The docker prefix to use in app containers.

APP_STATIC_DIR

Optional, default value: app_static

The directory to save app static files.