Skip to content

Commit f3ca838

Browse files
committed
More manual setup guide steps
1 parent c600ae8 commit f3ca838

File tree

2 files changed

+58
-71
lines changed

2 files changed

+58
-71
lines changed

docs/docs.json

Lines changed: 57 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,11 @@
1010
},
1111
"favicon": "/images/favicon.png",
1212
"contextual": {
13-
"options": ["copy", "view", "claude"]
13+
"options": [
14+
"copy",
15+
"view",
16+
"claude"
17+
]
1418
},
1519
"navigation": {
1620
"dropdowns": [
@@ -24,6 +28,7 @@
2428
"pages": [
2529
"introduction",
2630
"quick-start",
31+
"manual-setup",
2732
"video-walkthrough",
2833
"how-it-works",
2934
"limits",
@@ -35,7 +40,11 @@
3540
"pages": [
3641
{
3742
"group": "Tasks",
38-
"pages": ["tasks/overview", "tasks/schemaTask", "tasks/scheduled"]
43+
"pages": [
44+
"tasks/overview",
45+
"tasks/schemaTask",
46+
"tasks/scheduled"
47+
]
3948
},
4049
"triggering",
4150
"runs",
@@ -50,7 +59,12 @@
5059
"errors-retrying",
5160
{
5261
"group": "Wait",
53-
"pages": ["wait", "wait-for", "wait-until", "wait-for-token"]
62+
"pages": [
63+
"wait",
64+
"wait-for",
65+
"wait-until",
66+
"wait-for-token"
67+
]
5468
},
5569
"queue-concurrency",
5670
"versioning",
@@ -96,7 +110,9 @@
96110
},
97111
{
98112
"group": "Development",
99-
"pages": ["cli-dev"]
113+
"pages": [
114+
"cli-dev"
115+
]
100116
},
101117
{
102118
"group": "Deployment",
@@ -108,7 +124,9 @@
108124
"deployment/atomic-deployment",
109125
{
110126
"group": "Deployment integrations",
111-
"pages": ["vercel-integration"]
127+
"pages": [
128+
"vercel-integration"
129+
]
112130
}
113131
]
114132
},
@@ -161,7 +179,12 @@
161179
},
162180
{
163181
"group": "Using the Dashboard",
164-
"pages": ["run-tests", "troubleshooting-alerts", "replaying", "bulk-actions"]
182+
"pages": [
183+
"run-tests",
184+
"troubleshooting-alerts",
185+
"replaying",
186+
"bulk-actions"
187+
]
165188
},
166189
{
167190
"group": "Troubleshooting",
@@ -183,23 +206,39 @@
183206
"self-hosting/kubernetes",
184207
{
185208
"group": "Environment variables",
186-
"pages": ["self-hosting/env/webapp", "self-hosting/env/supervisor"]
209+
"pages": [
210+
"self-hosting/env/webapp",
211+
"self-hosting/env/supervisor"
212+
]
187213
}
188214
],
189-
"tags": ["v4"],
215+
"tags": [
216+
"v4"
217+
],
190218
"tag": "v4"
191219
},
192220
{
193221
"group": "Self-hosting",
194-
"pages": ["open-source-self-hosting"]
222+
"pages": [
223+
"open-source-self-hosting"
224+
]
195225
},
196226
{
197227
"group": "Open source",
198-
"pages": ["open-source-contributing", "github-repo", "changelog", "roadmap"]
228+
"pages": [
229+
"open-source-contributing",
230+
"github-repo",
231+
"changelog",
232+
"roadmap"
233+
]
199234
},
200235
{
201236
"group": "Help",
202-
"pages": ["community", "help-slack", "help-email"]
237+
"pages": [
238+
"community",
239+
"help-slack",
240+
"help-email"
241+
]
203242
}
204243
]
205244
},
@@ -220,7 +259,10 @@
220259
},
221260
{
222261
"group": "Tasks API",
223-
"pages": ["management/tasks/trigger", "management/tasks/batch-trigger"]
262+
"pages": [
263+
"management/tasks/trigger",
264+
"management/tasks/batch-trigger"
265+
]
224266
},
225267
{
226268
"group": "Runs API",
@@ -266,7 +308,9 @@
266308
"groups": [
267309
{
268310
"group": "Introduction",
269-
"pages": ["guides/introduction"]
311+
"pages": [
312+
"guides/introduction"
313+
]
270314
},
271315
{
272316
"group": "Frameworks",

docs/manual-setup.mdx

Lines changed: 1 addition & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This guide covers how to manually set up Trigger.dev in your project, including
77

88
## Prerequisites
99

10-
- Node.js 18+ (or Bun runtime)
10+
- Node.js 18.20+ (or Bun runtime)
1111
- A Trigger.dev account (sign up at [trigger.dev](https://trigger.dev))
1212
- TypeScript 5.0.4 or later (for TypeScript projects)
1313

@@ -618,63 +618,6 @@ npx trigger.dev@v4-beta dev
618618
turbo run dev:trigger --filter=web
619619
```
620620

621-
### Nx Monorepo
622-
623-
For Nx monorepos, you can use a similar pattern with libraries:
624-
625-
#### 1. Create a tasks library
626-
627-
```bash
628-
nx generate @nx/js:library tasks --directory=libs/tasks
629-
```
630-
631-
#### 2. Add Trigger.dev configuration
632-
633-
**`libs/tasks/trigger.config.ts`**:
634-
635-
```typescript
636-
import { defineConfig } from "@trigger.dev/sdk";
637-
638-
export default defineConfig({
639-
project: "<your-project-ref>",
640-
dirs: ["./src/lib/trigger"],
641-
});
642-
```
643-
644-
#### 3. Update project configuration
645-
646-
**`libs/tasks/project.json`**:
647-
648-
```json
649-
{
650-
"targets": {
651-
"dev:trigger": {
652-
"executor": "nx:run-commands",
653-
"options": {
654-
"command": "npx trigger.dev@v4-beta dev",
655-
"cwd": "libs/tasks"
656-
}
657-
},
658-
"deploy:trigger": {
659-
"executor": "nx:run-commands",
660-
"options": {
661-
"command": "npx trigger.dev@v4-beta deploy",
662-
"cwd": "libs/tasks"
663-
}
664-
}
665-
}
666-
}
667-
```
668-
669-
### Environment variables in monorepos
670-
671-
Each package or app that uses Trigger.dev needs access to the environment variables:
672-
673-
- For the **tasks package approach**: Set environment variables in the tasks package directory
674-
- For the **app-based approach**: Set environment variables in each app that uses Trigger.dev
675-
676-
You can also set environment variables at the root level and have them inherited by all packages.
677-
678621
## Example projects
679622

680623
You can find a growing list of example projects in our [examples](/guides/introduction) section.

0 commit comments

Comments
 (0)