-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathexample.env
More file actions
86 lines (83 loc) · 3.98 KB
/
Copy pathexample.env
File metadata and controls
86 lines (83 loc) · 3.98 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
# the main brand name shown in files
VUE_APP_BRAND_NAME_LONG=ORG Test Tracker
# the short name used in the app
VUE_APP_BRAND_NAME_SHORT=ORGTT
# the main brand URL (without trailing slash)
VUE_APP_BRAND_URL=https://example.com
# the main brand homepage used for pwa, etc (without trailing slash)
VUE_APP_BRAND_HOMEPAGE=http://example.com
# the main brand domain (without subdomain)
VUE_APP_BRAND_DOMAIN=example.com
# excluding the hash due to limitations in the .env file
VUE_APP_THEME_COLOR=f5c14b
VUE_APP_THEME_ACCENT_COLOR=000000
VUE_APP_THEME_ACCENT_COLOR_ALT=4c4c4c
# the URL to download the sidebar
VUE_APP_SIDEBAR_DOWNLOAD_URL=/download/orgtt-sidebar.zip
# the domain for the API
VUE_APP_BRAND_DOMAIN__API=api.example.com
# the domain that redirects to the class view
VUE_APP_BRAND_DOMAIN__VIEWCLASS=view.example.com
# the domain that redirects to the task view
VUE_APP_BRAND_DOMAIN__VIEWTASK=view.example.com
# the main mail address for the brand (used to send the invite mail)
VUE_APP_BRAND_MAIL_ADDRESS=mail@example.com
# the API key for the Firebase project
FIREBASE_apiKey=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
# the domain for the Firebase auth
FIREBASE_authDomain=auth.example.com
# the project ID of the Firebase project
FIREBASE_projectId=projectId
# the storage bucket for the Firebase project
FIREBASE_storageBucket=projectId.appspot.com
# the messaging sender ID for the Firebase project
FIREBASE_messagingSenderId=1000000000000
# the app ID for the Firebase project
FIREBASE_appId=1:1000000000000:web:AAAAAAAAAAAAAAAAAAAAAA
# the measurement ID for the Firebase project
FIREBASE_measurementId=G-AAAAAAAAAA
# the server region for the Firebase project
FIREBASE_serverRegion=us-central1
# =============================================================================
# Brief client-config (public/.well-known/brief.json) — generated at build/deploy
# =============================================================================
# NEVER commit real secrets. These Firebase *client* fields are public (same
# values as in the iOS plist / web SDK). Do NOT put service accounts, Admin SDK
# keys, or shared API secrets here. Never commit a hand-edited production
# brief.json — it is always generated.
#
# --- Production cmutt deploy (PREFERRED) — Option C: fetch from live API ---
# Humans edit brochure values only in mvtt-server `.env.cmu-tt` (or equivalent).
# Pages copies GET /api/v1/client-config into /.well-known/brief.json at deploy.
# Put these in the *production* deploy env (e.g. .env / .env.local used by
# `npm run deploy`), not in this example or in .env.test:
#
# BRIEF_FETCH_CONFIG=1
# BRIEF_CONFIG_URL=https://api.cmutt.app/api/v1/client-config
#
# --- Offline CI / forks — Option B: discrete BRIEF_* (below) ---
# .env.test uses these so `npm run build` works without network. Forks without
# a live API can keep composing locally the same way.
#
# --- Optional — Option A: single JSON blob ---
# BRIEF_CLIENT_CONFIG={"name":"ORGTT","apiBase":"https://api.example.com","brandColor":"#f5c14b","firebase":{"apiKey":"...","projectId":"...","appId":"1:...:ios:...","gcmSenderId":"...","clientId":"...","reversedClientId":"...","storageBucket":"...","databaseURL":null,"authDomain":"..."}}
#
# Option B: compose from discrete vars (reuses FIREBASE_* / VUE_APP_* where they match)
BRIEF_NAME=ORGTT
BRIEF_API_BASE=https://api.example.com
BRIEF_BRAND_COLOR=f5c14b
# iOS-only Brief fields (do NOT reuse web FIREBASE_appId)
BRIEF_FIREBASE_APP_ID=1:1000000000000:ios:AAAAAAAAAAAAAAAAAAAAAA
BRIEF_FIREBASE_CLIENT_ID=1000000000000-xxxxxxxx.apps.googleusercontent.com
BRIEF_FIREBASE_REVERSED_CLIENT_ID=com.googleusercontent.apps.1000000000000-xxxxxxxx
# Optional overrides (default to FIREBASE_* / null):
# BRIEF_FIREBASE_API_KEY=
# BRIEF_FIREBASE_PROJECT_ID=
# BRIEF_FIREBASE_GCM_SENDER_ID=
# BRIEF_FIREBASE_STORAGE_BUCKET=
# BRIEF_FIREBASE_AUTH_DOMAIN=
# BRIEF_FIREBASE_DATABASE_URL=
#
# Option C (production cmutt — preferred; see block above):
# BRIEF_FETCH_CONFIG=1
# BRIEF_CONFIG_URL=https://api.cmutt.app/api/v1/client-config