Environment Variables

Environment variables reference for self-hosted HeyForm.

NameTypeRequiredDescription
APP_LISTEN_PORTNumberPort to listen (default is 8000)
APP_LISTEN_HOSTNAMEStringHostname (default is 0.0.0.0)
APP_HOMEPAGE_URLStringWebsite homepage URL (e.g. https://exampledomain.com)
APP_DISABLE_REGISTRATIONBooleanDisable user registration (default is false)
COOKIE_MAX_AGEStringCookie max age (default is 1year)
SESSION_KEYString✅Session encryption key
SESSION_MAX_AGEStringSession max age (default is 15days)
UPLOAD_FILE_TYPESStringUpload file types (e.g. .jpg,.png,.bmp,.zip)
UPLOAD_FILE_SIZENumberUpload file size (default is 10mb)
FORM_ENCRYPTION_KEYString✅Form encryption key
BCRYPT_SALTNumberBcrypt salt (default is 10)
MONGO_URIString✅MongoDB URI, for docker it should be like mongodb://mongo:27017/heyform
MONGO_USERStringMongoDB user
MONGO_PASSWORDStringMongoDB password
MONGO_SSL_CA_PATHStringMongoDB SSL CA path
REDIS_HOSTStringRedis host (default is 127.0.0.1), for docker it should be redis
REDIS_PORTNumberRedis port (default is 6379)
REDIS_PASSWORDStringRedis password
REDIS_DBNumberRedis DB (default is 0)
VERIFY_USER_EMAILBooleanWhether it is necessary to verify the email addresses of the new users (default is false)
SMTP_FROMStringSMTP from (e.g. Heyform <[email protected]>)
SMTP_HOSTStringSMTP host
SMTP_PORTNumberSMTP port
SMTP_USERStringSMTP user
SMTP_SECUREBooleanIf truethe connection will use TLS when connecting to server
SMTP_IGNORE_CERTBooleanIf true will ignore TLS certificate errors
SMTP_PASSWORDStringSMTP password
GOOGLE_RECAPTCHA_KEYStringhttps://cloud.google.com/recaptcha-enterprise/docs/create-key-website
GOOGLE_RECAPTCHA_SECRETStringGoogle reCAPTCHA secret
GEETEST4_CAPTCHA_IDStringhttps://docs.geetest.com/captcha/overview/guide#Step-1-Get-your-captcha-ID-and-KEY
GEETEST4_CAPTCHA_KEYStringGeetest captcha 4 key
AKISMET_KEYStringAkismet key
APPLE_LOGIN_TEAM_IDStringApple login team ID
APPLE_LOGIN_WEB_CLIENT_IDStringApple login web client ID
APPLE_LOGIN_KEY_IDStringApple login key ID
APPLE_LOGIN_PRIVATE_KEY_PATHStringApple login private key path
GOOGLE_LOGIN_CLIENT_IDStringGoogle login client ID
GOOGLE_LOGIN_CLIENT_SECRETStringGoogle login client secret
STRIPE_PUBLISHABLE_KEYStringhttps://docs.stripe.com/keys
STRIPE_SECRET_KEYStringStripe secret key
STRIPE_CONNECT_CLIENT_IDStringStripe connect client ID
STRIPE_WEBHOOK_SECRET_KEYStringStripe payment webhook secret key
BULL_JOB_ATTEMPTSNumberBull job attempts (default is 3)
BULL_JOB_TIMEOUTStringBull job timeout (default is 1minute)
BULL_JOB_BACKOFF_DELAYNumberBull job backoff delay (default is 3000)
BULL_JOB_BACKOFF_TYPEStringBull job backoff type (default is 'fixed')
INVITE_CODE_EXPIRE_DAYSNumberInvite code expire days (default is 7)
FORM_REPORT_RATEStringForm report rate (default is 5seconds)
VERIFICATION_CODE_EXPIREStringVerification code expire (default is 10minutes)
VERIFICATION_CODE_LIMITNumberVerification code limit (default is 5)
ACCOUNT_DELETION_SCHEDULE_INTERVALStringAccount deletion schedule interval (default is 2days)
UNSPLASH_CLIENT_IDStringUnsplash client ID (Access Key)
OPENAI_BASE_URLStringhttps://github.com/openai/openai-node/blob/11c2f361ddf6d75ec3706cbdfd5dfc60e4293368/src/index.ts#L130https://github.com/openai/openai-node/blob/11c2f361ddf6d75ec3706cbdfd5dfc60e4293368/src/index.ts#L130base URL (default is https://api.openai.com/v1)
OPENAI_API_KEYStringOpenAI API key, you can find it on https://platform.openai.com/api-keys
OPENAI_GPT_MODELStringGPT model (default is gpt-3.5-turbo-0125)
Zapier
Authentication