-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy path.example.env
More file actions
127 lines (109 loc) · 5.87 KB
/
.example.env
File metadata and controls
127 lines (109 loc) · 5.87 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
# DATABASE: For local development, this should match what is defined in
# docker-compose.yml. The values here are applicable for local development.
DATABASE_NAME="diplicity"
DATABASE_USER="postgres"
DATABASE_PASSWORD="postgres"
DATABASE_HOST="db"
DATABASE_PORT="5432"
# DJANGO: These settings are required to create a super user when starting the
# application
DJANGO_DEBUG="True"
DJANGO_SUPERUSER_USERNAME="superuser"
DJANGO_SUPERUSER_EMAIL="superuser@example.com"
DJANGO_SUPERUSER_PASSWORD="example-password"
# FIREBASE: To get Firebase credentials for Cloud Messaging, follow these steps:
# 1. Go to Firebase Console (https://console.firebase.google.com)
# 2. Select the diplicity-react project
# 3. Go to Project Settings (gear icon) -> Service accounts
# 4. Click "Generate New Private Key" button
# 5. Save the JSON file and use its contents to fill in these values:
FIREBASE_TYPE="service_account"
FIREBASE_PROJECT_ID="your-project-id"
FIREBASE_PRIVATE_KEY_ID="your-private-key-id"
# Note: The private key should include the full key including
# the "-----BEGIN PRIVATE KEY-----" and "-----END PRIVATE KEY-----"
FIREBASE_PRIVATE_KEY="your-private-key"
FIREBASE_CLIENT_EMAIL="your-client-email"
FIREBASE_CLIENT_ID="your-client-id"
FIREBASE_AUTH_URI="https://accounts.google.com/o/oauth2/auth"
FIREBASE_TOKEN_URI="https://oauth2.googleapis.com/token"
FIREBASE_AUTH_PROVIDER_X509_CERT_URL="https://www.googleapis.com/oauth2/v1/certs"
FIREBASE_CLIENT_X509_CERT_URL="your-client-x509-cert-uri"
# GOOGLE OAUTH: You need to log into the Google Cloud Console to get the
# credentials for the Diplicity Django Web application. Here are the steps:
# 1. Go to Google Cloud Console
# 2. Make sure you are using the diplicity-django project
# 3. Under "APIs and Services" -> "Credentials" find "Diplicity Django Web"
# under "OAuth 2.0 Client IDs"
# 4. Copy the "Client ID" and "Client Secret" and paste them below as:
GOOGLE_OAUTH_CLIENT_ID="your-client-id"
GOOGLE_OAUTH_CLIENT_SECRET="your-client-secret"
# DJANGO: For local development, we use the default Django secret key.
# Sign into sentry.io
SENTRY_DSN="your-sentry-dsn"
# SOCIAL SECRET: This is a secret key used as a password for social auth.
# For local development, this can be any random string.
SOCIAL_SECRET="your-social-secret"
# VITE_GOOGLE_CLIENT_ID: This is the client ID for the Google OAuth client.
# Use the same values as GOOGLE_OAUTH_CLIENT_ID
VITE_GOOGLE_CLIENT_ID="your-client-id"
# GOOGLE IOS OAUTH: The iOS OAuth client ID is used for native Google Sign-In
# on iOS devices. Find it in Google Cloud Console under "APIs and Services" ->
# "Credentials" -> "OAuth 2.0 Client IDs" (look for the iOS client).
# The backend uses GOOGLE_IOS_CLIENT_ID to validate tokens from native iOS auth.
# The frontend uses VITE_GOOGLE_IOS_CLIENT_ID to initialize the native auth plugin.
GOOGLE_IOS_CLIENT_ID="your-ios-client-id"
VITE_GOOGLE_IOS_CLIENT_ID="your-ios-client-id"
# APPLE WEB SIGN-IN: Web "Sign in with Apple" uses an Apple Services ID as the
# OAuth client_id (distinct from the iOS bundle id com.diplicity.app). Create a
# Services ID in the Apple Developer portal, enable Sign in with Apple, and
# register the web domain(s) and Return URL(s).
# The backend adds APPLE_WEB_CLIENT_ID to the set of accepted token audiences.
# The frontend uses VITE_APPLE_WEB_CLIENT_ID as the client_id and
# VITE_APPLE_REDIRECT_URI (must exactly match a registered Apple Return URL).
APPLE_WEB_CLIENT_ID="com.diplicity.web"
VITE_APPLE_WEB_CLIENT_ID="com.diplicity.web"
VITE_APPLE_REDIRECT_URI="https://diplicity.com"
# VITE_DIPLICITY_API_BASE_URL: This is the URL for the Diplicity API.
# For local development, this should be "http://localhost:8000"
VITE_DIPLICITY_API_BASE_URL="http://localhost:8000"
# VITE_MAINTENANCE_MODE: Set to "true" to enable maintenance mode display
VITE_MAINTENANCE_MODE="false"
# HONEYCOMB OBSERVABILITY: Set up OpenTelemetry tracing to Honeycomb
# To get your Honeycomb API key:
# 1. Go to https://ui.honeycomb.io/account
# 2. Navigate to "Team Settings" -> "Environments & API Keys"
# 3. Create a new API key or use an existing one
# 4. Copy the API key and paste it below
# Backend observability
HONEYCOMB_API_KEY="your-honeycomb-api-key-here"
OTEL_SERVICE_NAME="diplicity-service"
# Frontend observability
# Use the same Honeycomb API key for both frontend and backend
VITE_HONEYCOMB_API_KEY="your-honeycomb-api-key-here"
VITE_OTEL_SERVICE_NAME="diplicity-web"
# VITE_SENTRY_DSN: Data Source Name for Sentry error tracking
# Get this from your Sentry project settings at https://sentry.io
# Leave empty to disable Sentry error tracking
VITE_SENTRY_DSN=""
# FIREBASE CLIENT CONFIG: Client-side Firebase configuration for the web app.
# These values come from Firebase Console -> Project Settings -> General -> Your apps -> Web app.
# Note: These are public client-side identifiers (embedded in JS), not secrets.
VITE_FIREBASE_API_KEY="your-firebase-api-key"
VITE_FIREBASE_AUTH_DOMAIN="your-project-id.firebaseapp.com"
VITE_FIREBASE_PROJECT_ID="your-project-id"
VITE_FIREBASE_STORAGE_BUCKET="your-project-id.firebasestorage.app"
VITE_FIREBASE_MESSAGING_SENDER_ID="your-messaging-sender-id"
VITE_FIREBASE_APP_ID="your-firebase-app-id"
VITE_FIREBASE_MEASUREMENT_ID="your-measurement-id"
# CAPACITOR IOS: Configuration for the iOS Capacitor app.
# These values come from Firebase Console -> Project Settings -> General -> Your apps -> Apple apps.
CAPACITOR_IOS_BUNDLE_ID="com.diplicity.app"
CAPACITOR_IOS_TEAM_ID="your-team-id"
CAPACITOR_IOS_FIREBASE_APP_ID="your-ios-firebase-app-id"
CAPACITOR_IOS_FIREBASE_ENCODED_APP_ID="your-ios-encoded-app-id"
# CAPACITOR ANDROID: Configuration for the Android Capacitor app.
# These values come from Firebase Console -> Project Settings -> General -> Your apps -> Android apps.
CAPACITOR_ANDROID_BUNDLE_ID="com.diplicity.app"
# FRONTEND_URL: The base URL for the frontend app, used to build deep-link URLs in push notifications.
FRONTEND_URL="https://diplicity.com"