Skip to content

Commit d01ea5a

Browse files
hajjimohajjimo
authored
docs: Updated TRUST_PROXY as a conditionally required variable (#3249)
* docs: Updated TRUST_PROXY as a conditionally required variable * docs: mi/3239/trust-proxy-update Added TRUST_PROXY as conditionally required for AUTH * docs: mi/3239/trust-proxy-update
1 parent 16c9840 commit d01ea5a

3 files changed

Lines changed: 15 additions & 2 deletions

File tree

‎packages/documentation/src/content/docs/integration/deployment/docker-compose.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,10 @@ Update the variables in the following compose file with values relevant to your
9999
You must change the values enclosed within the brackets of the following compose file. Substitute `newest-version` with the latest Rafiki <LinkOut href='https://github.com/interledger/rafiki/releases'>version</LinkOut>.
100100
:::
101101

102+
:::caution[Running Rafiki behind a proxy]
103+
If you plan to run your Rafiki instance behind a proxy, you must set the `TRUST_PROXY` variable to `true`
104+
:::
105+
102106
```sh
103107
name: 'my-rafiki'
104108
services:

‎packages/documentation/src/partials/auth-variables.mdx‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,16 @@ import { LinkOut } from '@interledger/docs-design-system'
1515

1616
</div>
1717

18+
### Conditionally required
19+
20+
<div class="overflow-table">
21+
22+
| Variable | Helm value name | Default | Description |
23+
| ------------- | ----------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
24+
| `TRUST_PROXY` | `auth.trustProxy` | `false` | Must be set to `true` when running Rafiki behind a proxy. When `true`, the `X-Forwarded-Proto` header is used to determine if connections are secure. |
25+
26+
</div>
27+
1828
### Optional
1929

2030
<div class="overflow-table wider-column">
@@ -40,7 +50,6 @@ import { LinkOut } from '@interledger/docs-design-system'
4050
| `REDIS_TLS_CA_FILE_PATH` | `auth.redis.tlsCaFile` | `''` | <LinkOut href="https://redis.io/docs/latest/operate/oss_and_stack/management/security/encryption/">Redis TLS config</LinkOut> |
4151
| `REDIS_TLS_CERT_FILE_PATH` | `auth.redis.tlsCertFile` | `''` | <LinkOut href="https://redis.io/docs/latest/operate/oss_and_stack/management/security/encryption/">Redis TLS config</LinkOut> |
4252
| `REDIS_TLS_KEY_FILE_PATH` | `auth.redis.tlsKeyFile` | `''` | <LinkOut href="https://redis.io/docs/latest/operate/oss_and_stack/management/security/encryption/">Redis TLS config</LinkOut> |
43-
| `TRUST_PROXY` | `auth.trustProxy` | `false` | When `true`, the `X-Forwarded-Proto` header is used to determine if connections are secure. |
4453
| `WAIT_SECONDS` | `auth.grant.waitSeconds` | `5` | The wait time, in seconds, included in a grant request response (`grant.continue`). |
4554

4655
</div>

‎packages/documentation/src/partials/backend-variables.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import { LinkOut } from '@interledger/docs-design-system'
2727
| Variable | Helm value name | Default | Description |
2828
| --------------- | ----------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2929
| `INSTANCE_NAME` | `backend.instance.name` | _undefined_ | Your Rafiki instance's name used to communicate for auto-peering and/or [telemetry](/overview/concepts/telemetry). Required when auto-peering and/or telemetry is enabled |
30+
| `TRUST_PROXY` | `backend.trustProxy` | `false` | Must be set to `true` when running Rafiki behind a proxy. When `true`, the `X-Forwarded-Proto` header is used to determine if connections are secure. |
3031

3132
</div>
3233

@@ -80,7 +81,6 @@ import { LinkOut } from '@interledger/docs-design-system'
8081
| `TIGERBEETLE_REPLICA_ADDRESSES` | _undefined_ | `3004` | TigerBeetle replica addresses for all replicas in the cluster. The addresses are comma-separated IP addresses/ports, to create a <LinkOut href="https://docs.tigerbeetle.com/clients/node/#creating-a-client">TigerBeetle client</LinkOut>. |
8182
| `TIGERBEETLE_REPLICA_ADDRESSES.SPLIT` | _undefined_ | `3004` | N/A |
8283
| `TIGERBEETLE_TWO_PHASE_TIMEOUT_SECONDS` | _undefined_ | `5` | N/A |
83-
| `TRUST_PROXY` | `backend.trustProxy` | `false` | When `true`, the `X-Forwarded-Proto` header is used to determine if connections are secure. |
8484
| `WALLET_ADDRESS_DEACTIVATION_PAYMENT_GRACE_PERIOD_MS` | `backend.walletAddress.deactivationPaymentGratePeriodMs` | `86400000` (24 hours) | The time into the future, in milliseconds, to set expiration of Open Payments incoming payments when deactivating a wallet address. |
8585
| `WALLET_ADDRESS_LOOKUP_TIMEOUT_MS` | `backend.walletAddress.lookupTimeoutMs` | `1500` | The time, in milliseconds, you have to create a missing wallet address before timeout. |
8686
| `WALLET_ADDRESS_POLLING_FREQUENCY_MS` | `backend.walletAddress.pollingFrequencyMs` | `100` | The frequency of polling while waiting for you to create a missing wallet address. |

0 commit comments

Comments
 (0)