Skip to content

Commit 9f61e21

Browse files
piiqpiiq
committed
Add initial version of lite section of the docs
1 parent 9698f86 commit 9f61e21

5 files changed

Lines changed: 426 additions & 0 deletions

File tree

‎content/workspace/getting-started/lite/_category_.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Workspace Lite",
3+
"position": 2
4+
}

‎content/workspace/getting-started/lite/configuration.md‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
---
2+
title: Configure Workspace Lite
3+
sidebar_position: 3
4+
description: Configure OpenBB Workspace Lite with container environment variables.
5+
keywords:
6+
- OpenBB Workspace Lite configuration
7+
- Workspace Lite environment variables
8+
- Workspace Lite Marketplace
9+
- Workspace Lite MCP
10+
---
11+
12+
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
13+
14+
<HeadTitle title="Configure Workspace Lite | OpenBB Workspace Docs" />
15+
16+
# Configure Workspace Lite
17+
18+
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.
19+
20+
## Public URL
21+
22+
When Workspace Lite runs behind a reverse proxy or DNS name, set the public URLs used by Workspace:
23+
24+
```bash
25+
docker run -d \
26+
-p 3000:3000 \
27+
-v openbb-data:/data \
28+
-e FRONTENDURL=https://workspace.example.com \
29+
-e PROURL=https://workspace.example.com \
30+
-e SELFURL=https://workspace.example.com/api \
31+
--name openbb \
32+
lite.openbb.co/openbb-lite:<version>
33+
```
34+
35+
Use HTTPS for shared deployments.
36+
37+
## Host Port
38+
39+
If port `3000` is already in use on the host, map a different host port to the container port:
40+
41+
```bash
42+
docker run -d \
43+
-p 8080:3000 \
44+
-v openbb-data:/data \
45+
--name openbb \
46+
lite.openbb.co/openbb-lite:<version>
47+
```
48+
49+
Open Workspace Lite at `http://localhost:8080`.
50+
51+
## Initial Admin Account
52+
53+
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:
54+
55+
```bash
56+
docker run -d \
57+
-p 3000:3000 \
58+
-v openbb-data:/data \
59+
-e OPENBB_ADMIN_EMAIL=admin@example.com \
60+
-e OPENBB_ADMIN_PASSWORD='replace-with-a-strong-password' \
61+
--name openbb \
62+
lite.openbb.co/openbb-lite:<version>
63+
```
64+
65+
Set these values before the first start of a new `/data` volume.
66+
67+
## Apps Marketplace
68+
69+
The Apps Marketplace tab is available in Workspace Lite. Marketplace browsing requires outbound access to OpenBB's marketplace service.
70+
71+
Hide the Marketplace tab by starting the container with `UI_SHOW_MARKETPLACE=false`:
72+
73+
```bash
74+
docker run -d \
75+
-p 3000:3000 \
76+
-v openbb-data:/data \
77+
-e UI_SHOW_MARKETPLACE=false \
78+
--name openbb \
79+
lite.openbb.co/openbb-lite:<version>
80+
```
81+
82+
## Workspace MCP
83+
84+
Workspace Lite comes with the MCP companion enabled. See the [Workspace MCP overview](/agents/workspace-mcp-overview) for the user-facing MCP workflow.
85+
86+
Hide the MCP companion by starting the container with `UI_SHOW_COMPANION_MCP_MODE=false`:
87+
88+
```bash
89+
docker run -d \
90+
-p 3000:3000 \
91+
-v openbb-data:/data \
92+
-e UI_SHOW_COMPANION_MCP_MODE=false \
93+
--name openbb \
94+
lite.openbb.co/openbb-lite:<version>
95+
```
96+
97+
Disable the default MCP server for new users with `MCP_DEFAULT_SERVER_ENABLED=false`:
98+
99+
```bash
100+
docker run -d \
101+
-p 3000:3000 \
102+
-v openbb-data:/data \
103+
-e MCP_DEFAULT_SERVER_ENABLED=false \
104+
--name openbb \
105+
lite.openbb.co/openbb-lite:<version>
106+
```
107+
108+
If Workspace Lite runs behind a reverse proxy, allow long-lived HTTP responses and WebSocket upgrades for `/api/pro/workspace-mcp`.
109+
110+
## Other Controls
111+
112+
| Variable | Default | Purpose |
113+
| --- | --- | --- |
114+
| `PORT` | `3000` | Container listen port |
115+
| `BACKEND_URL` | `/api` | Frontend API base URL |
116+
| `FRONTENDURL` | `http://localhost:3000` | Public Workspace URL |
117+
| `SELFURL` | `http://localhost:3000/api` | Public API URL |
118+
| `PROURL` | `http://localhost:3000` | Workspace public URL |
119+
| `AI_COPILOT_ENABLED` | `true` | Show Copilot UI |
120+
| `AI_COPILOT_AI_ENHANCEMENTS` | `true` | Enable AI enhancement UI |
121+
| `DATA_ALLOW_HTML_JS_EXECUTION` | `true` | Allow HTML widgets to execute JavaScript |

‎content/workspace/getting-started/lite/index.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
title: Workspace Lite
3+
sidebar_position: 1
4+
description: Run OpenBB Workspace Lite as a self-hosted workspace for small investment teams.
5+
keywords:
6+
- OpenBB Workspace Lite
7+
- Workspace Lite
8+
- self-hosted workspace
9+
- Docker
10+
- small investment teams
11+
---
12+
13+
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
14+
15+
<HeadTitle title="Workspace Lite | OpenBB Workspace Docs" />
16+
17+
# Workspace Lite
18+
19+
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.
20+
21+
## Who It Is For
22+
23+
Workspace Lite is designed for smaller self-hosted deployments among teams of roughly 1-20 people.
24+
25+
It fits teams that:
26+
27+
- Have at least one data source to connect, such as a database, data feed, or internal API.
28+
- Need to share dashboards, apps, and agent-compatible analysis across a small team.
29+
- Want to run Workspace inside their own environment for compliance reasons.
30+
- Can operate a Docker container but do not want to run a Kubernetes-based enterprise deployment.
31+
32+
The strongest trigger is usually one of these:
33+
34+
- "I have been using the community tier and need to make this official for my whole team."
35+
- "I want to run this internally for compliance reasons."
36+
37+
## Who It Is Not For
38+
39+
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.
40+
41+
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.
42+
43+
## Feature Set
44+
45+
Workspace Lite uses email and password for authentication.
46+
47+
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.
48+
49+
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).
50+
51+
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).
52+
53+
## Next Steps
54+
55+
Install Workspace Lite:
56+
57+
[Install Workspace Lite](/workspace/getting-started/lite/installation)
58+
59+
Configure Workspace Lite:
60+
61+
[Configure Workspace Lite](/workspace/getting-started/lite/configuration)
62+
63+
Operate, back up, and update Workspace Lite:
64+
65+
[Operate Workspace Lite](/workspace/getting-started/lite/operations)

‎content/workspace/getting-started/lite/installation.md‎

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
---
2+
title: Install Workspace Lite
3+
sidebar_position: 2
4+
description: Pull and run OpenBB Workspace Lite from the private container registry.
5+
keywords:
6+
- OpenBB Workspace Lite install
7+
- Workspace Lite Docker
8+
- lite.openbb.co
9+
- AWS ECR login
10+
- private registry
11+
---
12+
13+
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
14+
15+
<HeadTitle title="Install Workspace Lite | OpenBB Workspace Docs" />
16+
17+
# Install Workspace Lite
18+
19+
OpenBB Workspace Lite is delivered through the private container registry. OpenBB provides registry credentials.
20+
21+
The commands below use the private container registry path:
22+
23+
```text
24+
lite.openbb.co/openbb-lite:<version>
25+
```
26+
27+
Replace `<version>` with the image tag from your OpenBB release instructions.
28+
29+
## Requirements
30+
31+
You need:
32+
33+
- [Docker](https://docs.docker.com/get-started/get-docker/) installed and running.
34+
- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) installed locally.
35+
- Registry credentials provided by OpenBB.
36+
- Network access from the host to `lite.openbb.co`.
37+
38+
You do not need your own AWS account. The AWS credentials provided by OpenBB authorize registry access for the Workspace Lite image.
39+
40+
## Configure Registry Credentials
41+
42+
Create a dedicated AWS CLI profile for the registry credentials:
43+
44+
```bash
45+
aws configure --profile openbb-lite
46+
```
47+
48+
Enter the access key ID, secret access key, and region provided by OpenBB. Unless OpenBB gives you a different region, use:
49+
50+
```text
51+
us-east-1
52+
```
53+
54+
## Log In To The Registry
55+
56+
Authenticate Docker to the private registry:
57+
58+
```bash
59+
aws ecr get-login-password --region us-east-1 --profile openbb-lite | docker login --username AWS --password-stdin lite.openbb.co
60+
```
61+
62+
A successful login prints:
63+
64+
```text
65+
Login Succeeded
66+
```
67+
68+
## Pull The Image
69+
70+
Pull the image using the tag from your OpenBB instructions email:
71+
72+
```bash
73+
docker pull lite.openbb.co/openbb-lite:<version>
74+
```
75+
76+
If you need a platform-specific image, include the platform architecture in the pull command. For example:
77+
78+
```bash
79+
docker pull --platform linux/amd64 lite.openbb.co/openbb-lite:<version>
80+
```
81+
82+
## Start Workspace Lite
83+
84+
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.
85+
86+
Run the container with a persistent Docker volume:
87+
88+
```bash
89+
docker run -d \
90+
-p 3000:3000 \
91+
-v openbb-data:/data \
92+
--name openbb \
93+
lite.openbb.co/openbb-lite:<version>
94+
```
95+
96+
Open Workspace Lite at:
97+
98+
```text
99+
http://localhost:3000
100+
```
101+
102+
The first start generates an admin account and runtime secrets. Read the generated admin credentials from the container logs:
103+
104+
```bash
105+
docker logs openbb
106+
```
107+
108+
The credentials are also stored inside the container volume at:
109+
110+
```text
111+
/data/secrets.env
112+
```
113+
114+
Keep this file private. It contains the generated admin password and runtime secrets.
115+
116+
## Stop And Start
117+
118+
Stop the container:
119+
120+
```bash
121+
docker stop openbb
122+
```
123+
124+
Start it again:
125+
126+
```bash
127+
docker start openbb
128+
```
129+
130+
The `/data` volume keeps the database, uploaded files, and generated secrets across restarts.
131+
132+
## Troubleshooting
133+
134+
If `docker login` fails, confirm the AWS profile, region, and registry hostname:
135+
136+
```bash
137+
aws ecr get-login-password --region us-east-1 --profile openbb-lite
138+
```
139+
140+
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.
141+
142+
If the container starts but the page does not load, inspect the logs:
143+
144+
```bash
145+
docker logs openbb
146+
```

0 commit comments

Comments
 (0)