From 9f61e21d9626e706618a923f7249665ffc0da940 Mon Sep 17 00:00:00 2001 From: Theodore Aptekarev Date: Wed, 8 Jul 2026 14:50:18 +0300 Subject: [PATCH 1/7] Add initial version of lite section of the docs --- .../getting-started/lite/_category_.json | 4 + .../getting-started/lite/configuration.md | 121 +++++++++++++++ .../workspace/getting-started/lite/index.md | 65 ++++++++ .../getting-started/lite/installation.md | 146 ++++++++++++++++++ .../getting-started/lite/operations.md | 90 +++++++++++ 5 files changed, 426 insertions(+) create mode 100644 content/workspace/getting-started/lite/_category_.json create mode 100644 content/workspace/getting-started/lite/configuration.md create mode 100644 content/workspace/getting-started/lite/index.md create mode 100644 content/workspace/getting-started/lite/installation.md create mode 100644 content/workspace/getting-started/lite/operations.md diff --git a/content/workspace/getting-started/lite/_category_.json b/content/workspace/getting-started/lite/_category_.json new file mode 100644 index 0000000000..e0cfbc12ea --- /dev/null +++ b/content/workspace/getting-started/lite/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Workspace Lite", + "position": 2 +} diff --git a/content/workspace/getting-started/lite/configuration.md b/content/workspace/getting-started/lite/configuration.md new file mode 100644 index 0000000000..7d49ea4603 --- /dev/null +++ b/content/workspace/getting-started/lite/configuration.md @@ -0,0 +1,121 @@ +--- +title: Configure Workspace Lite +sidebar_position: 3 +description: Configure OpenBB Workspace Lite with container environment variables. +keywords: + - OpenBB Workspace Lite configuration + - Workspace Lite environment variables + - Workspace Lite Marketplace + - Workspace Lite MCP +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +# 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: + +```bash +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: +``` + +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: + +```bash +docker run -d \ + -p 8080:3000 \ + -v openbb-data:/data \ + --name openbb \ + lite.openbb.co/openbb-lite: +``` + +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: + +```bash +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: +``` + +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`: + +```bash +docker run -d \ + -p 3000:3000 \ + -v openbb-data:/data \ + -e UI_SHOW_MARKETPLACE=false \ + --name openbb \ + lite.openbb.co/openbb-lite: +``` + +## Workspace MCP + +Workspace Lite comes with the MCP companion enabled. See the [Workspace MCP overview](/agents/workspace-mcp-overview) for the user-facing MCP workflow. + +Hide the MCP companion by starting the container with `UI_SHOW_COMPANION_MCP_MODE=false`: + +```bash +docker run -d \ + -p 3000:3000 \ + -v openbb-data:/data \ + -e UI_SHOW_COMPANION_MCP_MODE=false \ + --name openbb \ + lite.openbb.co/openbb-lite: +``` + +Disable the default MCP server for new users with `MCP_DEFAULT_SERVER_ENABLED=false`: + +```bash +docker run -d \ + -p 3000:3000 \ + -v openbb-data:/data \ + -e MCP_DEFAULT_SERVER_ENABLED=false \ + --name openbb \ + lite.openbb.co/openbb-lite: +``` + +If Workspace Lite runs behind a reverse proxy, allow long-lived HTTP responses and WebSocket upgrades for `/api/pro/workspace-mcp`. + +## Other Controls + +| Variable | Default | Purpose | +| --- | --- | --- | +| `PORT` | `3000` | Container listen port | +| `BACKEND_URL` | `/api` | Frontend API base URL | +| `FRONTENDURL` | `http://localhost:3000` | Public Workspace URL | +| `SELFURL` | `http://localhost:3000/api` | Public API URL | +| `PROURL` | `http://localhost:3000` | Workspace public URL | +| `AI_COPILOT_ENABLED` | `true` | Show Copilot UI | +| `AI_COPILOT_AI_ENHANCEMENTS` | `true` | Enable AI enhancement UI | +| `DATA_ALLOW_HTML_JS_EXECUTION` | `true` | Allow HTML widgets to execute JavaScript | diff --git a/content/workspace/getting-started/lite/index.md b/content/workspace/getting-started/lite/index.md new file mode 100644 index 0000000000..7fc14f38e3 --- /dev/null +++ b/content/workspace/getting-started/lite/index.md @@ -0,0 +1,65 @@ +--- +title: Workspace Lite +sidebar_position: 1 +description: Run OpenBB Workspace Lite as a self-hosted workspace for small investment teams. +keywords: + - OpenBB Workspace Lite + - Workspace Lite + - self-hosted workspace + - Docker + - small investment teams +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +# Workspace Lite + +OpenBB Workspace Lite is the self-hosted Workspace package for small investment teams that already have data sources and need a shared workspace they control. + +## Who It Is For + +Workspace Lite is designed for smaller self-hosted deployments among teams of roughly 1-20 people. + +It fits teams that: + +- Have at least one data source to connect, such as a database, data feed, or internal API. +- Need to share dashboards, apps, and agent-compatible analysis across a small team. +- Want to run Workspace inside their own environment for compliance reasons. +- Can operate a Docker container but do not want to run a Kubernetes-based enterprise deployment. + +The strongest trigger is usually one of these: + +- "I have been using the community tier and need to make this official for my whole team." +- "I want to run this internally for compliance reasons." + +## Who It Is Not For + +Workspace Lite is not the right starting point for teams with no data infrastructure at all. A team working only from local spreadsheets has an earlier data organization problem to solve first. + +Workspace Lite is also not intended for firms that need SSO, multi-entity deployment, or custom infrastructure support. Those requirements belong in a larger Workspace deployment. + +## Feature Set + +Workspace Lite uses email and password for authentication. + +Admins add users from the Workspace admin UI. A temporary password is displayed to the admin in the UI at creation time. The user will be prompted to change it after signing in. + +The Apps Marketplace tab is available in Workspace Lite. Marketplace browsing requires outbound access to OpenBB's marketplace service. Learn how to hide the tab in the [Lite configuration section](/workspace/getting-started/lite/configuration#apps-marketplace). + +Workspace Lite comes with the MCP companion enabled. Read about the MCP companion in the [Workspace MCP overview](/agents/workspace-mcp-overview). Learn how to disable this functionality in the [Lite configuration section](/workspace/getting-started/lite/configuration#workspace-mcp). + +## Next Steps + +Install Workspace Lite: + +[Install Workspace Lite](/workspace/getting-started/lite/installation) + +Configure Workspace Lite: + +[Configure Workspace Lite](/workspace/getting-started/lite/configuration) + +Operate, back up, and update Workspace Lite: + +[Operate Workspace Lite](/workspace/getting-started/lite/operations) diff --git a/content/workspace/getting-started/lite/installation.md b/content/workspace/getting-started/lite/installation.md new file mode 100644 index 0000000000..83162dffdc --- /dev/null +++ b/content/workspace/getting-started/lite/installation.md @@ -0,0 +1,146 @@ +--- +title: Install Workspace Lite +sidebar_position: 2 +description: Pull and run OpenBB Workspace Lite from the private container registry. +keywords: + - OpenBB Workspace Lite install + - Workspace Lite Docker + - lite.openbb.co + - AWS ECR login + - private registry +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +# Install Workspace Lite + +OpenBB Workspace Lite is delivered through the private container registry. OpenBB provides registry credentials. + +The commands below use the private container registry path: + +```text +lite.openbb.co/openbb-lite: +``` + +Replace `` with the image tag from your OpenBB release instructions. + +## Requirements + +You need: + +- [Docker](https://docs.docker.com/get-started/get-docker/) installed and running. +- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) installed locally. +- Registry credentials provided by OpenBB. +- Network access from the host to `lite.openbb.co`. + +You do not need your own AWS account. The AWS credentials provided by OpenBB authorize registry access for the Workspace Lite image. + +## Configure Registry Credentials + +Create a dedicated AWS CLI profile for the registry credentials: + +```bash +aws configure --profile openbb-lite +``` + +Enter the access key ID, secret access key, and region provided by OpenBB. Unless OpenBB gives you a different region, use: + +```text +us-east-1 +``` + +## Log In To The Registry + +Authenticate Docker to the private registry: + +```bash +aws ecr get-login-password --region us-east-1 --profile openbb-lite | docker login --username AWS --password-stdin lite.openbb.co +``` + +A successful login prints: + +```text +Login Succeeded +``` + +## Pull The Image + +Pull the image using the tag from your OpenBB instructions email: + +```bash +docker pull lite.openbb.co/openbb-lite: +``` + +If you need a platform-specific image, include the platform architecture in the pull command. For example: + +```bash +docker pull --platform linux/amd64 lite.openbb.co/openbb-lite: +``` + +## Start Workspace Lite + +Mount a host folder or Docker volume to `/data` before using Workspace Lite with team data. The `/data` mount stores the database, uploaded files, and generated secrets. + +Run the container with a persistent Docker volume: + +```bash +docker run -d \ + -p 3000:3000 \ + -v openbb-data:/data \ + --name openbb \ + lite.openbb.co/openbb-lite: +``` + +Open Workspace Lite at: + +```text +http://localhost:3000 +``` + +The first start generates an admin account and runtime secrets. Read the generated admin credentials from the container logs: + +```bash +docker logs openbb +``` + +The credentials are also stored inside the container volume at: + +```text +/data/secrets.env +``` + +Keep this file private. It contains the generated admin password and runtime secrets. + +## Stop And Start + +Stop the container: + +```bash +docker stop openbb +``` + +Start it again: + +```bash +docker start openbb +``` + +The `/data` volume keeps the database, uploaded files, and generated secrets across restarts. + +## Troubleshooting + +If `docker login` fails, confirm the AWS profile, region, and registry hostname: + +```bash +aws ecr get-login-password --region us-east-1 --profile openbb-lite +``` + +If `docker pull` fails with `denied` after `Login Succeeded`, your registry credentials may not have access to the image or tag. Confirm the image tag and registry access with OpenBB. + +If the container starts but the page does not load, inspect the logs: + +```bash +docker logs openbb +``` diff --git a/content/workspace/getting-started/lite/operations.md b/content/workspace/getting-started/lite/operations.md new file mode 100644 index 0000000000..baa3eb654e --- /dev/null +++ b/content/workspace/getting-started/lite/operations.md @@ -0,0 +1,90 @@ +--- +title: Operate Workspace Lite +sidebar_position: 4 +description: Back up, update, and administer OpenBB Workspace Lite. +keywords: + - OpenBB Workspace Lite operations + - Workspace Lite backup + - Workspace Lite users +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +# Operate Workspace Lite + +Workspace Lite is customer-hosted. You provision the host, secure the network, operate the container, back up `/data`, and manage users. + +OpenBB provides the Workspace Lite image and generally available updates through the private container registry during the subscription term. + +## Persistent Data + +Workspace Lite stores persistent state under `/data`. Mount `/data` to a host folder or a Docker volume before using Workspace Lite with team data. + +| Path | Purpose | +| --- | --- | +| `/data/openbb.db` | SQLite database | +| `/data/storage` | Uploaded files and local folder storage | +| `/data/secrets.env` | Generated runtime secrets and admin credentials | + +Use the full `/data` mount as the backup and restore boundary. + +## Secrets + +Treat `/data/secrets.env` as sensitive. Back it up with the database and storage files. Do not publish container logs from first start without redacting the admin password. + +## Users And Authentication + +Workspace Lite uses local email and password authentication. Admins manage users from the Workspace admin UI. + +When an admin adds a user, Workspace returns a temporary password in the UI. Copy that password before closing the toast and send it to the user through your secure internal channel. + +Use named admin accounts for administrators who need ongoing access. Rotate the generated first-start admin password after setup. + +## Backups & Restore + +Back up the full `/data` mount. A backup should include: + +- `/data/openbb.db` +- `/data/openbb.db-wal` and `/data/openbb.db-shm` if present +- `/data/storage` +- `/data/secrets.env` + +For a cold backup, stop the container first. + +Restore the `/data` backup into a new volume, then start Workspace Lite against that volume. You can then start the same or newer compatible Workspace Lite image against that volume. + +## Updates + +Before updating: + +- read the release notes provided by OpenBB +- back up `/data` +- record the currently running image version +- confirm the new image tag and registry access + +Pull the new image: + +```bash +docker pull lite.openbb.co/openbb-lite: +``` + +Stop and remove the old container. Keep the `openbb-data` volume: + +```bash +docker stop openbb +docker rm openbb +``` + +Start the new version against the same volume: + +```bash +docker run -d \ + -p 3000:3000 \ + -v openbb-data:/data \ + --name openbb \ + lite.openbb.co/openbb-lite: +``` + +Check sign-in, dashboards, connected backends, files, Apps, and MCP behavior before removing the old image from the host. From f17a5b75bc07e8552338803fa4d249e5b83b276d Mon Sep 17 00:00:00 2001 From: Theodore Aptekarev Date: Wed, 8 Jul 2026 15:05:24 +0300 Subject: [PATCH 2/7] Add configurable env variables to the table --- .../getting-started/lite/configuration.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/content/workspace/getting-started/lite/configuration.md b/content/workspace/getting-started/lite/configuration.md index 7d49ea4603..d17619a17d 100644 --- a/content/workspace/getting-started/lite/configuration.md +++ b/content/workspace/getting-started/lite/configuration.md @@ -112,10 +112,16 @@ If Workspace Lite runs behind a reverse proxy, allow long-lived HTTP responses a | Variable | Default | Purpose | | --- | --- | --- | | `PORT` | `3000` | Container listen port | -| `BACKEND_URL` | `/api` | Frontend API base URL | -| `FRONTENDURL` | `http://localhost:3000` | Public Workspace URL | -| `SELFURL` | `http://localhost:3000/api` | Public API URL | -| `PROURL` | `http://localhost:3000` | Workspace public URL | +| `DATA_DIR` | `/data` | Persistent data directory inside the container | +| `TZ` | `America/New_York` | Container timezone | +| `AI_API_URL` | empty | AI service URL used by Workspace AI features | +| `AUTHENTICATION_SEND_USER_EMAIL_AS_HEADER` | `false` | Send the signed-in user's email as a request header | | `AI_COPILOT_ENABLED` | `true` | Show Copilot UI | | `AI_COPILOT_AI_ENHANCEMENTS` | `true` | Enable AI enhancement UI | +| `UI_SHOW_MARKETPLACE` | `true` | Show the Apps Marketplace tab | +| `UI_SHOW_MINIMIZE_WIDGET` | `true` | Show widget minimize controls | +| `UI_SHOW_CHART_GENERATION` | `true` | Show chart generation controls | +| `UI_SHOW_CHANGELOG` | `true` | Show the in-app changelog | +| `UI_SHOW_COPILOT_SWITCHER` | `true` | Show the Copilot switcher | +| `MCP_DEFAULT_SERVER_ENABLED` | `true` | Add the default MCP server for new users | | `DATA_ALLOW_HTML_JS_EXECUTION` | `true` | Allow HTML widgets to execute JavaScript | From 9452f60a7042ddb5ee602b478418e6a6bf7ca822 Mon Sep 17 00:00:00 2001 From: Theodore Aptekarev Date: Mon, 13 Jul 2026 15:48:40 +0300 Subject: [PATCH 3/7] Address review comments --- content/workspace/getting-started/lite/index.md | 2 ++ content/workspace/getting-started/lite/installation.md | 8 ++++++++ 2 files changed, 10 insertions(+) diff --git a/content/workspace/getting-started/lite/index.md b/content/workspace/getting-started/lite/index.md index 7fc14f38e3..b1cc5fc81a 100644 --- a/content/workspace/getting-started/lite/index.md +++ b/content/workspace/getting-started/lite/index.md @@ -18,6 +18,8 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; OpenBB Workspace Lite is the self-hosted Workspace package for small investment teams that already have data sources and need a shared workspace they control. +For pricing and access, see [OpenBB pricing](https://openbb.co/pricing). + ## Who It Is For Workspace Lite is designed for smaller self-hosted deployments among teams of roughly 1-20 people. diff --git a/content/workspace/getting-started/lite/installation.md b/content/workspace/getting-started/lite/installation.md index 83162dffdc..11f8425a90 100644 --- a/content/workspace/getting-started/lite/installation.md +++ b/content/workspace/getting-started/lite/installation.md @@ -37,6 +37,14 @@ You need: You do not need your own AWS account. The AWS credentials provided by OpenBB authorize registry access for the Workspace Lite image. +## Install With A Coding Agent + +Give your coding agent this prompt: + +```text +Install OpenBB Workspace Lite by following https://docs.openbb.co/workspace/getting-started/lite/installation. Ask me for the registry credentials and image tag when needed. +``` + ## Configure Registry Credentials Create a dedicated AWS CLI profile for the registry credentials: From ac8efde6becb9e714d67c8a10b01067a4b99008e Mon Sep 17 00:00:00 2001 From: Theodore Aptekarev Date: Mon, 13 Jul 2026 16:24:25 +0300 Subject: [PATCH 4/7] Improve documentation around workspace ai features --- content/agents/agent-rita.md | 6 ++- .../ai-features/workspace-ai-service.md | 54 +++++++++++++++++++ .../workspace/developers/open-source-agent.md | 2 +- .../getting-started/lite/configuration.md | 4 ++ 4 files changed, 63 insertions(+), 3 deletions(-) create mode 100644 content/workspace/developers/ai-features/workspace-ai-service.md diff --git a/content/agents/agent-rita.md b/content/agents/agent-rita.md index fc6fe6c854..95652dcfc3 100644 --- a/content/agents/agent-rita.md +++ b/content/agents/agent-rita.md @@ -25,10 +25,12 @@ Agent Rita implements the core endpoints Workspace expects from a custom agent: - `GET /agents.json` advertises the agent, supported models, and Workspace features. - `POST /v1/query` receives messages, dashboard context, widgets, and any Workspace-configured MCP tools, then streams Server-Sent Events (SSE) back to Workspace. -It also includes auxiliary generation endpoints used by Workspace UI flows, including `POST /v1/generate/dashboard/title` for dashboard names and `POST /v1/generate/chat/title` for chat titles. The same route group includes helper endpoints for prompt enhancement, widget metadata, and SQL or Python code generation. - The agent focuses on Workspace-specific behavior: widget discovery, widget data round-trips, SQL over loaded tables, citations, generated artifacts, and native Workspace actions. The Agent Rita repository also includes an optional companion MCP server in `mcp-server/` for web search, web-page fetch, Python execution, Mermaid rendering, and document RAG. When that server is connected in Workspace, its tools are sent to Agent Rita through the request payload. +## Workspace AI features endpoints + +Agent Rita implements the [Workspace AI service endpoints](/workspace/developers/ai-features/workspace-ai-service) used for dashboard and chat titles, prompt enhancement, widget metadata, uploaded-file metadata, and code generation. These endpoints are separate from Agent Rita's custom-agent chat endpoint. + ## Source code The source code is available in the [Agent Rita repository](https://github.com/OpenBB-finance/agent-rita). diff --git a/content/workspace/developers/ai-features/workspace-ai-service.md b/content/workspace/developers/ai-features/workspace-ai-service.md new file mode 100644 index 0000000000..a59804fd80 --- /dev/null +++ b/content/workspace/developers/ai-features/workspace-ai-service.md @@ -0,0 +1,54 @@ +--- +title: Workspace AI service +sidebar_position: 11 +description: Implement the AI service endpoints used by Workspace Lite and Enterprise UI features. +keywords: +- Workspace AI service +- AI_API_URL +- Agent Rita +- dashboard titles +- prompt enhancement +- widget metadata +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Workspace Lite and Enterprise deployments can use an AI service for UI generation tasks. These are separate from the custom agent integrations described [here](/workspace/developers/agents-integration). + +Set the AI service base URL in the deployment configuration. E.G. OpenBB Workspace [Lite uses `AI_API_URL`](/workspace/getting-started/lite/configuration#ai-features). Requests originate in the user's browser, so the URL must be reachable from the browser. For shared deployments, use HTTPS and allow cross-origin requests from the Workspace origin. + +[Agent Rita](/agents/agent-rita) is a reference implementation. Adding Agent Rita as a custom chat agent does not configure these UI features; the operator must also set the deployment's AI service URL. + +## Endpoints + +| Endpoint | Request | Response | Workspace usage | +| --- | --- | --- | --- | +| `POST /v1/generate/chat/title` | JSON containing `messages` | JSON string | Generate a chat title | +| `POST /v1/generate/dashboard/title` | JSON containing `widgets` | Plain text | Generate a dashboard name | +| `POST /v1/enhance_prompt` | JSON containing `messages` and optional Workspace context | Plain text | Rewrite a prompt without changing its intent | +| `POST /v1/generate/widget_info` | JSON containing `widget_generation_request` | JSON with `title`, `description`, `category`, and `subcategory` | Generate widget metadata | +| `POST /v1/generate/widget_info/file` | Multipart form data containing `file` | JSON with `title` and `description` | Generate uploaded-file metadata | +| `POST /v1/generate/code` | JSON containing the widget ID, prompt, language, and optional code or data context | JSON containing `generated_code` or an error | Generate or modify table code | + +## Authentication + +Workspace includes the signed-in user's bearer token in these requests. Validate the token in the AI service or place the service behind an authenticated gateway. Do not log authorization headers or forwarded API keys. + +## Reference behavior + +| Endpoint | Processing and fallback behavior | +| --- | --- | +| Chat title | Uses the last five human messages, truncated to 500 characters each. Returns `"New Chat"` when no human message is available or generation fails. | +| Dashboard title | Uses up to 20 widget names. Returns `My Dashboard` when no names are available or generation fails. | +| Prompt enhancement | Uses the latest human message and up to 30 widget names. Returns the original prompt when generation fails. | +| Widget metadata | Uses up to 3,000 characters of widget data. Falls back to metadata supplied in the request. | +| Uploaded-file metadata | Accepts files up to 25 MB and reads up to 3,000 characters. Falls back to the filename. | +| Code generation | Supports SQL and Python, with optional current code, SQL schema, and up to five sample rows. Returns a failure object when generation fails. | + +Requests that fail endpoint schema validation return `400`. The uploaded-file endpoint returns `400` when the file is missing and `413` when it exceeds 25 MB. Model-provider failures return the endpoint-specific fallback response with status `200`. + +Workspace can request `text` code generation and provide `semantic_models`. Agent Rita's current code-generation route supports only `sql` and `python`, so it does not implement that variant. + +See the [Agent Rita source code](https://github.com/OpenBB-finance/agent-rita/tree/main/src/routes/generate) for the reference route implementations. diff --git a/content/workspace/developers/open-source-agent.md b/content/workspace/developers/open-source-agent.md index c01edba250..64ee303fbe 100644 --- a/content/workspace/developers/open-source-agent.md +++ b/content/workspace/developers/open-source-agent.md @@ -26,7 +26,7 @@ Agent Rita runs as an HTTP service that implements the Workspace agent contract: - `GET /agents.json` returns the agent metadata, available models, and supported Workspace features. - `POST /v1/query` receives chat messages, dashboard context, widgets, and available MCP tools, then streams Server-Sent Events (SSE) back to Workspace. -Agent Rita also exposes auxiliary generation routes for Workspace UI tasks, such as `POST /v1/generate/dashboard/title` for dashboard names and `POST /v1/generate/chat/title` for chat titles. These routes use the configured model provider for single-shot generation outside the main chat stream. +Agent Rita also implements the [Workspace AI service endpoints](/workspace/developers/ai-features/workspace-ai-service) for single-shot UI generation tasks outside the main chat stream. If MCP servers are configured in Workspace, Agent Rita can use their tools. Workspace owns those MCP connections, sends the available tool descriptors in each request, executes selected tools, and forwards results back to the agent through the normal `/v1/query` flow. diff --git a/content/workspace/getting-started/lite/configuration.md b/content/workspace/getting-started/lite/configuration.md index d17619a17d..e77525699d 100644 --- a/content/workspace/getting-started/lite/configuration.md +++ b/content/workspace/getting-started/lite/configuration.md @@ -79,6 +79,10 @@ docker run -d \ lite.openbb.co/openbb-lite: ``` +## 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](/workspace/developers/ai-features/workspace-ai-service) page documents the endpoint contract. [Agent Rita](/agents/agent-rita) is a reference implementation. + ## Workspace MCP Workspace Lite comes with the MCP companion enabled. See the [Workspace MCP overview](/agents/workspace-mcp-overview) for the user-facing MCP workflow. From 8bc91ff3ec182f55e5c4bc4316a611f4512abfbd Mon Sep 17 00:00:00 2001 From: andrewkenreich Date: Wed, 15 Jul 2026 14:46:16 -0400 Subject: [PATCH 5/7] update for latest --- .../getting-started/lite/configuration.md | 12 ++--- .../getting-started/lite/installation.md | 49 +++++++++---------- .../getting-started/lite/operations.md | 8 +-- 3 files changed, 34 insertions(+), 35 deletions(-) diff --git a/content/workspace/getting-started/lite/configuration.md b/content/workspace/getting-started/lite/configuration.md index e77525699d..57c9bdd122 100644 --- a/content/workspace/getting-started/lite/configuration.md +++ b/content/workspace/getting-started/lite/configuration.md @@ -29,7 +29,7 @@ docker run -d \ -e PROURL=https://workspace.example.com \ -e SELFURL=https://workspace.example.com/api \ --name openbb \ - lite.openbb.co/openbb-lite: + lite.openbb.co/openbb-lite:latest ``` Use HTTPS for shared deployments. @@ -43,7 +43,7 @@ docker run -d \ -p 8080:3000 \ -v openbb-data:/data \ --name openbb \ - lite.openbb.co/openbb-lite: + lite.openbb.co/openbb-lite:latest ``` Open Workspace Lite at `http://localhost:8080`. @@ -59,7 +59,7 @@ docker run -d \ -e OPENBB_ADMIN_EMAIL=admin@example.com \ -e OPENBB_ADMIN_PASSWORD='replace-with-a-strong-password' \ --name openbb \ - lite.openbb.co/openbb-lite: + lite.openbb.co/openbb-lite:latest ``` Set these values before the first start of a new `/data` volume. @@ -76,7 +76,7 @@ docker run -d \ -v openbb-data:/data \ -e UI_SHOW_MARKETPLACE=false \ --name openbb \ - lite.openbb.co/openbb-lite: + lite.openbb.co/openbb-lite:latest ``` ## AI Features @@ -95,7 +95,7 @@ docker run -d \ -v openbb-data:/data \ -e UI_SHOW_COMPANION_MCP_MODE=false \ --name openbb \ - lite.openbb.co/openbb-lite: + lite.openbb.co/openbb-lite:latest ``` Disable the default MCP server for new users with `MCP_DEFAULT_SERVER_ENABLED=false`: @@ -106,7 +106,7 @@ docker run -d \ -v openbb-data:/data \ -e MCP_DEFAULT_SERVER_ENABLED=false \ --name openbb \ - lite.openbb.co/openbb-lite: + 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`. diff --git a/content/workspace/getting-started/lite/installation.md b/content/workspace/getting-started/lite/installation.md index 11f8425a90..4c6b9e410b 100644 --- a/content/workspace/getting-started/lite/installation.md +++ b/content/workspace/getting-started/lite/installation.md @@ -21,10 +21,10 @@ OpenBB Workspace Lite is delivered through the private container registry. OpenB The commands below use the private container registry path: ```text -lite.openbb.co/openbb-lite: +lite.openbb.co/openbb-lite:latest ``` -Replace `` with the image tag from your OpenBB release instructions. +The `latest` tag always points to the most recent generally available release. ## Requirements @@ -35,36 +35,33 @@ You need: - Registry credentials provided by OpenBB. - Network access from the host to `lite.openbb.co`. -You do not need your own AWS account. The AWS credentials provided by OpenBB authorize registry access for the Workspace Lite image. +You do not need your own AWS account or to run `aws configure`. The AWS credentials provided by OpenBB authorize registry access for the Workspace Lite image and are passed as environment variables for the login command only. ## Install With A Coding Agent Give your coding agent this prompt: ```text -Install OpenBB Workspace Lite by following https://docs.openbb.co/workspace/getting-started/lite/installation. Ask me for the registry credentials and image tag when needed. +Install OpenBB Workspace Lite by following https://docs.openbb.co/workspace/getting-started/lite/installation. Ask me for the registry credentials when needed. ``` -## Configure Registry Credentials +## Log In To The Registry -Create a dedicated AWS CLI profile for the registry credentials: +Authenticate Docker to the private registry using the access key ID and secret access key provided by OpenBB. -```bash -aws configure --profile openbb-lite -``` +macOS / Linux: -Enter the access key ID, secret access key, and region provided by OpenBB. Unless OpenBB gives you a different region, use: - -```text -us-east-1 +```bash +AWS_ACCESS_KEY_ID="" AWS_SECRET_ACCESS_KEY="" AWS_DEFAULT_REGION="us-east-1" aws ecr get-login-password | docker login --username AWS --password-stdin lite.openbb.co ``` -## Log In To The Registry - -Authenticate Docker to the private registry: +Windows PowerShell: -```bash -aws ecr get-login-password --region us-east-1 --profile openbb-lite | docker login --username AWS --password-stdin lite.openbb.co +```powershell +$env:AWS_ACCESS_KEY_ID="" +$env:AWS_SECRET_ACCESS_KEY="" +$env:AWS_DEFAULT_REGION="us-east-1" +aws ecr get-login-password | docker login --username AWS --password-stdin lite.openbb.co ``` A successful login prints: @@ -75,16 +72,16 @@ Login Succeeded ## Pull The Image -Pull the image using the tag from your OpenBB instructions email: +Pull the image: ```bash -docker pull lite.openbb.co/openbb-lite: +docker pull lite.openbb.co/openbb-lite:latest ``` If you need a platform-specific image, include the platform architecture in the pull command. For example: ```bash -docker pull --platform linux/amd64 lite.openbb.co/openbb-lite: +docker pull --platform linux/amd64 lite.openbb.co/openbb-lite:latest ``` ## Start Workspace Lite @@ -98,7 +95,7 @@ docker run -d \ -p 3000:3000 \ -v openbb-data:/data \ --name openbb \ - lite.openbb.co/openbb-lite: + lite.openbb.co/openbb-lite:latest ``` Open Workspace Lite at: @@ -139,13 +136,15 @@ The `/data` volume keeps the database, uploaded files, and generated secrets acr ## Troubleshooting -If `docker login` fails, confirm the AWS profile, region, and registry hostname: +If `docker login` fails, confirm the credentials, region, and registry hostname by running the login command's first half on its own: ```bash -aws ecr get-login-password --region us-east-1 --profile openbb-lite +AWS_ACCESS_KEY_ID="" AWS_SECRET_ACCESS_KEY="" AWS_DEFAULT_REGION="us-east-1" aws ecr get-login-password ``` -If `docker pull` fails with `denied` after `Login Succeeded`, your registry credentials may not have access to the image or tag. Confirm the image tag and registry access with OpenBB. +A long token printed to the terminal means the credentials are valid. + +If `docker pull` fails with `denied` after `Login Succeeded`, your registry credentials may not have access to the image. Confirm registry access with OpenBB. If the container starts but the page does not load, inspect the logs: diff --git a/content/workspace/getting-started/lite/operations.md b/content/workspace/getting-started/lite/operations.md index baa3eb654e..5912c7bbac 100644 --- a/content/workspace/getting-started/lite/operations.md +++ b/content/workspace/getting-started/lite/operations.md @@ -62,12 +62,12 @@ Before updating: - read the release notes provided by OpenBB - back up `/data` - record the currently running image version -- confirm the new image tag and registry access +- confirm registry access -Pull the new image: +Pull the new image. The explicit `docker pull` is required — Docker reuses the locally cached `latest` otherwise: ```bash -docker pull lite.openbb.co/openbb-lite: +docker pull lite.openbb.co/openbb-lite:latest ``` Stop and remove the old container. Keep the `openbb-data` volume: @@ -84,7 +84,7 @@ docker run -d \ -p 3000:3000 \ -v openbb-data:/data \ --name openbb \ - lite.openbb.co/openbb-lite: + lite.openbb.co/openbb-lite:latest ``` Check sign-in, dashboards, connected backends, files, Apps, and MCP behavior before removing the old image from the host. From 26a306a2b300e1c6e36c1af762166abf2cc8a146 Mon Sep 17 00:00:00 2001 From: Theodore Aptekarev Date: Mon, 20 Jul 2026 20:06:22 +0300 Subject: [PATCH 6/7] Update instructions to retrieve credentials --- .../workspace/getting-started/lite/installation.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/content/workspace/getting-started/lite/installation.md b/content/workspace/getting-started/lite/installation.md index 4c6b9e410b..902698d8b7 100644 --- a/content/workspace/getting-started/lite/installation.md +++ b/content/workspace/getting-started/lite/installation.md @@ -104,13 +104,19 @@ Open Workspace Lite at: http://localhost:3000 ``` -The first start generates an admin account and runtime secrets. Read the generated admin credentials from the container logs: +The first start generates an admin account and runtime secrets. Print the generated admin email and password at any time: ```bash -docker logs openbb +docker exec openbb credentials +``` + +The credentials are also printed at the end of the startup logs: + +```bash +docker logs openbb --tail 15 ``` -The credentials are also stored inside the container volume at: +They are stored inside the container volume at: ```text /data/secrets.env From c3df15e497fdc6d1d7a8e33dac3dc7e9c87d7917 Mon Sep 17 00:00:00 2001 From: Theodore Aptekarev Date: Mon, 20 Jul 2026 20:06:42 +0300 Subject: [PATCH 7/7] Ignore vscode settings --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index efc58e5cb6..c4e539c4c4 100644 --- a/.gitignore +++ b/.gitignore @@ -30,3 +30,6 @@ content/workspace/widgets-library # Download Platform code from https://github.com/OpenBB-finance/OpenBBTerminal openbb_platform + +# Code editor configurations +.vscode/