Skip to content

Commit 642a7ba

Browse files
committed
feedback from saul <3
1 parent 5238c49 commit 642a7ba

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

docs/pages/fund-agents-apps/run-gateway.mdx

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -94,10 +94,7 @@ Every app and agent needs an XMTP Gateway Service.
9494

9595
### For browser and mobile client apps
9696

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
10198

10299
For detailed implementation steps, see [Deploy your XMTP Gateway Service](#deploy-your-xmtp-gateway-service).
103100

@@ -470,24 +467,25 @@ func main() {
470467

471468
## Deploy your XMTP Gateway Service
472469

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]
474471

475-
### For production deployments
472+
You can start with the [example gateway service repository](https://github.com/xmtp/gateway-service-example).
476473

477-
Use the [example gateway service repository](https://github.com/xmtp/gateway-service-example) as your starting point:
474+
:::
478475

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).
483481

484482
#### Additional recommendations
485483

486484
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.
487485

488486
If your XMTP Gateway Service goes down, messages will queue until it comes back online. Build redundancy, if needed.
489487

490-
### For testing only
488+
## Test your XMTP Gateway Service
491489

492490
You can use the prebuilt Docker image for local development and testing:
493491

@@ -501,7 +499,7 @@ This pre-built image authorizes all requests without authentication. Never use i
501499

502500
:::
503501

504-
## Test your XMTP Gateway Service
502+
### Test scenarios
505503

506504
Here are some high priority scenarios to test:
507505

0 commit comments

Comments
 (0)