chore: API_KEY env docs (#120)

Fixes #117
supabase · Dec 1, 2024 · 5ec346a · 5ec346a
1 parent c67ae3e
commit 5ec346a
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/.env.sample b/.env.sample
@@ -1,5 +1,7 @@
 DATABASE_URL=postgres://postgres:postgres@host:5432/postgres?sslmode=disable&search_path=stripe
 STRIPE_WEBHOOK_SECRET=whsec_
+
+# API_KEY is used to authenticate "admin" endpoints (i.e. for backfilling), make sure to generate a secure string
 API_KEY=api_key_test
 
 # optional

diff --git a/src/utils/config.ts b/src/utils/config.ts
@@ -15,7 +15,7 @@ type configType = {
   /** Webhook secret from Stripe to verify the signature of webhook events. */
   STRIPE_WEBHOOK_SECRET: string
 
-  /** API_KEY is used to authenticate requests to the sync-engine. */
+  /** API_KEY is used to authenticate "admin" endpoints (i.e. for backfilling), make sure to generate a secure string. */
   API_KEY: string
 
   /** Stripe API version for the webhooks, defaults to 2020-08-27 */