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
Copy file name to clipboardExpand all lines: docs/pages/fund-agents-apps/run-gateway.mdx
+11-13Lines changed: 11 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -94,10 +94,7 @@ Every app and agent needs an XMTP Gateway Service.
94
94
95
95
### For browser and mobile client apps
96
96
97
-
You must run the XMTP Gateway Service written in Go. You have two options:
98
-
99
-
-**For production**: Use the [example gateway service repository](https://github.com/xmtp/gateway-service-example) as a starting point to build your own custom gateway with authentication
100
-
-**For testing only**: Use the prebuilt Docker image (`xmtp/xmtpd-gateway:main`) which authorizes all requests without authentication
97
+
Use the [example gateway service repository](https://github.com/xmtp/gateway-service-example) as a starting point to build your own custom gateway with authentication
101
98
102
99
For detailed implementation steps, see [Deploy your XMTP Gateway Service](#deploy-your-xmtp-gateway-service).
103
100
@@ -470,24 +467,25 @@ func main() {
470
467
471
468
## Deploy your XMTP Gateway Service
472
469
473
-
Deploy the XMTP Gateway Service on your infrastructure of choice, such as a container hosting service ($25-50/month minimum).
470
+
:::tip [Example repo]
474
471
475
-
### For production deployments
472
+
You can start with the [example gateway service repository](https://github.com/xmtp/gateway-service-example).
476
473
477
-
Use the [example gateway service repository](https://github.com/xmtp/gateway-service-example) as your starting point:
474
+
:::
478
475
479
-
1. Fork or clone the repository
480
-
2. Customize the authentication logic for your app
481
-
3. Build your own Docker image from the included Dockerfile
482
-
4. Deploy your custom image to your hosting provider
476
+
1. Fork or clone the repository.
477
+
2. Add your own authentication logic.
478
+
3. Implement custom rate limiting.
479
+
4. Build your own Docker image from the included Dockerfile.
480
+
5. Deploy your custom image on your infrastructure of choice, such as a container hosting service ($25-50/month minimum).
483
481
484
482
#### Additional recommendations
485
483
486
484
The system is able to run without any external dependencies, but we recommend configuring a Redis instance to use for nonce management and rate limiting.
487
485
488
486
If your XMTP Gateway Service goes down, messages will queue until it comes back online. Build redundancy, if needed.
489
487
490
-
### For testing only
488
+
##Test your XMTP Gateway Service
491
489
492
490
You can use the prebuilt Docker image for local development and testing:
493
491
@@ -501,7 +499,7 @@ This pre-built image authorizes all requests without authentication. Never use i
0 commit comments