Skip to content

Commit 665ccf8

Browse files
committed
Update github actions and self-hosting docs
1 parent 1ff7b86 commit 665ccf8

File tree

2 files changed

+23
-24
lines changed

2 files changed

+23
-24
lines changed

docs/github-actions.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ on:
1919
push:
2020
branches:
2121
- main
22-
paths:
23-
- "trigger/**"
2422

2523
jobs:
2624
deploy:
@@ -145,8 +143,6 @@ on:
145143
push:
146144
branches:
147145
- main
148-
paths:
149-
- "trigger/**"
150146
151147
jobs:
152148
deploy:

docs/open-source-self-hosting.mdx

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: "Self-hosting"
33
description: "You can self-host Trigger.dev on your own infrastructure."
44
---
55

6+
<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>
7+
68
<Note>This guide is for Docker only. We don't currently provide documentation for Kubernetes.</Note>
79

810
## Overview
@@ -23,27 +25,18 @@ It's dangerous to go alone! Join the self-hosting channel on our [Discord server
2325

2426
<Note>The v3 worker components don't have ARM support yet.</Note>
2527

26-
This guide outlines a quick way to start self-hosting Trigger.dev. Scaling, security, and reliability concerns are not fully addressed here. It's unlikely to result in a production-ready deployment on its own, but it's a good starting point.
28+
This guide outlines a quick way to start self-hosting Trigger.dev for evaluation purposes - it won't result in a production-ready deployment. Security, scaling, and reliability concerns are not fully addressed here.
2729

28-
As self-hosted deployments tend to have unique requirements and configurations, we don't provide specific advice for scaling up or improving security and reliability.
30+
As self-hosted deployments tend to have unique requirements and configurations, we don't provide specific advice for securing your deployment, scaling up, or improving reliability.
2931

3032
Should the burden ever get too much, we'd be happy to see you on [Trigger.dev cloud](https://trigger.dev/pricing) where we deal with these concerns for you.
3133

3234
<Accordion title="Please consider these additional warnings">
33-
- The Docker [checkpoint command](https://docs.docker.com/reference/cli/docker/checkpoint/) is an
34-
experimental feature which may not work as expected. It won't be enabled by default. Instead, the
35-
containers will stay up and their processes frozen. They won't consume CPU but they _will_ consume
36-
RAM. - The Docker provider does not currently enforce any resource limits. This means your tasks
37-
can consume up to the total machine CPU and RAM. Having no limits may be preferable when
38-
self-hosting, but can impact the performance of other services. - The worker components (not the
39-
tasks!) have direct access to the Docker socket. This means they can run any Docker command. To
40-
restrict access, you may want to consider using [Docker Socket
41-
Proxy](https://github.com/Tecnativa/docker-socket-proxy). - The task containers are running with
42-
host networking. This means there is no network isolation between them and the host machine. They
43-
will be able to access any networked service on the host. - There is currently no support for
44-
adding multiple worker machines. This would require a more elaborate provider, or possibly a
45-
switch to Docker Swarm. This is not currently planned, but you are welcome to
46-
[contribute](https://github.com/triggerdotdev/trigger.dev/blob/main/CONTRIBUTING.md).
35+
- The [docker checkpoint](https://docs.docker.com/reference/cli/docker/checkpoint/) command is an experimental feature which may not work as expected. It won't be enabled by default. Instead, the containers will stay up and their processes frozen. They won't consume CPU but they _will_ consume RAM.
36+
- The `docker-provider` does not currently enforce any resource limits. This means your tasks can consume up to the total machine CPU and RAM. Having no limits may be preferable when self-hosting, but can impact the performance of other services.
37+
- The worker components (not the tasks!) have direct access to the Docker socket. This means they can run any Docker command. To restrict access, you may want to consider using [Docker Socket Proxy](https://github.com/Tecnativa/docker-socket-proxy).
38+
- The task containers are running with host networking. This means there is no network isolation between them and the host machine. They will be able to access any networked service on the host.
39+
- There is currently no support for adding multiple worker machines, but we're working on it.
4740
</Accordion>
4841

4942
## Requirements
@@ -67,24 +60,34 @@ Some very basic steps to get started:
6760
2. [Install Docker Compose](https://docs.docker.com/compose/install/)
6861
3. [Install Ngrok](https://ngrok.com/download)
6962

70-
On a Debian server, you can install everything you need with the following commands:
71-
63+
<Accordion title="On a Debian server, you can run these commands">
7264
```bash
65+
# add ngrok repo
7366
curl -s https://ngrok-agent.s3.amazonaws.com/ngrok.asc | \
7467
sudo tee /etc/apt/trusted.gpg.d/ngrok.asc >/dev/null && \
7568
echo "deb https://ngrok-agent.s3.amazonaws.com buster main" | \
7669
sudo tee /etc/apt/sources.list.d/ngrok.list
7770

71+
# add docker repo
72+
curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc && \
73+
sudo chmod a+r /etc/apt/keyrings/docker.asc && \
74+
echo \
75+
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \
76+
$(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
77+
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
78+
79+
# update and install
7880
sudo apt-get update
7981
sudo apt-get install -y \
8082
docker.io \
81-
docker-compose \
83+
docker-compose-plugin \
8284
ngrok
8385
```
86+
</Accordion>
8487

8588
### Trigger.dev setup
8689

87-
1. Clone the [Trigger.dev docker repository](https://github.com/triggerdotdev/docker) and checkout the v3 branch
90+
1. Clone the [Trigger.dev docker repository](https://github.com/triggerdotdev/docker)
8891

8992
```bash
9093
git clone https://github.com/triggerdotdev/docker

0 commit comments

Comments
 (0)