Gateway Service Configuration

Database

`ConnectionStrings__mongodb`

Type: string
Default: mongodb://root:example@localhost:27017/ScriptBee?authSource=admin
Description: The connection string to MongoDB. Must be configured to match the Mongodb server configurations

Authentication

`AUTHENTICATION__REQUIREHTTPSMETADATA`

Type: bool
Default: true
Description: Whether to require HTTPS for the OpenID Connect metadata endpoint. This should be set to true in production.

`AUTHENTICATION__AUTHORITY`

Type: string
Default: None
Description: The URL of the OpenID Connect authority (e.g., https://login.microsoftonline.com/{tenantId}/v2.0 for Azure AD).

`AUTHENTICATION__AUDIENCE`

Type: string
Default: None
Description: The audience for the OpenID Connect application. (e.g. api://my-app-backend)

`AUTHENTICATION__AUTHWELLKNOWNENDPOINTURL`

Type: string
Default: None
Description: An optional URL of the OpenID Connect well-known endpoint (e.g., https://login.microsoftonline.com/{tenantId}/v2.0/.well-known/openid-configuration for Azure AD). Normally the authority URL is used to discover the well-known endpoint, but in some cases, you may want to override it.

`AUTHENTICATION__CLIENTID`

Type: string
Default: None
Description: The client ID for the OpenID Connect application.

`AUTHENTICATION__SCOPE`

Type: string
Default: None
Description: The scope for the OpenID Connect application. (e.g. openid profile email api://my-app-backend/access_as_user)

`AUTHENTICATION__USERIDCLAIM`

Type: string
Default: None
Description: The claim type used to extract from JWT for the user id (e.g. "sub", "oid"). Leave unset so that the Name Identifier claim (sub) is taken

`AUTHENTICATION__GROUPSCLAIM`

Type: string
Default: groups
Description: The claim type use to extract from JWT for the groups

`AUTHENTICATION__EXTERNALAUTHORIZATIONURL`

Type: string
Default: None
Description: The authorization URL for the external authorization service (e.g., OPA). This is used to validate user permissions.

`AUTHENTICATION__PERMISSIONSURL`

Type: string
Default: None
Description: The authorization URL for permissions for a given user for a resource

`AUTHENTICATION__DEFAULTCREATORROLEURL`

Type: string
Default: None
Description: The URL to obtain the role that is assigned to the user when creating a project

`AUTHENTICATION__ROLESURL`

Type: string
Default: None
Description: The URL to obtain the role defintiions.

`AUTHENTICATION__AUTHMODE`

Type: string
Default: None
Description: Set to "Development" to disable authentication for development purposes. It most not be set in production.

Analysis Configuration

`SCRIPTBEEANALYSISDRIVER`

Type: string
Default: Docker
Description: The driver used to manage analysis instances. Currently only Docker is supported.

`SCRIPTBEEANALYSISIMAGE`

Type: string
Default: dxworks/scriptbee-analysis:latest
Description: The Docker image used for analysis instances.

`SCRIPTBEEANALYSISDOCKER__DOCKERSOCKET`

Type: string
Default: unix:///var/run/docker.sock
Description: URI to the Docker daemon socket.

`SCRIPTBEEANALYSISDOCKER__PORT`

Type: int
Default: 80
Description: The internal port the analysis container listens on.

`SCRIPTBEEANALYSISDOCKER__NETWORK`

Type: string
Default: None
Description: The Docker network name to attach containers to (required if using a custom network for MongoDB).

`SCRIPTBEEANALYSISDOCKER__MONGODBCONNECTIONSTRING`

Type: string
Default: Inherits Gateway's if omitted
Description: MongoDB connection string for the analysis instance.

`SCRIPTBEEANALYSISDOCKER__USERFOLDERVOLUMEPATH`

Type: string
Default: None
Description: The mount point for project data inside the analysis container.

`SCRIPTBEEANALYSISDOCKER__USERFOLDERHOSTPATH`

Type: string
Default: None
Description: The absolute path on the host machine where project data is stored.

IMPORTANT

The SCRIPTBEE__ANALYSIS__DOCKER__USERFOLDERHOSTPATH must be an absolute path on your host machine. This is because the Gateway tells the Docker daemon to mount this path into the new analysis containers. If this is incorrect, the analysis service will not be able to find your scripts or models.

`SCRIPTBEEANALYSISDOCKER__PLUGINSVOLUME`

Type: string
Default: scriptbee-plugins
Description: The name of the volume that will be created and shared for installing plugins. This will be mounted in Analysis Service as a readonly path to access the plugins

`SCRIPTBEEANALYSISDOCKER__LABELS`

Type: Dictionary<string, string>
Default: None
Description: A map of Docker labels to attach to the analysis container when created.

For example, to configure container labels:

SCRIPTBEE__ANALYSIS__DOCKER__LABELS__com.docker.compose.project=scriptbee-quickstart

`SCRIPTBEEANALYSISDOCKER__HOSTCONFIG`

NOTE

Note that you can configure docker options such as resource limits and environment variables for the analysis containers by using the SCRIPTBEE__ANALYSIS__DOCKER__HOSTCONFIG configuration. This allows for advanced users to have full control over the Docker container configuration without the need for the Gateway to explicitly support each option. Please

see Docker Host Config

for all available options that can be configured through this setting.

For example, you can se the memory limit like this

SCRIPTBEE__ANALYSIS__DOCKER__HOSTCONFIG__MEMORY=536870912

Instance Configuration

`SCRIPTBEEINSTANCEPOLLINGDELAYMILLISECONDS`

Type: long
Default: 1000
Description: The polling interval to check when the analysis instance is ready so that the plugins can be automatically installed there

`SCRIPTBEEINSTANCEANALYSISSTATUSMONITORINTERVALMILLISECONDS`

Type: int
Default: 2000
Description: The interval in milliseconds at which the Gateway polls MongoDB for running analyses to push updates via SignalR.

Plugins Configuration

`SCRIPTBEEPLUGINSINSTALLATIONFOLDER`

Type: string
Default: [User Profile Folder]/.scriptbee/plugins
Description: The folder where all downloaded plugins are stored (the "Cache"). This folder is shared between the Gateway and all Analysis instances.

`SCRIPTBEEPLUGINSGATEWAYINSTALLATIONFOLDER`

Type: string
Default: [User Profile Folder]/.scriptbee/gateway/plugins
Description: The folder for plugins that are actively "Enabled" in the Gateway. When you enable a plugin from the UI, it is copied here so the Gateway can load it.

User Management Configuration

`SCRIPTBEEUSERMANAGEMENTUSERINFOCACHETIMESECONDS`

Type: long
Default: 3600
Description: The amount of time to cache the user information before loading it from the database.

Helper Functions

Gateway Service Configuration ​

Database ​

ConnectionStrings__mongodb ​

Authentication ​

AUTHENTICATION__REQUIREHTTPSMETADATA ​

AUTHENTICATION__AUTHORITY ​

AUTHENTICATION__AUDIENCE ​

AUTHENTICATION__AUTHWELLKNOWNENDPOINTURL ​

AUTHENTICATION__CLIENTID ​

AUTHENTICATION__SCOPE ​

AUTHENTICATION__USERIDCLAIM ​

AUTHENTICATION__GROUPSCLAIM ​

AUTHENTICATION__EXTERNALAUTHORIZATIONURL ​

AUTHENTICATION__PERMISSIONSURL ​

AUTHENTICATION__DEFAULTCREATORROLEURL ​

AUTHENTICATION__ROLESURL ​

AUTHENTICATION__AUTHMODE ​

Analysis Configuration ​

SCRIPTBEE__ANALYSIS__DRIVER ​

SCRIPTBEE__ANALYSIS__IMAGE ​

SCRIPTBEE__ANALYSIS__DOCKER__DOCKERSOCKET ​

SCRIPTBEE__ANALYSIS__DOCKER__PORT ​

SCRIPTBEE__ANALYSIS__DOCKER__NETWORK ​

SCRIPTBEE__ANALYSIS__DOCKER__MONGODBCONNECTIONSTRING ​

SCRIPTBEE__ANALYSIS__DOCKER__USERFOLDERVOLUMEPATH ​

SCRIPTBEE__ANALYSIS__DOCKER__USERFOLDERHOSTPATH ​

SCRIPTBEE__ANALYSIS__DOCKER__PLUGINSVOLUME ​

SCRIPTBEE__ANALYSIS__DOCKER__LABELS ​

SCRIPTBEE__ANALYSIS__DOCKER__HOSTCONFIG ​

Instance Configuration ​

SCRIPTBEE__INSTANCE__POLLINGDELAYMILLISECONDS ​

SCRIPTBEE__INSTANCE__ANALYSISSTATUSMONITORINTERVALMILLISECONDS ​

Plugins Configuration ​

SCRIPTBEE__PLUGINS__INSTALLATIONFOLDER ​

SCRIPTBEE__PLUGINS__GATEWAYINSTALLATIONFOLDER ​

User Management Configuration ​

SCRIPTBEE__USERMANAGEMENT__USERINFOCACHETIMESECONDS ​