Skip to main content
Version: DeepHub 2024 R2 - 2.6.0

Configuration

The two DeepHub UIs can be configured via environment variables. Typically, these are defined in the docker-compose.yml file used to start and orchestrate the overall system with the DeepHub container, the DeepHub UI containers, and the Apache reverse proxy container.

The environment variables address different aspects:

  • Basic setup
  • OpenID settings
  • Mapping provider settings

See the sections below for details.

Basic Setup​

DEEPHUB_ROOT_URL​

The base path where the DeepHub's REST API endpoints and the WebSocket API can be reached.

The actual pathes are then

  • DEEPHUB_ROOT_URL/v2 for the REST API endpoints and
  • DEEPHUB_ROOT_URL/v2/ws/socket for the WebSocket API.

DEEPHUB_WEBSOCKET_URL​

Usually not set because the URL and path can be derived automatically from the DEEPHUB_ROOT_URL. See above.

  • Expected value type: string
  • Optional
  • Default: empty

NGINX_BASE_HREF​

The base href that the nginx web server should use for serving the DeepHub UI.

  • Expected value type: string
  • Optional
  • Default: /

NGINX_UPLOAD_MAX_FILESIZE​

Flag for the used nginx web server: The upload file size limit for a single file. This is relevant for the floorplan image upload feature. The default is set to 100 MB.

note

Use this parameter together with the following one. Both should be in-sync concerning the chosen file size limits!

  • Expected value type: string
  • Optional
  • Default: 100M

ROCKET_LIMITS​

Flag for the used nginx web server: rate limits. This is relevant for the floorplan image upload feature. The default is set to 100 MB.

  • Expected value type: string
  • Optional
  • Default: {form=100MB,file=100MB,data-form=100MB}

OpenID Settings​

note

The OpenID setup only works if all three variables are set. If none are set, OpenID functionality is completely switched off.

DEEPHUB_AUTH_ISSUER​

When using OpenID, this is the URL that reaches the OpenID server to authenticate the user.

  • Expected value type: string
  • Optional
  • Default: empty

DEEPHUB_AUTH_CLIENT_ID​

When using OpenID, this is the CLIENT ID with which the DeepHub UI identifies itself.

  • Expected value type: string
  • Optional
  • Default: empty

DEEPHUB_AUTH_REQUIRE_HTTPS​

Defines whether https is required. The default value is remoteOnly which only allows http for localhost, while every other domain would need to be used with https. Other allowed values are true and false.

  • Expected value type: string
  • Optional
  • Default: remoteOnly

Mapping Provider Settings​

DEEPHUB_MAP_PROVIDER​

The provider of the background mapping service. Supported values: mapbox and maptiler.

  • Expected value type: string
  • Optional
  • Default: maptiler

DEEPHUB_MAP_ACCESS_TOKEN​

Your personal access token from a mapping service provider.

  • Expected value type: string
  • Optional
  • Default: empty

DEEPHUB_MAP_DEFAULT_STYLE​

The background map style to be used.

  • Expected value type: string
  • Optional
  • Default: empty
note

We use MapLibre GL JS as the rendering library. It supports the styling options documented here: MapLibre Style Spec.


MapLibre GL JS is a fork of version 1.13 of the Mapbox GL JS web mapping library. It is therefore compatible with Mapbox styles up to and including this version.

DEEPHUB_MAP_UPDATES_PER_SECOND​

The number of updates per second for rendered map entities. A number > 0 is expected.

  • Expected value type: number
  • Optional
  • Default: 10

DEEPHUB_MAP_ENABLE_GEOENCODER_SEARCH_FIELD​

This options enables or disables the geo encoder search field. A boolean value, true or false, is expected.

  • Expected value type: boolean
  • Optional
  • Default: true

DEEPHUB_MAP_MINZOOM​

The minimum zoom level that can be reached when zooming out. A number between 1 and 24 is expected.

  • Expected value type: number
  • Optional
  • Default: 1

DEEPHUB_MAP_MAXZOOM​

The maximum zoom level that can be reached when zooming in. A number between 1 and 24 is expected, and it must be larger than the value specified for DEEPHUB_MAP_MINZOOM.

  • Expected value type: number
  • Optional
  • Default: 24