You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: fix self-hosting section in deploy docs (#2836)
Fixes#2835
There were still some flags in here we removed, deploying is a lot
simpler now for self-hosters.
Also updates the github actions guide.
---------
Co-authored-by: Claude <[email protected]>
Copy file name to clipboardExpand all lines: docs/github-actions.mdx
+4-13Lines changed: 4 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -134,16 +134,11 @@ You should use the version you run locally during dev and manual deploy. The cur
134
134
135
135
## Self-hosting
136
136
137
-
When self-hosting, you will have to take a few additional steps:
137
+
When self-hosting, you need to:
138
138
139
-
- Specify the `TRIGGER_API_URL` environment variable. You can add it to the GitHub secrets the same way as the access token. This should point at your webapp domain, for example: `https://trigger.example.com`
140
-
- Setup docker as you will need to build and push the image to your registry. On [Trigger.dev Cloud](https://cloud.trigger.dev) this is all done remotely.
139
+
- Set up Docker Buildx in your CI environment for building images locally.
141
140
- Add your registry credentials to the GitHub secrets.
142
-
- Use the `--self-hosted` and `--push` flags when deploying.
143
-
144
-
<Tip>If you're self-hosting v4, the `--self-hosted` and `--push` flags are **NOT** needed.</Tip>
145
-
146
-
Other than that, your GitHub action file will look very similar to the one above:
141
+
- Specify the `TRIGGER_API_URL` environment variable pointing to your webapp domain, for example: `https://trigger.example.com`
Builds and loads the image using your local docker. Use the `--registry` option to specify the
92
-
registry to push the image to when using `--self-hosted`, or just use `--push` to push to the
93
-
default registry.
94
-
</ParamField>
95
-
96
-
<ParamFieldbody="Skip deploying the image"type="--skip-deploy | -D">
97
-
Load the built image into your local docker.
98
-
</ParamField>
99
-
100
-
<ParamFieldbody="Load image"type="--load-image">
101
-
Loads the image into your local docker after building it.
102
-
</ParamField>
103
-
104
-
<ParamFieldbody="Registry"type="--registry">
105
-
Specify the registry to push the image to when using `--self-hosted`. Will automatically enable
106
-
`--push`.
107
-
</ParamField>
108
-
109
-
<ParamFieldbody="Push image"type="--push">
110
-
When using the `--self-hosted` flag, push the image to the registry.
111
-
</ParamField>
112
-
113
-
<ParamFieldbody="Namespace"type="--namespace">
114
-
The namespace to use when pushing the image to the registry. For example, if pushing to Docker
115
-
Hub, the namespace is your Docker Hub username.
116
-
</ParamField>
117
-
118
-
<ParamFieldbody="Network"type="--network">
119
-
The networking mode for RUN instructions when using `--self-hosted`.
120
-
</ParamField>
121
-
122
-
## Examples
123
-
124
-
### Push to Docker Hub (self-hosted)
125
-
126
-
An example of deploying to Docker Hub when using a self-hosted setup:
92
+
When [self-hosting](/self-hosting/overview), builds are performed locally by default. Once you've logged in to your self-hosted instance using the CLI, you can deploy with:
127
93
128
94
```bash
129
-
npx trigger.dev@latest deploy \
130
-
--self-hosted \
131
-
--load-image \
132
-
--registry docker.io \
133
-
--namespace mydockerhubusername
95
+
npx trigger.dev@latest deploy
134
96
```
97
+
98
+
For CI/CD environments, set `TRIGGER_ACCESS_TOKEN` and `TRIGGER_API_URL` environment variables. See the [GitHub Actions guide](/github-actions#self-hosting) for more details.
0 commit comments