mirror of
https://github.com/siv-org/siv.git
synced 2026-01-09 10:27:57 -05:00
2.1 KiB
2.1 KiB
Tips For Getting API Keys for Cloud Services
Here are more detailed instructions for how to get API keys for the cloud services needed for your .env.local file:
Firebase:
- Visit Firebase and sign in with your Google account
- Click on "Get Started" and create a new project
- Navigate to the project settings (cog icon) and go to "Project setting" -> "Service accounts"
- Generate a new private key for the Firebase Admin SDK and download the JSON file
- Extract the following values from the JSON file and add them to your
.env.local:FIREBASE_CLIENT_EMAIL: Found in the "client_email" fieldFIREBASE_PRIVATE_KEY: Found in the "private_key" field- Note: Ensure this key is enclosed in double quotes
FIREBASE_PROJECT_ID: Found in the "project_id" field
Supabase:
- Visit Supabase and sign up for an account
- Create a new project and note down the project URL and the public API key
- Go to the project settings and add the following values to your
.env.local:SUPABASE_ADMIN_KEY: Found in "API" -> "Project API keys" under "anon public"SUPABASE_DB_URL: Found in "API" -> "Project URL"- Note: Be sure to add "https://" to the start of the address
SUPABASE_JWT_SECRET: Found in "API" -> "JWT Settings" under "JWT Secret"
Mailgun:
- Visit Mailgun and sign up for a free account
- Use the default sandbox domain provided by Mailgun for testing purposes.
- Click on your account menu (top-right)
- Go to "Mailgun API keys" and hit "Add new key"
- Give the key a description such as "SIV"
- Copy the new API key and add it to
.env.localunderMAILGUN_API_KEY
- Go back to the Dashboard and click on the sandbox account under "Sending domains"
- Note: the domain will look like
sandbox<XXXX>.mailgun.org - Copy this domain and add it to
.env.localunderMAILGUN_DOMAIN
- Note: the domain will look like
- Add "Authorized Recipients" email addresses on the right that you will test with
- Now test that everything is set up correctly using the appropriate command provided in the API panel