Skip to content

Commit 7a34c11

Browse files
authored
Feat: v4 self-hosting (#2155)
* self-hosting stuff goes in /hosting * add v4 tags * add main compose file * draft overview * add webapp env vars * overview tweaks * add supervisor env vars * move old docker guide * new sidebar structure * update github actions docs * docker draft * use env vars for s3 creds * this might just work * split into multiple files * update guide * document machine overrides * split legacy docs into different section * some fixes * some tweaks * add login and init instructions * don't cursorignore .env.example
1 parent 2b3d54a commit 7a34c11

26 files changed

+1091
-11
lines changed

.cursorignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@ apps/coordinator/
55
packages/rsc/
66
.changeset
77
.zed
8-
.env
8+
.env
9+
!.env.example

docker/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Internal Docker files
2+
3+
If you're looking for self-hosting files you're in the wrong place. Have a look [here](../hosting/).

docs/cli-preview-archive.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: "CLI preview archive command"
33
sidebarTitle: "preview archive"
44
description: "The `trigger.dev preview archive` command can be used to archive a preview branch."
5+
tag: "v4"
56
---
67

78
import UpgradeToV4Note from "/snippets/upgrade-to-v4-note.mdx";

docs/deployment/preview-branches.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "Preview branches"
33
description: "Create isolated environments for each branch of your code, allowing you to test changes before merging to production. You can create preview branches manually or automatically from your git branches."
4+
tag: "v4"
45
---
56

67
import UpgradeToV4Note from "/snippets/upgrade-to-v4-note.mdx";

docs/docs.json

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -171,14 +171,25 @@
171171
]
172172
},
173173
{
174-
"group": "Open source",
174+
"group": "Self-hosting",
175175
"pages": [
176-
"open-source-self-hosting",
177-
"open-source-contributing",
178-
"github-repo",
179-
"changelog",
180-
"roadmap"
181-
]
176+
"self-hosting/overview",
177+
"self-hosting/docker",
178+
{
179+
"group": "Environment variables",
180+
"pages": ["self-hosting/env/webapp", "self-hosting/env/supervisor"]
181+
}
182+
],
183+
"tags": ["v4"],
184+
"tag": "v4"
185+
},
186+
{
187+
"group": "Self-hosting",
188+
"pages": ["open-source-self-hosting"]
189+
},
190+
{
191+
"group": "Open source",
192+
"pages": ["open-source-contributing", "github-repo", "changelog", "roadmap"]
182193
},
183194
{
184195
"group": "Help",

docs/github-actions.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,10 @@ When self-hosting, you will have to take a few additional steps:
130130
- Add your registry credentials to the GitHub secrets.
131131
- Use the `--self-hosted` and `--push` flags when deploying.
132132

133+
<Tip>
134+
If you're self-hosting v4, the `--self-hosted` and `--push` flags are **NOT** needed.
135+
</Tip>
136+
133137
Other than that, your GitHub action file will look very similar to the one above:
134138

135139
<CodeGroup>

docs/guides/example-projects/human-in-the-loop-workflow.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: "Human-in-the-loop workflow with ReactFlow and Trigger.dev waitpoint tokens"
33
sidebarTitle: "Human-in-the-loop workflow"
44
description: "This example project creates audio summaries of newspaper articles using a human-in-the-loop workflow built with ReactFlow and Trigger.dev waitpoint tokens."
5+
tag: "v4"
56
---
67

78
import UpgradeToV4Note from "/snippets/upgrade-to-v4-note.mdx";

docs/guides/example-projects/meme-generator-human-in-the-loop.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: "Meme generator with human-in-the-loop approval"
33
sidebarTitle: "AI meme generator"
44
description: "This example project creates memes using OpenAI's DALL-E 3 with a human-in-the-loop approval workflow built using Trigger.dev waitpoint tokens."
5+
tag: "v4"
56
---
67

78
import UpgradeToV4Note from "/snippets/upgrade-to-v4-note.mdx";

docs/limits.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The number of queued tasks by environment.
3939

4040
| Pricing tier | Limit |
4141
| :----------- | :----------------- |
42-
| Free | 10 per project |
42+
| Free | 10 per project |
4343
| Hobby | 100 per project |
4444
| Pro | 1,000+ per project |
4545

docs/open-source-self-hosting.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
2-
title: "Self-hosting"
3-
description: "You can self-host Trigger.dev on your own infrastructure."
2+
title: "Docker (legacy)"
3+
description: "You can self-host Trigger.dev on your own infrastructure using Docker."
44
---
55

6+
<Tip>This guide is for v3, you can find the v4 guide [here](/self-hosting/docker).</Tip>
7+
68
<Warning>Security, scaling, and reliability concerns are not fully addressed here. This guide is meant for evaluation purposes and won't result in a production-ready deployment.</Warning>
79

810
<Note>This guide is for Docker only. We don't currently provide documentation for Kubernetes.</Note>

0 commit comments

Comments
 (0)