Skip to content

Commit 5f7d89a

Browse files
committed
gw: Update doc
1 parent c66ccb7 commit 5f7d89a

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/dstack-gateway.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,27 @@ Focus on these five fields in the `core.proxy` section:
4141

4242
For example, if your base domain is `gateway.example.com`, app ID is `<app_id>`, listening on `80`, and dstack-gateway is on port 7777, the URL would be `https://<app_id>-80.gateway.example.com:7777`
4343

44+
### URL Format
45+
46+
The gateway supports the following URL format:
47+
- `<app_id>[-<port>][<suffix>].<base_domain>`
48+
49+
Where:
50+
- `<app_id>`: The application identifier
51+
- `<port>`: Optional port number (defaults to 80 for HTTP, 443 for HTTPS)
52+
- `<suffix>`: Optional suffix flags:
53+
- `s`: Enable TLS passthrough (proxy passes encrypted traffic directly to backend)
54+
- `g`: Enable HTTP/2 (gRPC) support (proxy advertises h2 via ALPN)
55+
56+
Examples:
57+
- `<app_id>.gateway.example.com` - Default HTTP on port 80
58+
- `<app_id>-8080.gateway.example.com` - HTTP on port 8080
59+
- `<app_id>-s.gateway.example.com` - TLS passthrough on port 443
60+
- `<app_id>-443s.gateway.example.com` - TLS passthrough on port 443
61+
- `<app_id>-50051g.gateway.example.com` - HTTP/2/gRPC on port 50051
62+
63+
Note: The `s` and `g` suffixes cannot be used together
64+
4465
## Step 5: Adjust Configuration in `vmm.toml`
4566

4667
Open `vmm.toml` and adjust dstack-gateway configuration in the `gateway` section:

0 commit comments

Comments
 (0)