Environment variables

Environment variables are key value pairs used to configure how your Rafiki instance will run within your infrastructure and integrate with your systems.

Each environment variable name is uppercase, followed by an equal sign and the value of the variable.

Environment variable example

WEBHOOKS_URL=http://my-business/webhooks

The environment variable in the preceding example specifies the HTTP endpoint at which you want your Rafiki instance to send you notifications of webhook events.

To run Rafiki you must set the environment variables for the backend, auth and frontend services where listed as required below.

Caution

If you are running Rafiki via Docker, you must update the variables in the docker-compose.yml files of the respective services.

If you are running Rafiki via Helm and Kubernetes, you must update the variables in the values.yaml file of the Helm chart template.

Backend

Required

Variable	Helm value name	Default	Description
AUTH_SERVER_GRANT_URL	config.backend.auth.grantUrl	undefined	The endpoint on your Open Payments authorization server to grant a request.
AUTH_SERVER_INTROSPECTION_URL	config.backend.auth.introspectionUrl	undefined	The endpoint on your Open Payments authorization server to introspect an access token.
DATABASE_URL	config.backend.databaseUrl.value or config.backend.databaseUrl.secretKeyRef	postgresql://postgres:password@localhost:5432/development	The Postgres database URL of the database storing your resource data. Can be provided as a value or secret reference.
EXCHANGE_RATES_URL	config.backend.rates.url	undefined	The endpoint your Rafiki instance uses to request exchange rates.
ILP_ADDRESS	config.backend.ilp.address	undefined	The ILP address of your Rafiki instance.
ILP_CONNECTOR_URL	config.backend.ilp.connector	undefined	The ILP connector address where ILP packets are received.
KEY_ID	config.backend.key.id	undefined	Your Rafiki instance’s client key ID.
OPEN_PAYMENTS_URL	config.backend.ilp.host	undefined	The public endpoint of your Open Payments resource server.
REDIS_URL	config.backend.redisUrl.value or config.backend.redisUrl.secretKeyRef	redis://127.0.0.1:6379	The Redis URL of the database handling ILP packet data. Can be provided as a value or secret reference.
USE_TIGERBEETLE	config.backend.useTigerbeetle	false	When true, a TigerBeetle database is used for accounting. When false, a Postgres database is used.
WEBHOOK_URL	config.backend.webhook.url	undefined	Your endpoint that consumes webhook events.

Conditionally required

Variable	Helm value name	Default	Description
INSTANCE_NAME	config.backend.instanceName	undefined	Your Rafiki instance’s name used to communicate for auto-peering and/or telemetry. Required when auto-peering and/or telemetry is enabled
TRUST_PROXY	config.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.

Optional

Variable	Helm value name	Default	Description
ADMIN_PORT	config.backend.port.admin	3001	The port of your Backend Auth API server.
ADMIN_API_SIGNATURE_TTL_SECONDS	undefined	30	The time to live (TTL), in seconds, for which a request’s signature will be valid.
API_SECRET	undefined	undefined	N/A
API_SIGNATURE_VERSION	undefined	1	The version of the request signing algorithm used to generate signatures.
AUTO_PEERING_SERVER_PORT	config.backend.port.autoPeering	3005	If auto-peering is enabled, the server will use this port.
CONNECTOR_PORT	config.backend.port.connector	3002	The port of the ILP connector for sending packets via ILP over HTTP.
ENABLE_AUTO_PEERING	config.backend.autoPeering.enabled	false	When true, auto-peering is enabled.
ENABLE_MANUAL_MIGRATIONS	undefined	false	When true, you must run the database manually with the command npm run knex – migrate:latest –env production
ENABLE_SPSP_PAYMENT_POINTERS	undefined	true	When true, the SPSP route is enabled.
ENABLE_TELEMETRY	config.backend.telemetry.enabled	false	Enables the telemetry service on Rafiki.
ENABLE_TELEMETRY_TRACES	undefined	false	N/A
EXCHANGE_RATES_LIFETIME	undefined	15000	The time, in milliseconds, the exchange rates you provide via the EXCHANGE_RATES_URL are valid.
GRAPHQL_IDEMPOTENCY_KEY_LOCK_MS	undefined	2000	The time to live (TTL), in milliseconds, for idempotencyKey concurrency lock on GraphQL mutations on the Backend Admin API.
GRAPHQL_IDEMPOTENCY_KEY_TTL_MS	undefined	86400000 (24 hours)	The time to live (TTL), in milliseconds, for idempotencyKey on GraphQL mutations on the Backend Admin API.
INCOMING_PAYMENT_CREATED_POLL_FREQUENCY_MS	undefined	1000	N/A
INCOMING_PAYMENT_CREATED_POLL_TIMEOUT_MS	undefined	10000	N/A
INCOMING_PAYMENT_EXPIRY_MAX_MS	undefined	2592000000 (30 days)	The maximum into the future, in milliseconds, incoming payments expiry can be set to on creation.
INCOMING_PAYMENT_WORKER_IDLE	undefined	200	The time, in milliseconds, that INCOMING_PAYMENT_WORKERS will wait until checking an empty incoming payment request queue again.
INCOMING_PAYMENT_WORKERS	undefined	1	The number of workers processing incoming payment requests.
LOG_LEVEL	config.backend.logLevel	info	Pino log level
MAX_OUTGOING_PAYMENT_RETRY_ATTEMPTS	undefined	5	Specifies how many times an outgoing payment is retried before failing completely.
NODE_ENV	config.backend.nodeEnv	development	The type of node environment: development, test, or production.
OPEN_PAYMENTS_PORT	config.backend.port.openPayments	3000	The port of your Open Payments resource server.
OPEN_TELEMETRY_COLLECTOR_URLS	undefined	*undefined	N/A
OPEN_TELEMETRY_EXPORT_INTERVAL	undefined	15000	N/A
OPEN_TELEMETRY_TRACE_COLLECTOR_URLS	undefined	undefined	N/A
OUTGOING_PAYMENT_WORKER_IDLE	undefined	10	The time, in milliseconds, that OUTGOING_PAYMENT_WORKERS wait until they check an empty outgoing payment request queue again.
OUTGOING_PAYMENT_WORKERS	undefined	1	The number of workers processing outgoing payment requests.
POLL_INCOMING_PAYMENT_CREATED_WEBHOOK	undefined	false	N/A
QUOTE_LIFESPAN	undefined	300000 (5 minutes)	The time, in milliseconds, an Open Payments quote is valid for.
REDIS_TLS_CA_FILE_PATH	undefined	''	Redis TLS config
REDIS_TLS_CERT_FILE_PATH	undefined	''	Redis TLS config
REDIS_TLS_KEY_FILE_PATH	undefined	''	Redis TLS config
SIGNATURE_SECRET	config.backend.webhookSignatureSecret.value or config.backend.webhookSignatureSecret.secretKeyRef	undefined	The secret to generate request header signatures for webhook event requests.
SIGNATURE_VERSION	undefined	1	The version number to generate request header signatures for webhook events.
SLIPPAGE	config.backend.slippage	0.01 (1%)	The accepted ILP rate fluctuation.
TELEMETRY_EXCHANGE_RATES_LIFETIME	undefined	86400000 (24 hours)	Lifetime for telemetry exchange rates in milliseconds.
TELEMETRY_EXCHANGE_RATES_URL	undefined	https://telemetry-exchange-rates.s3.amazonaws.com/exchange-rates-usd.json	The endpoint Rafiki will query for exchange rates. Used as a fallback if/when exchange rates aren’t provided.
TIGERBEETLE_CLUSTER_ID	undefined	0	The TigerBeetle cluster ID picked by the system that starts the TigerBeetle cluster to create a TigerBeetle client.
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 TigerBeetle client.
TIGERBEETLE_TWO_PHASE_TIMEOUT_SECONDS	undefined	5	Two-phase timeout for TigerBeetle in seconds.
WALLET_ADDRESS_DEACTIVATION_PAYMENT_GRACE_PERIOD_MS	undefined	86400000 (24 hours)	The time into the future, in milliseconds, to set expiration of Open Payments incoming payments when deactivating a wallet address.
WALLET_ADDRESS_LOOKUP_TIMEOUT_MS	undefined	1500	The time, in milliseconds, you have to create a missing wallet address before timeout.
WALLET_ADDRESS_POLLING_FREQUENCY_MS	undefined	100	The frequency of polling while waiting for you to create a missing wallet address.
WALLET_ADDRESS_REDIRECT_HTML_PAGE	config.backend.walletAddressRedirectHtmlPage	undefined	Custom HTML page for wallet address redirects.
WALLET_ADDRESS_URL	config.backend.ilp.host	http://127.0.0.1:3001/.well-known/pay	Your Rafiki instance’s internal wallet address.
WALLET_ADDRESS_WORKER_IDLE	undefined	200	The time, in milliseconds, that WALLET_ADDRESS_WORKERS wait until checking the empty wallet address request queue again.
WALLET_ADDRESS_WORKERS	undefined	1	The number of workers processing wallet address requests.
WEBHOOK_MAX_RETRY	undefined	10	The maximum number of times your Rafiki instance’s backend retries sending a certain webhook event to your configured WEBHOOK_URL.
WEBHOOK_TIMEOUT	config.backend.webhook.timeout	2000 (2 seconds)	The time, in milliseconds, that your Rafiki instance will wait for a 200 response from your webhook endpoint. If a 200 response isn’t received, Rafiki will time out and try to send the webhook event again.
WEBHOOK_WORKER_IDLE	undefined	200	The time, in milliseconds, that WEBHOOK_WORKERS will wait until they check the empty webhook event queue again.
WEBHOOK_WORKERS	undefined	1	The number of workers processing webhook events.
WITHDRAWAL_THROTTLE_DELAY	config.backend.withdrawalThrottleDelay	undefined	The delay in liquidity withdrawal processing, in milliseconds.
LIVENET	config.backend.telemetry.livenet	false	When true, enables livenet mode for production deployments.

Auth

Required

Variable	Helm value name	Default	Description
AUTH_DATABASE_URL	config.auth.databaseUrl.value or config.auth.databaseUrl.secretKeyRef	postgresql://postgres:password@localhost:5432/auth_development	The URL of the Postgres database storing your Open Payments grant data. Can be provided as a value or secret reference.
AUTH_SERVER_URL	config.auth.authServerUrl	undefined	The public endpoint for your Rafiki instance’s public Open Payments routes.
COOKIE_KEY	config.auth.cookieKey.value or config.auth.cookieKey.secretKeyRef	undefined	The koa KeyGrip key that is used to sign cookies for an interaction session.
IDENTITY_SERVER_URL	config.auth.identityServer.domain	undefined	The URL of your IdP’s server, used by the authorization server to inform an Open Payments client of where to redirect the end-user to start interactions.
IDENTITY_SERVER_SECRET	config.auth.identityServer.serverSecret.value or config.auth.identityServer.serverSecret.secretKeyRef	undefined	A shared secret between the authorization server and the IdP server; the authorization server will use the secret to secure its IdP-related endpoints. When the IdP server sends requests to the authorization server, the IdP server must provide the secret via an x-idp-secret header.
REDIS_URL	config.auth.redisUrl.value or config.auth.redisUrl.secretKeyRef	redis://127.0.0.1:6379	The connection URL for Redis. Can be provided as a value or secret reference.

Conditionally required

Variable	Helm value name	Default	Description
TRUST_PROXY	config.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.

Optional

Variable	Helm value name	Default	Description
ACCESS_TOKEN_DELETION_DAYS	config.auth.accessToken.deletionDays	30	The days until expired and/or revoked access tokens are deleted.
ACCESS_TOKEN_EXPIRY_SECONDS	config.auth.accessToken.expirySeconds	600 (10 minutes)	The expiry time, in seconds, for access tokens.
ADMIN_API_SIGNATURE_VERSION	undefined	1	The version of the request signing algorithm used to generate signatures.
ADMIN_API_SIGNATURE_TTL_SECONDS	undefined	30	The time to live (TTL), in seconds, for which a request’s signature will be valid.
ADMIN_PORT	config.auth.port.admin	3003	The port of your Rafiki Auth Admin API server.
AUTH_PORT	config.auth.port.auth	3006	The port of your Open Payments authorization server.
DATABASE_CLEANUP_WORKERS	config.auth.workers.cleanup	1	The number of workers processing expired or revoked access tokens.
ENABLE_MANUAL_MIGRATIONS	undefined	false	When true, you must run the auth Postgres database manually with the command npm run knex – migrate:latest –envproduction
INCOMING_PAYMENT_INTERACTION	config.auth.interaction.incomingPayment	false	When true, incoming Open Payments grant requests are interactive
INTERACTION_EXPIRY_SECONDS	undefined	600 (10 minutes)	The time, in seconds, for which a user can interact with a grant request before the request expires.
INTERACTION_PORT	undefined	3009	The port number of your Open Payments interaction-related APIs.
INTROSPECTION_PORT	config.auth.port.introspection	3007	The port of your Open Payments access token introspection server.
SERVICE_API_PORT	undefined	3011	The port to expose the internal service api.
LIST_ALL_ACCESS_INTERACTION	undefined	true	When true, grant requests that include a list-all action will require interaction. In these requests, the client asks to list resources that it did not create.
LOG_LEVEL	config.auth.logLevel	info	Pino log level
NODE_ENV	config.auth.nodeEnv	development	The type of node environment: development, test, or production.
QUOTE_INTERACTION	config.auth.interaction.quote	false	When true, quote grants are interactive.
REDIS_TLS_CA_FILE_PATH	undefined	''	Redis TLS config
REDIS_TLS_CERT_FILE_PATH	undefined	''	Redis TLS config
REDIS_TLS_KEY_FILE_PATH	undefined	''	Redis TLS config
WAIT_SECONDS	config.auth.grant.waitSeconds	5	The wait time, in seconds, included in a grant request response (grant.continue).
ADMIN_API_SECRET	undefined	undefined	The secret for the auth admin API authentication.
INTERACTION_COOKIE_SAME_SITE	config.auth.interaction.cookieSameSite	undefined	The SameSite attribute for interaction cookies. Valid values: lax, none.

Frontend

Required

Variable	Helm value name	Default	Description
GRAPHQL_URL	config.frontend.serviceUrls.GRAPHQL_URL	undefined	URL for Rafiki’s GraphQL Auth Admin API.
OPEN_PAYMENTS_URL	config.frontend.serviceUrls.OPEN_PAYMENTS_URL	undefined	Your Open Payments API endpoint.

Conditionally required

The following variables are required only when AUTH_ENABLED is set to true.

Variable	Helm value name	Default	Description
KRATOS_ADMIN_URL	undefined	undefined	The admin endpoint/container address for Kratos.
KRATOS_BROWSER_PUBLIC_URL	undefined	undefined	The URL to access the Kratos Docker container from a browser outside the Docker network. This is used for calls from a browser (what you see in the Rafiki Admin UI) to the Kratos server on the backend.
KRATOS_CONTAINER_PUBLIC_URL	undefined	undefined	The URL to access the Kratos Docker container from in the Docker network. This is used for backend calls to Kratos.

Optional

Variable	Helm value name	Default	Description
AUTH_ENABLED	config.frontend.kratos.enabled	true	When true, only authenticated users can be granted access to Rafiki Admin by an administrator.
ENABLE_INSECURE_MESSAGE_COOKIE	undefined	undefined	When set to true, t, or 1, cookie will be transmitted over insecure HTTP connection. Insecure message cookies are required for flash messages to work over HTTP.
LOG_LEVEL	config.frontend.logLevel	info	Pino log level.
NODE_ENV	config.frontend.nodeEnv	undefined	The type of node environment: development, test, or production.
PORT	config.frontend.port	3010	Port from which to host the Rafiki Remix app.
SIGNATURE_SECRET	undefined	undefined	The signature secret used to authenticate requests to the Backend Admin API.
SIGNATURE_VERSION	undefined	undefined	The signature version number used to authenticate requests to the Backend Admin API.