Skip to content

docs: document configuration options #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbdulmujibOladayo merged 1 commit into from
Sep 11, 2026
Merged

docs: document configuration options #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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_<NAME>_DOMAIN` | — | Stellar anchor domain for the `<NAME>` 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.
Loading