@@ -85,50 +85,54 @@ These options are available on most commands.
8585
8686### Self-hosting
8787
88- These options are typically used when [ self-hosting] ( /open-source-self-hosting ) or for local development.
88+ These options are used when [ self-hosting] ( /open-source-self-hosting ) or for local development.
8989
90- <ParamField body = " Self-hosted (builds locally)" type = " --self-hosted" >
91- 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.
90+ <ParamField body = " Local build" type = " --local-build" >
91+ Build the deployment image locally using your local Docker instead of using the remote build service.
9492</ParamField >
9593
96- <ParamField body = " Skip deploying the image" type = " --skip-deploy | -D " >
97- Load the built image into your local docker .
94+ <ParamField body = " Load image" type = " --load " >
95+ Load the built image into your local Docker after building it .
9896</ParamField >
9997
100- <ParamField body = " Load image" type = " --load-image" >
101- Loads the image into your local docker after building it.
102- </ParamField >
103-
104- <ParamField body = " Registry" type = " --registry" >
105- Specify the registry to push the image to when using ` --self-hosted ` . Will automatically enable
106- ` --push ` .
98+ <ParamField body = " Push image" type = " --push" >
99+ Push the image to the registry after building locally.
107100</ParamField >
108101
109- <ParamField body = " Push image " type = " --push " >
110- When using the ` --self-hosted ` flag, push the image to the registry .
102+ <ParamField body = " Network " type = " --network " >
103+ The networking mode for RUN instructions when building locally. Options: ` default ` , ` none ` , ` host ` .
111104</ParamField >
112105
113- <ParamField body = " 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.
106+ <ParamField body = " Native build server" type = " --native-build-server" >
107+ Use the native build server for building the image. This uploads your project files and builds remotely.
116108</ParamField >
117109
118- <ParamField body = " Network " type = " --network " >
119- The networking mode for RUN instructions when using ` --self-hosted ` .
110+ <ParamField body = " Detach " type = " --detach " >
111+ Return immediately after the deployment is queued, without waiting for the build to complete. Implies ` --native-build-server ` .
120112</ParamField >
121113
122114## Examples
123115
124- ### Push to Docker Hub (self-hosted)
116+ ### Self-hosted deployment
117+
118+ For self-hosted deployments, set your ` TRIGGER_ACCESS_TOKEN ` and use the ` --api-url ` option to point to your self-hosted instance:
119+
120+ ``` bash
121+ TRIGGER_ACCESS_TOKEN=your_token npx trigger.dev@latest deploy --api-url https://your-trigger-instance.com
122+ ```
123+
124+ ### Local build with Docker
125+
126+ Build the image locally and load it into your local Docker:
127+
128+ ``` bash
129+ npx trigger.dev@latest deploy --local-build --load
130+ ```
131+
132+ ### Local build and push to registry
125133
126- An example of deploying to Docker Hub when using a self-hosted setup :
134+ Build the image locally and push it to your configured registry :
127135
128136``` bash
129- npx trigger.dev@latest deploy \
130- --self-hosted \
131- --load-image \
132- --registry docker.io \
133- --namespace mydockerhubusername
137+ npx trigger.dev@latest deploy --local-build --push
134138```
0 commit comments