FormSG/.env.example at develop · Strikerprv/FormSG · GitHub

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
128
129
130
131
132
133
# Environment variables already in docker-compose will take priority over the
# ones declared here.
# For more information of what they do, check out
# https://github.com/datagovsg/formsg/blob/master/docs/DEPLOYMENT_SETUP.md.

#### Required variables
### If these variables are missing, running the app in production mode will
### cause an error to be thrown. For development mode, the necessary defaults
### are defined in docker-compose.yml.
## App Config
DB_HOST=

## AWS Config
ATTACHMENT_S3_BUCKET=
PAYMENT_PROOF_S3_BUCKET=
IMAGE_S3_BUCKET=
STATIC_ASSETS_S3_BUCKET=
LOGO_S3_BUCKET=
VIRUS_SCANNER_QUARANTINE_S3_BUCKET=
VIRUS_SCANNER_CLEAN_S3_BUCKET=
GUARDDUTY_QUARANTINE_S3_BUCKET=
GUARDDUTY_CLEAN_S3_BUCKET=
SES_HOST=
SES_PASS=
SES_USER=
SES_PORT=
AWS_SECRET_ACCESS_KEY=
AWS_ACCESS_KEY_ID=

# One of: "development" | "staging" | "production"
FORMSG_SDK_MODE=


#### Optional variables, some have defaults defined here, as well as in `config/schema`

## App Config
# APP_NAME=FormSG
# OTP_LIFE_SPAN=900000
# BOUNCE_LIFE_SPAN=86400000

# If provided, a banner with the provided message will show up in every form.
# IS_GENERAL_MAINTENANCE=

# If provided, a banner with the provided message will show up in both private
# and public form routes. This supersedes ALL other banner environment variables
# like IS_GENERAL_MAINTENANCE, IS_LOGIN_BANNER, or ADMIN_BANNER_CONTENT
# SITE_BANNER_CONTENT=

# If provided, a banner with the provided message will show up in private
# form routes.
# ADMIN_BANNER_CONTENT=


## AWS
# AWS_REGION=

## Google Services
## If the below variables exists, the [captcha] feature will be enabled.
# GOOGLE_CAPTCHA=
# GOOGLE_CAPTCHA_PUBLIC=


## Keys for storage mode
# If forking this repository, you will also need to fork @opengovsg/formsg-sdk
# to supply your public keys paired to this secret key environment variable
# for verifying signed content.
# SIGNING_SECRET_KEY=

## Verified fields
## If the variable exists, the [verified] feature will be enabled.
# VERIFICATION_SECRET_KEY=


## SingPass, CorpPass related environment variables
# If you are not a member of the Singapore Government, you can safely exclude
# these environment variables.
# Default environment variables have been included for local development
# purposes.
# MYINFO_CLIENT_CONFIG=stg
# MYINFO_FORMSG_KEY_PATH=./node_modules/@opengovsg/mockpass/static/certs/key.pem
# MYINFO_CERT_PATH=./node_modules/@opengovsg/mockpass/static/certs/spcp.crt
# MYINFO_CLIENT_ID=
# MYINFO_CLIENT_SECRET=
# MYINFO_JWT_SECRET=
# SINGPASS_ESRVC_ID=GOVTECH-FORMSG-SP #Needed for MyInfo

# SP_OIDC_NDI_DISCOVERY_ENDPOINT=https://stg-id.singpass.gov.sg/.well-known/openid-configuration
# SP_OIDC_NDI_JWKS_ENDPOINT=https://stg-id.singpass.gov.sg/.well-known/keys
# SP_OIDC_RP_CLIENT_ID=
# SP_OIDC_RP_REDIRECT_URL=
# SP_OIDC_RP_JWKS_PUBLIC_PATH=
# SP_OIDC_RP_JWKS_SECRET_PATH=
# CP_OIDC_NDI_DISCOVERY_ENDPOINT=https://stg-id.corppass.gov.sg/.well-known/openid-configuration
# CP_OIDC_NDI_JWKS_ENDPOINT=https://stg-id.corppass.gov.sg/.well-known/keys
# CP_OIDC_RP_CLIENT_ID=
# CP_OIDC_RP_REDIRECT_URL=
# CP_OIDC_RP_JWKS_PUBLIC_PATH=
# CP_OIDC_RP_JWKS_SECRET_PATH=

# IS_SP_MAINTENANCE=
# IS_CP_MAINTENANCE=
# MYINFO_BANNER_CONTENT=

## Per-minute, per-IP request limits applied to specific endpoints
# SUBMISSIONS_RATE_LIMIT=
# SEND_AUTH_OTP_RATE_LIMIT=
# DOWNLOAD_FORM_WHITELIST_RATE_LIMIT=
# UPLOAD_FORM_WHITELIST_RATE_LIMIT=

# Used to check if BE Server is currently running on local development environment
# One of boolean: "true" | "false"
# USE_MOCK_POSTMAN_SMS=

# POSTMAN_MOP_CAMPAIGN_ID=
# POSTMAN_MOP_CAMPAIGN_API_KEY=
# POSTMAN_INTERNAL_CAMPAIGN_ID=
# POSTMAN_INTERNAL_CAMPAIGN_API_KEY=
# POSTMAN_BASE_URL=https://test.postman.gov.sg/api/v2

## Azure OpenAI
# AZURE_OPENAI_API_KEY=
# AZURE_OPENAI_ENDPOINT=
# AZURE_OPENAI_DEPLOYMENT_NAME=
# AZURE_OPENAI_API_VERSION=

## Kill email mode configs, provide a valid storage form id
# KILL_EMAIL_MODE_FEEDBACK_FORMID=

# For WOG AD Login
# WOGAD_AUTHORITY=
# WOGAD_CLIENT_ID=
# WOGAD_CLIENT_SECRET=
# WOGAD_REDIRECT_URI=