Skip to content
This repository was archived by the owner on Aug 5, 2024. It is now read-only.

Commit 982f876

Browse files
committed
move self-host instructions
1 parent 1a9dd52 commit 982f876

File tree

2 files changed

+5
-10
lines changed

2 files changed

+5
-10
lines changed

src/app/engine/features/security/page.mdx

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,6 @@ If an IP allowlist is not configured, Engine will allow all incoming requests.
2020
This does not affect calls from the Engine dashboard to your Engine instance.
2121
</Callout>
2222

23-
### Using IP Allowlist with a self-hosted Engine
24-
25-
If you have engine running on a server behing a reverse proxy, you can set the `TRUST_PROXY` environment variable to `true` to trust the `X-Forwarded-For` header. Reverse proxies like Nginx or Apache will add this header to the request with the original client IP address, and setting this variable will allow Engine to use the correct IP address for the allowlist.
26-
27-
```bash name=".env"
28-
TRUST_PROXY=true
29-
```
30-
3123
## Domain Allowlist (CORS)
3224

3325
You can restrict access to your Engine instance by configuring a domain allowlist. This can be configured in the **Configuration** section of the [Engine dashboard](https://thirdweb.com/dashboard/engine/).

src/app/engine/self-host/page.mdx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ docker run \
6464
| `LOG_LEVEL` | Determines the logging severity level. Adjust for finer control over logged information. (Default: `debug`) |
6565
| `PRUNE_TRANSACTIONS` | When `false`, Engine prevents the pruning/deletion of processed transaction data. (Default: `true`) |
6666
| `ENABLE_KEYPAIR_AUTH` | Enables [Keypair Authentication](/engine/features/keypair-authentication). |
67+
| `TRUST_PROXY` | When `true`, trust the `X-Forwarded-For` header to allow Engine to use the correct client IP address for the IP allowlist. |
6768

6869
<span style={{ color: "red" }}>*</span> Required
6970

@@ -129,8 +130,6 @@ See [Production Checklist](/engine/production-checklist#cloud-hosting) for best
129130
- Minimum specs: 2 vCPU, 2 GB memory (AWS equivalent: t4g.small)
130131
- Set the `connection_limit` parameter within your `POSTGRES_CONNECTION_URL` environment variable to `10`.
131132

132-
### FAQ
133-
134133
#### How do I filter logs in Engine?
135134

136135
Configure log verbosity via the `LOG_LEVEL` environment variable.
@@ -168,3 +167,7 @@ Example configuration:
168167
```bash
169168
POSTGRES_CONNECTION_URL=postgres://postgres:postgres@localhost:5432/postgres?connection_limit=10
170169
```
170+
171+
#### What is `x-forwarded-for` and how does it affect Engine?
172+
173+
If you have engine running on a server behing a reverse proxy, you can set the `TRUST_PROXY` environment variable to `true` to trust the `X-Forwarded-For` header. Reverse proxies like Nginx or Apache will add this header to the request with the original client IP address, and setting this variable will allow Engine to use the correct IP address for the allowlist.

0 commit comments

Comments
 (0)