Skip to content

chore(docs): Admin requirements for creating worker groups #2925

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ericallam merged 2 commits into from
Jan 24, 2026
Merged

chore(docs): Admin requirements for creating worker groups #2925

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37a9a31
clarifying admin requirements
isshaddad Jan 21, 2026
471d486
multiple environment docs update
isshaddad Jan 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/guides/examples/puppeteer.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ In this example we use [Puppeteer](https://pptr.dev/) with a [BrowserBase](https
<Warning>
When web scraping, you MUST use the technique below which uses a proxy with Puppeteer. Direct
scraping without using `browserWSEndpoint` is prohibited and will result in account suspension.
Screenshots are also prohibited when scraping.
</Warning>
Comment on lines 153 to 157
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check if the shared ScrapingWarning snippet also includes the screenshot prohibition
fd -t f "web-scraping-warning.mdx" --exec cat {}

Repository: triggerdotdev/trigger.dev

Length of output: 437

Update the shared warning snippet for consistency.

The local warning block at lines 153-157 correctly includes "Screenshots are also prohibited when scraping." However, the shared snippet at /snippets/web-scraping-warning.mdx does not contain this policy. Update the shared snippet to include the screenshot prohibition so the policy is communicated consistently across all pages that import it.

🤖 Prompt for AI Agents 
In `@docs/guides/examples/puppeteer.mdx` around lines 153 - 157, The shared
snippet web-scraping-warning.mdx is missing the sentence "Screenshots are also
prohibited when scraping."—update that snippet to match the local warning in
docs/guides/examples/puppeteer.mdx by adding the exact sentence into the
<Warning> block so all pages importing /snippets/web-scraping-warning.mdx
consistently state that screenshots are prohibited when scraping.


### Task code
Expand Down
24 changes: 24 additions & 0 deletions docs/self-hosting/docker.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,30 @@ docker compose down
docker compose up -d
```

### Creating additional worker groups

To create additional worker groups beyond the bootstrap group, use the admin API endpoint. This requires admin privileges.

**Making a user admin:**
- **New users**: Set `ADMIN_EMAILS` environment variable (regex pattern) before user creation.
- **Existing users**: Set `admin = true` in the `user` table in your database.

**Creating a worker group:**

```bash
api_url=http://localhost:8030
wg_name=my-worker
admin_pat=tr_pat_...

curl -X POST \
"$api_url/admin/api/v1/workers" \
-H "Authorization: Bearer $admin_pat" \
-H "Content-Type: application/json" \
-d "{\"name\": \"$wg_name\"}"
```

The response includes a `token` field if the worker group is newly created.

## Registry setup

The registry is used to store and pull deployment images. When testing the stack locally, the defaults should work out of the box.
Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosting/env/webapp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,5 +142,5 @@ mode: "wide"
| `OPENAI_API_KEY` | No | — | OpenAI API key. |
| `MACHINE_PRESETS_OVERRIDE_PATH` | No | — | Path to machine presets override file. See [machine overrides](/self-hosting/overview#machine-overrides). |
| `APP_ENV` | No | `NODE_ENV` | App environment. Used for things like the title tag. |
| `ADMIN_EMAILS` | No | — | Regex of user emails to automatically promote to admin. |
| `ADMIN_EMAILS` | No | — | Regex of user emails to automatically promote to admin on signup. Does not apply to existing users. |
| `EVENT_LOOP_MONITOR_ENABLED` | No | 1 | Node.js event loop lag monitor. |