opensource/sim
3
0
Fork 0
mirror of https://github.com/simstudioai/sim.git synced 2026-09-24 15:45:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat(setup): publish standalone self-hosting package (#6849)

Browse Source 
* feat(setup): publish standalone self-hosting package

* fix(setup): refresh discovered compose installs

* improvement(setup): unify repository command

* fix(setup): harden standalone package launch

* Update README.md

* fix(setup): isolate standalone compose installs

* fix(setup): restore default stopped installs
This commit is contained in:
Theodore Li
2026-08-19 20:04:05 -04:00
committed by GitHub
parent 04e0fe00c0
commit 1372977d07
108 changed files with 4384 additions and 2417 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/docs/content/docs/en/platform/self-hosting/docker.mdx
+5 -11
View File
@@ -10,20 +10,14 @@ import { FAQ } from '@/components/ui/faq'
## Quick Start
```bash
git clone https://github.com/simstudioai/sim.git && cd sim
cat > .env << EOF
BETTER_AUTH_SECRET=$(openssl rand -hex 32)
ENCRYPTION_KEY=$(openssl rand -hex 32)
INTERNAL_API_SECRET=$(openssl rand -hex 32)
CRON_SECRET=$(openssl rand -hex 32)
EOF
docker compose -f docker-compose.prod.yml up -d
npx @sim/setup
```
Open [http://localhost:3000](http://localhost:3000)
The setup package creates `./sim` with a generated `.env` and the production Compose file, then
starts published container images. Pass `--dir <path>` to choose another directory.
## Production Setup
### 1. Configure Environment
@@ -150,7 +144,7 @@ docker compose -f docker-compose.prod.yml logs migrations
docker compose -f docker-compose.prod.yml logs -f cron
# Upgrade: bump SIM_VERSION in .env when pinned, then
bun run sim update
npx @sim/setup update
```
<FAQ items={[
apps/docs/content/docs/en/platform/self-hosting/environment-variables.mdx
+1 -1
View File
@@ -178,7 +178,7 @@ See [Observability](/platform/self-hosting/observability).
| Variable | Description |
|----------|-------------|
| `COPILOT_API_KEY` | API key for Chat. Without it the Sim Chat block, scheduled prompt jobs, and Inbox cannot run |
| `NEXT_PUBLIC_CHAT_DISABLED` | Set to `true` to hide the Chat module: the workspace lands on your first workflow, with no chats list, scheduled tasks, or editor Chat panel. Chat is shown when unset; `bun run setup` sets it for you if you skip the chat key |
| `NEXT_PUBLIC_CHAT_DISABLED` | Set to `true` to hide the Chat module: the workspace lands on your first workflow, with no chats list, scheduled tasks, or editor Chat panel. Chat is shown when unset; `npx @sim/setup` sets it for you if you skip the chat key |
| `PII_REDACTION` | Redact PII from workflow logs via Data Retention rules; requires the PII service and a cluster-reachable `INTERNAL_API_BASE_URL` |
| `PII_GRANULAR_REDACTION` | Additionally expose the execution-altering redaction stages |
| `DURABLE_SECRET_PROVENANCE_ENFORCED_SURFACES` | Durable stores where a value whose secret provenance was never recorded fails the run instead of logging a warning. `all`, or a comma-separated subset of `memory`, `table-row`, `knowledge`. Unset (nothing enforced) by default |
apps/docs/content/docs/en/platform/self-hosting/upgrades.mdx
+2 -2
View File
@@ -142,11 +142,11 @@ kubectl logs -n simstudio deploy/sim-app -c migrations --tail=100
<Tab value="Docker Compose">
```bash
bun run sim update
npx @sim/setup update
docker compose -f docker-compose.prod.yml logs migrations
```
`bun run sim update` pulls the versions configured by `SIM_VERSION` (or `latest` when it is
`npx @sim/setup update` pulls the versions configured by `SIM_VERSION` (or `latest` when it is
unset), recreates the changed services, and keeps data volumes. It is equivalent to running
`docker compose pull` followed by `docker compose up -d`.