From 801e6c711f32616f3126a0ad5e3fb98f6fb82466 Mon Sep 17 00:00:00 2001 From: golobitch Date: Fri, 7 Jun 2024 21:38:30 +0200 Subject: [PATCH] docs(integration): update env variables default values --- .../content/docs/integration/deployment.md | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/packages/documentation/src/content/docs/integration/deployment.md b/packages/documentation/src/content/docs/integration/deployment.md index cb032692f1..b170d1b024 100644 --- a/packages/documentation/src/content/docs/integration/deployment.md +++ b/packages/documentation/src/content/docs/integration/deployment.md @@ -55,28 +55,28 @@ Now, the Admin UI can be found on localhost:3010. | Variable | Helm Value Name | Default | Description | | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ADMIN_PORT` | backend.port.admin | `3001` | Admin API GraphQL Server port | -| `AUTH_SERVER_GRANT_URL` | | `http://127.0.0.1:3006` | endpoint on the Open Payments Auth Server to request a grant | -| `AUTH_SERVER_INTROSPECTION_URL` | | `http://127.0.0.1:3007` | endpoint on the Open Payments Auth Server to introspect an access token | +| `AUTH_SERVER_GRANT_URL` | | `undefined` | endpoint on the Open Payments Auth Server to request a grant | +| `AUTH_SERVER_INTROSPECTION_URL` | | `undefined` | endpoint on the Open Payments Auth Server to introspect an access token | | `AUTO_PEERING_SERVER_PORT` | | `3005` | If [auto-peering](/concepts/interledger-protocol/peering#auto-peering) is enabled, its server will use this port | | `CONNECTOR_PORT` | backend.port.connector | `3002` | port of the ILP connector for for sending packets over ILP over HTTP | | `DATABASE_URL` | backend.postgresql.host, backend.postgresql.port, backend.postgresql.username, backend.postgresql.database, backend.postgresql.password | `postgresql://postgres:password@localhost:5432/development` | Postgres database URL of database storing the resource data; For Helm, these components are provided individually. | | `ENABLE_AUTO_PEERING` | | `false` | Flag to enable auto peering. View [documentation](/concepts/interledger-protocol/peering#auto-peering). | -| `ENABLE_SPSP` | | `true` | enables [SPSP](/reference/glossary#simple-payments-setup-protocol-spsp) route | +| `ENABLE_INTERLEDGER_PAYMENT_POINTERS` | | `true` | enables [SPSP](/reference/glossary#simple-payments-setup-protocol-spsp) route | | `EXCHANGE_RATES_LIFETIME` | backend.lifetime.exchangeRate | `15_000` | time in milliseconds the exchange rates provided by the ASE via the EXCHANGE_RATES_URL are valid for | | `EXCHANGE_RATES_URL` | backend.serviceUrls.EXCHANGE_RATES_URL | `undefined` | endpoint on the Account Servicing Entity to request exchange rates | | `GRAPHQL_IDEMPOTENCY_KEY_TTL_MS` | backend.idempotencyTTL | `86400000` | TTL in milliseconds for idempotencyKey on GraphQL mutations (Admin API). Default: 24hrs | | `GRAPHQL_IDEMPOTENCY_KEY_LOCK_MS` | | `2000` | TTL in milliseconds for idempotencyKey concurrency lock on GraphQL mutations (Admin API) | -| `ILP_ADDRESS` | backend.ilp.address | `test.rafiki` | ILP address of this Rafiki instance | -| `ILP_CONNECTOR_ADDRESS` | | `http://127.0.0.1:3002` | The ILP connector address where ILP packets are received. Communicated during [auto-peering](/concepts/interledger-protocol/peering#auto-peering) | +| `ILP_ADDRESS` | backend.ilp.address | `undefined` | ILP address of this Rafiki instance | +| `ILP_CONNECTOR_ADDRESS` | | `undefined` | The ILP connector address where ILP packets are received. Communicated during [auto-peering](/concepts/interledger-protocol/peering#auto-peering) | | `INCOMING_PAYMENT_EXPIRY_MAX_MS` | | `2592000000` | Maximum milliseconds into the future incoming payments expiry can be set to on creation. Default: 30 days | | `INCOMING_PAYMENT_WORKERS` | backend.workers.incomingPayment | `1` | number of workers processing incoming payment requests | | `INCOMING_PAYMENT_WORKER_IDLE` | backend.workerIdle | `200` | time in milliseconds that INCOMING_PAYMENT_WORKERS will wait until they check an empty incoming payment request queue again | -| `INSTANCE_NAME` | | `Rafiki` | this Rafiki instance's name used to communicate for [auto-peering](/concepts/interledger-protocol/peering#auto-peering) | -| `KEY_ID` | backend.key.id | `rafiki` | this Rafiki instance's client key id | +| `INSTANCE_NAME` | | `undefined` | this Rafiki instance's name used to communicate for [auto-peering](/concepts/interledger-protocol/peering#auto-peering) | +| `KEY_ID` | backend.key.id | `undefined` | this Rafiki instance's client key id | | `LOG_LEVEL` | backend.logLevel | `info` | [Pino Log Level](https://getpino.io/#/docs/api?id=levels) | | `NODE_ENV` | backend.nodeEnv | `development` | node environment, `development`, `test`, or `production` | | `OPEN_PAYMENTS_PORT` | backend.port.openPayments | `3003` | port of the Open Payments resource server port | -| `OPEN_PAYMENTS_URL` | backend.serviceUrls.OPEN_PAYMENTS_URL | `http://127.0.0.1:3003` | public endpoint of this Open Payments Resource Server | +| `OPEN_PAYMENTS_URL` | backend.serviceUrls.OPEN_PAYMENTS_URL | `undefined` | public endpoint of this Open Payments Resource Server | | `OUTGOING_PAYMENT_WORKERS` | backend.workers.outgoingPayment | `4` | number of workers processing outgoing payment requests | | `OUTGOING_PAYMENT_WORKER_IDLE` | backend.workerIdle | `200` | time in milliseconds that OUTGOING_PAYMENT_WORKERS will wait until they check an empty outgoing payment request queue again | | `PRIVATE_KEY_FILE` | backend.key.file | `undefined` | the path to this Rafiki instance's client private key | @@ -88,11 +88,11 @@ Now, the Admin UI can be found on localhost:3010. | `SIGNATURE_SECRET` | backend.quoteSignatureSecret | `undefined` | secret to generate request header signatures for webhook event requests | | `SIGNATURE_VERSION` | | `1` | version number to generate request header signatures for webhook event requests | | `SLIPPAGE` | backend.ilp.slippage | `0.01` | accepted ILP rate fluctuation, default 1% | -| `STREAM_SECRET` | backend.ilp.streamSecret | 32 random bytes | seed secret to generate shared STREAM secrets | +| `STREAM_SECRET` | backend.ilp.streamSecret | undefined | seed secret to generate shared STREAM secrets | | `TIGERBEETLE_CLUSTER_ID` | | `0` | Tigerbeetle cluster ID picked by the system that starts the TigerBeetle cluster to create a [Tigerbeetle client](https://docs.tigerbeetle.com/clients/node#creating-a-client) | | `TIGERBEETLE_REPLICA_ADDRESSES` | | `3004` | Tigerbeetle replica addresses for all replicas in the cluster, which are comma separated IP addresses/ports, to create a [Tigerbeetle client](https://docs.tigerbeetle.com/clients/node#creating-a-client) | | `TRUST_PROXY` | | `false` | flag to use X-Forwarded-Proto header to determine if connections is secure | -| `USE_TIGERBEETLE` | | `false` | flag - use TigerBeetle or Postgres for accounting | +| `USE_TIGERBEETLE` | | `true` | flag - use TigerBeetle or Postgres for accounting | | `WALLET_ADDRESS_DEACTIVATION_PAYMENT_GRACE_PERIOD_MS` | | `86400000` | time in milliseconds into the future to set expiration of open incoming payments when deactivating wallet address. Default: 1 days | | `WALLET_ADDRESS_LOOKUP_TIMEOUT_MS` | | `1500` | time in milliseconds the ASE has to create a missing wallet address until timeout | | `WALLET_ADDRESS_POLLING_FREQUENCY_MS` | | `100` | frequency of polling while waiting for ASE to create a missing wallet address | @@ -101,7 +101,7 @@ Now, the Admin UI can be found on localhost:3010. | `WALLET_ADDRESS_WORKER_IDLE` | backend.workerIdle | `200` | time in milliseconds that WALLET_ADDRESS_WORKERS will wait until they check an empty wallet address request queue again | | `WEBHOOK_MAX_RETRY` | backend.webhookMaxRetry | `10` | maximum number of times Rafiki backend retries sending a certain webhook event to the configured WEBHOOK_URL | | `WEBHOOK_TIMEOUT` | backend.lifetime.webhook | `2000` | milliseconds | -| `WEBHOOK_URL` | backend.serviceUrls.WEBHOOK_URL | `http://127.0.0.1:4001/webhook` | endpoint on the Account Servicing Entity that consumes webhook events | +| `WEBHOOK_URL` | backend.serviceUrls.WEBHOOK_URL | `undefined` | endpoint on the Account Servicing Entity that consumes webhook events | | `WEBHOOK_WORKERS` | backend.workers.webhook | `1` | number of workers processing webhook events | | `WEBHOOK_WORKER_IDLE` | backend.workerIdle | `200` | time in milliseconds that WEBHOOK_WORKERS will wait until they check an empty webhook event queue again | | `WITHDRAWAL_THROTTLE_DELAY` | backend.withdrawalThrottleDelay | `undefined` | delay in liquidity withdrawal processing |