Skip to content

Commit 95bcea5

Browse files
Update llms-full.txt (#466)
Co-authored-by: jhaaaa <jhaaaa@users.noreply.github.com>
1 parent 5d94070 commit 95bcea5

File tree

1 file changed

+28
-22
lines changed

1 file changed

+28
-22
lines changed

llms/llms-full.txt

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# XMTP Full Documentation
22

3-
Generated at 10:13 PM UTC / October 28, 2025
3+
Generated at 02:16 AM UTC / November 05, 2025
44

55
## Instructions for AI Tools
66

@@ -13222,20 +13222,9 @@ Every app and agent needs an XMTP Gateway Service.
1322213222

1322313223
### For browser and mobile client apps
1322413224

13225-
You must run the XMTP Gateway Service written in Go. Choose the option that works best for you:
13225+
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
1322613226

13227-
**Option 1: Basic Docker image** (No Go knowledge required)
13228-
13229-
- XMTP provides a Docker image that works out of the box
13230-
- Authorizes all requests (add authentication for production)
13231-
- Suitable for testing
13232-
13233-
**Option 2: Custom implementation** (Go knowledge required)
13234-
13235-
- Start with XMTP's Go implementation
13236-
- Add your own authentication logic
13237-
- Implement custom rate limiting
13238-
- Required for apps with authentication needs
13227+
For detailed implementation steps, see [Deploy your XMTP Gateway Service](#deploy-your-xmtp-gateway-service).
1323913228

1324013229
### For agents and Node.js apps
1324113230

@@ -13403,7 +13392,7 @@ This identity will then be used for rate limiting, and will be passed to your `A
1340313392

1340413393
:::code-group
1340513394

13406-
```go [IP Address]
13395+
```go [IP address]
1340713396
// We provide a simple implementation that uses the client's IP address to identify users. For a production application, you should limit requests to only users actually authenticated in your application.
1340813397
package main
1340913398

@@ -13521,7 +13510,7 @@ func main() {
1352113510

1352213511
```
1352313512

13524-
```go [Rate Limiting]
13513+
```go [Rate limiting]
1352513514
package main
1352613515

1352713516
import (
@@ -13606,22 +13595,39 @@ func main() {
1360613595

1360713596
## Deploy your XMTP Gateway Service
1360813597

13609-
Deploy the XMTP Gateway Service on your infrastructure of choice, such as a container hosting service ($25-50/month minimum).
13598+
:::tip[Example repo]
1361013599

13611-
We provide a Docker image that corresponds to the bare bones example above that you can run with the appropriate environment variables set in any hosting provider that supports Docker.
13600+
You can start with the [example gateway service repository](https://github.com/xmtp/gateway-service-example).
1361213601

13613-
```bash [Bash]
13614-
docker run -p 5050:5050 -p 5055:5055 -e XMTPD_PAYER_PRIVATE_KEY=... xmtp/xmtpd-gateway:main
13615-
```
13602+
:::
13603+
13604+
1. Fork or clone the repository.
13605+
2. Add your own authentication logic.
13606+
3. Configure your rate limits
13607+
4. Deploy your custom image on your infrastructure of choice, such as a container hosting service ($25-50/month minimum).
1361613608

13617-
Most production apps will require some level of customization to authorize user requests. You can fork our [example repository](https://github.com/xmtp/gateway-service-example), which includes a Dockerfile and a sample configuration.
13609+
#### Additional recommendations
1361813610

1361913611
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.
1362013612

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

1362313615
## Test your XMTP Gateway Service
1362413616

13617+
You can use the prebuilt Docker image for local development and testing:
13618+
13619+
```bash [Bash]
13620+
docker run -p 5050:5050 -p 5055:5055 -e XMTPD_PAYER_PRIVATE_KEY=... xmtp/xmtpd-gateway:main
13621+
```
13622+
13623+
:::warning
13624+
13625+
This pre-built image authorizes all requests without authentication. Never use it in production.
13626+
13627+
:::
13628+
13629+
### Test scenarios
13630+
1362513631
Here are some high priority scenarios to test:
1362613632

1362713633
- Deploy and test XMTP Gateway Service

0 commit comments

Comments
 (0)