Skip to main content

Configure Workspace Lite

OpenBB Workspace Lite configuration is passed to the container with environment variables. Apply configuration changes by recreating the container with the same /data mount and the updated variables.

Public URL

When Workspace Lite runs behind a reverse proxy or DNS name, set the public URLs used by Workspace:

docker run -d \
-p 3000:3000 \
-v openbb-data:/data \
-e FRONTENDURL=https://workspace.example.com \
-e PROURL=https://workspace.example.com \
-e SELFURL=https://workspace.example.com/api \
--name openbb \
lite.openbb.co/openbb-lite:latest

Use HTTPS for shared deployments.

Host Port

If port 3000 is already in use on the host, map a different host port to the container port:

docker run -d \
-p 8080:3000 \
-v openbb-data:/data \
--name openbb \
lite.openbb.co/openbb-lite:latest

Open Workspace Lite at http://localhost:8080.

Initial Admin Account

The first start generates an admin account and prints the credentials to the container logs. Set the initial admin email and password yourself by passing these variables on the first run:

docker run -d \
-p 3000:3000 \
-v openbb-data:/data \
-e OPENBB_ADMIN_EMAIL=admin@example.com \
-e OPENBB_ADMIN_PASSWORD='replace-with-a-strong-password' \
--name openbb \
lite.openbb.co/openbb-lite:latest

Set these values before the first start of a new /data volume.

Apps Marketplace

The Apps Marketplace tab is available in Workspace Lite. Marketplace browsing requires outbound access to OpenBB's marketplace service.

Hide the Marketplace tab by starting the container with UI_SHOW_MARKETPLACE=false:

docker run -d \
-p 3000:3000 \
-v openbb-data:/data \
-e UI_SHOW_MARKETPLACE=false \
--name openbb \
lite.openbb.co/openbb-lite:latest

AI Features

Set AI_API_URL to the base URL of a Workspace-compatible AI service that users' browsers can reach. The Workspace AI service page documents the endpoint contract. Agent Rita is a reference implementation.

Workspace MCP

Workspace Lite comes with the MCP companion enabled. See the Workspace MCP overview for the user-facing MCP workflow.

Hide the MCP companion by starting the container with UI_SHOW_COMPANION_MCP_MODE=false:

docker run -d \
-p 3000:3000 \
-v openbb-data:/data \
-e UI_SHOW_COMPANION_MCP_MODE=false \
--name openbb \
lite.openbb.co/openbb-lite:latest

Disable the default MCP server for new users with MCP_DEFAULT_SERVER_ENABLED=false:

docker run -d \
-p 3000:3000 \
-v openbb-data:/data \
-e MCP_DEFAULT_SERVER_ENABLED=false \
--name openbb \
lite.openbb.co/openbb-lite:latest

If Workspace Lite runs behind a reverse proxy, allow long-lived HTTP responses and WebSocket upgrades for /api/pro/workspace-mcp.

Other Controls

VariableDefaultPurpose
PORT3000Container listen port
DATA_DIR/dataPersistent data directory inside the container
TZAmerica/New_YorkContainer timezone
AI_API_URLemptyAI service URL used by Workspace AI features
AUTHENTICATION_SEND_USER_EMAIL_AS_HEADERfalseSend the signed-in user's email as a request header
AI_COPILOT_ENABLEDtrueShow Copilot UI
AI_COPILOT_AI_ENHANCEMENTStrueEnable AI enhancement UI
UI_SHOW_MARKETPLACEtrueShow the Apps Marketplace tab
UI_SHOW_MINIMIZE_WIDGETtrueShow widget minimize controls
UI_SHOW_CHART_GENERATIONtrueShow chart generation controls
UI_SHOW_CHANGELOGtrueShow the in-app changelog
UI_SHOW_COPILOT_SWITCHERtrueShow the Copilot switcher
MCP_DEFAULT_SERVER_ENABLEDtrueAdd the default MCP server for new users
DATA_ALLOW_HTML_JS_EXECUTIONtrueAllow HTML widgets to execute JavaScript