From cbd3783ea4fe3a86288e36d7224287ca705ed47a Mon Sep 17 00:00:00 2001 From: bellabuks Date: Fri, 11 Sep 2026 08:00:25 +0100 Subject: [PATCH] docs: document configuration options --- docs/configuration.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 docs/configuration.md diff --git a/docs/configuration.md b/docs/configuration.md new file mode 100644 index 0000000..f70f480 --- /dev/null +++ b/docs/configuration.md @@ -0,0 +1,18 @@ +# Configuration Options + +PayStream is configured entirely through environment variables. Copy +`.env.example` to `.env` and adjust as needed. + +| Variable | Default | Description | +|---|---|---| +| `DATABASE_URL` | *(required)* | Postgres connection string. | +| `REDIS_URL` | *(required)* | Redis connection string, used for queues/caching. | +| `STELLAR_NETWORK` | `testnet` | Stellar network to operate against (`testnet` or `public`). | +| `STELLAR_HORIZON_URL` | — | Horizon API base URL for the chosen network. | +| `KMS_KEY_ID` | — | Key ID used for envelope encryption of signing keys. | +| `API_PORT` | `8080` | Port `paystream-api` listens on. | +| `API_SECRET` | — | Shared secret for authenticating internal API calls. Change in production. | +| `ANCHOR__DOMAIN` | — | Stellar anchor domain for the `` corridor (one per anchor, e.g. `ANCHOR_VIBRANT_DOMAIN`). | + +Variables with no default must be set before starting `paystream-api` or +`paystream-worker`; see `internal/config` for how defaults are resolved.