Skip to content

Commit 5ec346a

Browse files
authored
chore: API_KEY env docs (#120)
Fixes #117
1 parent c67ae3e commit 5ec346a

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

.env.sample

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
DATABASE_URL=postgres://postgres:postgres@host:5432/postgres?sslmode=disable&search_path=stripe
22
STRIPE_WEBHOOK_SECRET=whsec_
3+
4+
# API_KEY is used to authenticate "admin" endpoints (i.e. for backfilling), make sure to generate a secure string
35
API_KEY=api_key_test
46

57
# optional

src/utils/config.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ type configType = {
1515
/** Webhook secret from Stripe to verify the signature of webhook events. */
1616
STRIPE_WEBHOOK_SECRET: string
1717

18-
/** API_KEY is used to authenticate requests to the sync-engine. */
18+
/** API_KEY is used to authenticate "admin" endpoints (i.e. for backfilling), make sure to generate a secure string. */
1919
API_KEY: string
2020

2121
/** Stripe API version for the webhooks, defaults to 2020-08-27 */

0 commit comments

Comments
 (0)