switchboard/core
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Releases 9 Wiki Activity

Curate default bundled packages to core set of 8

Browse Source 
Previously all 23 bundled .pkg archives auto-installed on first boot.
Now only the curated default set installs: notes, chat-core, workflow-chat,
dashboard, and 4 demo workflows. Other packages still ship in the image
and can be enabled via BUNDLED_PACKAGES env var (or "*" for all).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Jeffrey Smith
2026-03-30 18:29:28 +00:00
parent 8092f00fbe
commit 0a6879b6ae
3 changed files with 72 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
docs/DISTRIBUTION.md
View File

@@ -14,42 +14,66 @@ On first run, bundled packages are automatically installed — workflows, surfac
## Bundled Packages
The production Docker image ships with pre-built packages that are auto-installed on first boot:
The production Docker image ships with pre-built packages. A **curated default set** is auto-installed on first boot; additional packages ship in the image and can be opted-in via `BUNDLED_PACKAGES`.
#### Default Set (auto-installed)
| Package | Type | Description |
|---------|------|-------------|
| notes | surface | Markdown notes with graph view |
| chat-core | library | Conversations, messages, read cursors |
| workflow-chat | extension | Chat integration for workflow stages |
| dashboard | surface | Dashboard surface |
| workflow-demo | surface | Interactive walkthrough with diagrams |
| bug-report-triage | workflow | Public entry, severity routing, SLA timers |
| content-approval | workflow | Multi-party signoff example |
| employee-onboarding | workflow | Automated provisioning + manager signoff |
| webhook-notifier | workflow | HTTP outbound via connections + Starlark |
| workflow-demo | surface | Interactive walkthrough with diagrams |
| hello-dashboard | surface | Welcome/getting started surface |
| schedules | surface | Cron task management UI |
#### Opt-in (ship in image, require `BUNDLED_PACKAGES` to enable)
| Package | Type | Description |
|---------|------|-------------|
| tasks | full | Kanban/list task manager with webhooks |
| schedules | surface | Cron task management UI |
| editor | surface | Rich markdown editor |
| hello-dashboard | surface | Welcome/getting started surface |
| team-activity-log | surface | Team activity feed |
| webhook-notifier | workflow | HTTP outbound via connections + Starlark |
| csv-table | extension | CSV table renderer |
| diff-viewer | extension | Diff visualization |
| git-board | surface | Git board interface |
| gitea-client | library | Gitea API integration library |
| js-sandbox | extension | JavaScript sandbox |
| katex-renderer | extension | LaTeX rendering |
| mermaid-renderer | extension | Diagram rendering |
| regex-tester | extension | Regex testing tool |
| icd-test-runner | surface | E2E API test suite |
| sdk-test-runner | surface | SDK feature test suite |
### Behavior
- **First boot**: All bundled packages are installed and enabled automatically.
- **First boot**: Curated default packages are installed and enabled automatically.
- **Subsequent boots**: No-op — already-installed packages are skipped.
- **Admin uninstalls a package**: It stays uninstalled. Bundled packages are never force-reinstalled.
- **To re-install**: Delete the package from the database, then restart the container.
### Selecting Packages (Allowlist)
Set `BUNDLED_PACKAGES` to a comma-separated list of package IDs to install only a subset:
Set `BUNDLED_PACKAGES` to control which packages are installed:
```bash
# K8s / Helm — install only core surfaces, no demo/test packages
# Install ALL packages (everything in the image)
docker run -p 8080:80 \
-e BUNDLED_PACKAGES="tasks,schedules,hello-dashboard" \
-e BUNDLED_PACKAGES="*" \
ghcr.io/switchboard-core/switchboard-core:latest
# Install specific packages only
docker run -p 8080:80 \
-e BUNDLED_PACKAGES="notes,tasks,schedules" \
ghcr.io/switchboard-core/switchboard-core:latest
```
Empty (default) means install all bundled packages. This is useful for Helm charts where different environments need different packages.
Empty (default) installs the curated default set. Use `*` to install all packages. This is useful for Helm charts where different environments need different packages.
### Disabling Auto-Install
@@ -149,7 +173,7 @@ docker build -t my-switchboard .
| `STORAGE_PATH` | `/data/storage` | PVC mount point |
| `BASE_PATH` | | URL prefix (e.g. `/switchboard`) |
| `SKIP_BUNDLED_PACKAGES` | `false` | Disable auto-install of bundled packages |
| `BUNDLED_PACKAGES` | (empty = all) | Comma-separated allowlist of package IDs to install |
| `BUNDLED_PACKAGES` | (empty = defaults) | `""` curated defaults, `"*"` all, or comma-separated IDs |
| `BUNDLED_PACKAGES_DIR` | `/app/bundled-packages` | Override bundled packages location |
| `LOG_FORMAT` | `text` | `text` or `json` |
| `LOG_LEVEL` | `info` | `debug`, `info`, `warn`, `error` |