Skip to content

Commit 7ec5e75

Browse files
committed
docs(env): update documentation for conditional environment variables
- Change REQUIRED to CONDITIONALLY REQUIRED for Firebase and OneSignal variables - Add clarification that the server will start without these variables - Emphasize the importance of these variables for their respective notification services
1 parent 5de379a commit 7ec5e75

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

.env.example

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,23 +57,28 @@
5757
# Defaults to 15 minutes if not specified.
5858
# COUNTRY_SERVICE_CACHE_MINUTES=15
5959

60-
# REQUIRED: The Firebase Project ID for push notifications.
60+
# CONDITIONALLY REQUIRED: The Firebase Project ID for push notifications.
61+
# The server will start without this, but it is required to use Firebase for notifications.
6162
# This is part of your Firebase service account credentials.
6263
# FIREBASE_PROJECT_ID="your-firebase-project-id"
6364

64-
# REQUIRED: The Firebase Client Email for push notifications.
65+
# CONDITIONALLY REQUIRED: The Firebase Client Email for push notifications.
66+
# The server will start without this, but it is required to use Firebase for notifications.
6567
# This is part of your Firebase service account credentials.
6668
# FIREBASE_CLIENT_EMAIL="your-firebase-client-email"
6769

68-
# REQUIRED: The Firebase Private Key for push notifications.
70+
# CONDITIONALLY REQUIRED: The Firebase Private Key for push notifications.
71+
# The server will start without this, but it is required to use Firebase for notifications.
6972
# This is part of your Firebase service account credentials.
7073
# Ensure this is stored securely and correctly formatted (e.g., replace newlines with \n if needed for single-line env var).
7174
# FIREBASE_PRIVATE_KEY="your-firebase-private-key"
7275

73-
# REQUIRED: The OneSignal App ID for push notifications.
76+
# CONDITIONALLY REQUIRED: The OneSignal App ID for push notifications.
77+
# The server will start without this, but it is required to use OneSignal for notifications.
7478
# This identifies your application within OneSignal.
7579
# ONESIGNAL_APP_ID="your-onesignal-app-id"
7680

77-
# REQUIRED: The OneSignal REST API Key for server-side push notifications.
81+
# CONDITIONALLY REQUIRED: The OneSignal REST API Key for server-side push notifications.
82+
# The server will start without this, but it is required to use OneSignal for notifications.
7883
# This is used to authenticate with the OneSignal API.
7984
# ONESIGNAL_REST_API_KEY="your-onesignal-rest-api-key"

0 commit comments

Comments
 (0)