Skip to content

Commit 8b6da38

Browse files
nicktrnericallam
authored andcommitted
add self-hosting update section
1 parent 3b97aa1 commit 8b6da38

File tree

1 file changed

+44
-3
lines changed

1 file changed

+44
-3
lines changed

docs/open-source-self-hosting.mdx

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -284,12 +284,44 @@ echo "FORCE_CHECKPOINT_SIMULATION=0" >> .env
284284
./stop.sh worker && ./start.sh worker
285285
```
286286

287-
## Telemetry
287+
## Updating
288288

289-
By default, the Trigger.dev webapp sends telemetry data to our servers. This data is used to improve the product and is not shared with third parties. If you would like to opt-out of this, you can set the `TRIGGER_TELEMETRY_DISABLED` environment variable in your `.env` file. The value doesn't matter, it just can't be empty. For example:
289+
Once you have everything set up, you will periodically want to update your Docker images. You can easily do this by running the update script and restarting your services:
290290

291291
```bash
292-
TRIGGER_TELEMETRY_DISABLED=1
292+
./update.sh
293+
./stop.sh && ./start.sh
294+
```
295+
296+
Sometimes, we will make more extensive changes that require pulling updated compose files, scripts, etc from our docker repo:
297+
298+
```bash
299+
git pull
300+
./stop.sh && ./start.sh
301+
```
302+
303+
Occasionally, you may also have to update your `.env` file, but we will try to keep these changes to a minimum. Check the `.env.example` file for new variables.
304+
305+
### From beta
306+
307+
If you're coming from the beta CLI package images, you will need to:
308+
- **Pull changes from our docker repo.** We've added a new container for [Electric](https://github.com/electric-sql/electric) and made some other improvements.
309+
310+
```bash
311+
# wherever you cloned the docker repo
312+
git pull && ./stop.sh && ./start.sh
313+
```
314+
315+
## Version locking
316+
317+
There are several reasons to lock the version of your Docker images:
318+
- **Backwards compatibility.** We try our best to maintain compatibility with older CLI versions, but it's not always possible. If you don't want to update your CLI, you can lock your Docker images to that specific version.
319+
- **Ensuring full feature support.** Sometimes, new CLI releases will also require new or updated platform features. Running unlocked images can make any issues difficult to debug. Using a specific tag can help here as well.
320+
321+
By default, the images will point at the latest versioned release via the `v3` tag. You can override this by specifying a different tag in your `.env` file. For example:
322+
323+
```bash
324+
TRIGGER_IMAGE_TAG=v3.0.5
293325
```
294326

295327
## CLI usage
@@ -351,3 +383,12 @@ When running the CLI in a CI environment, your login profiles won't be available
351383
variables to point at your self-hosted instance and authenticate.
352384

353385
For more detailed instructions, see the [GitHub Actions guide](/github-actions).
386+
387+
388+
## Telemetry
389+
390+
By default, the Trigger.dev webapp sends telemetry data to our servers. This data is used to improve the product and is not shared with third parties. If you would like to opt-out of this, you can set the `TRIGGER_TELEMETRY_DISABLED` environment variable in your `.env` file. The value doesn't matter, it just can't be empty. For example:
391+
392+
```bash
393+
TRIGGER_TELEMETRY_DISABLED=1
394+
```

0 commit comments

Comments
 (0)