Configuration

Environment Variables

Name	Type	Required	Description
APP_LISTEN_PORT	Number	ㅤ	Port to listen (default is `8000`)
APP_LISTEN_HOSTNAME	String	ㅤ	Hostname (default is `0.0.0.0`)
APP_HOMEPAGE_URL	String	ㅤ	Website homepage URL (e.g. `https://exampledomain.com`)
APP_DISABLE_REGISTRATION	Boolean	ㅤ	Disable user registration (default is `false`)
COOKIE_MAX_AGE	String	ㅤ	Cookie max age (default is `1year`)
SESSION_KEY	String	✅	Session encryption key
SESSION_MAX_AGE	String	ㅤ	Session max age (default is `15days`)
UPLOAD_FILE_TYPES	String	ㅤ	Upload file types (e.g. .jpg,.png,.bmp,.zip)
UPLOAD_FILE_SIZE	Number	ㅤ	Upload file size (default is `10mb`)
FORM_ENCRYPTION_KEY	String	✅	Form encryption key
BCRYPT_SALT	Number	ㅤ	Bcrypt salt (default is `10`)
MONGO_URI	String	✅	MongoDB URI, for docker it should be like `mongodb://mongo:27017/heyform`
MONGO_USER	String	ㅤ	MongoDB user
MONGO_PASSWORD	String	ㅤ	MongoDB password
MONGO_SSL_CA_PATH	String	ㅤ	MongoDB SSL CA path
REDIS_HOST	String	ㅤ	Redis host (default is `127.0.0.1`), for docker it should be `redis`
REDIS_PORT	Number	ㅤ	Redis port (default is `6379`)
REDIS_PASSWORD	String	ㅤ	Redis password
REDIS_DB	Number	ㅤ	Redis DB (default is `0`)
VERIFY_USER_EMAIL	Boolean	ㅤ	Whether it is necessary to verify the email addresses of the new users (default is `false`)
SMTP_FROM	String	ㅤ	SMTP from (e.g. `Heyform <[email protected]>`)
SMTP_HOST	String	ㅤ	SMTP host
SMTP_PORT	Number	ㅤ	SMTP port
SMTP_USER	String	ㅤ	SMTP user
SMTP_SECURE	Boolean	ㅤ	If `true`the connection will use TLS when connecting to server
SMTP_IGNORE_CERT	Boolean	ㅤ	If `true` will ignore TLS certificate errors
SMTP_PASSWORD	String	ㅤ	SMTP password
GOOGLE_RECAPTCHA_KEY	String	ㅤ	Google reCAPTCHA key
GOOGLE_RECAPTCHA_SECRET	String	ㅤ	Google reCAPTCHA secret
GEETEST4_CAPTCHA_ID	String	ㅤ	Geetest captcha 4 ID
GEETEST4_CAPTCHA_KEY	String	ㅤ	Geetest captcha 4 key
AKISMET_KEY	String	ㅤ	Akismet key
APPLE_LOGIN_TEAM_ID	String	ㅤ	Apple login team ID
APPLE_LOGIN_WEB_CLIENT_ID	String	ㅤ	Apple login web client ID
APPLE_LOGIN_KEY_ID	String	ㅤ	Apple login key ID
APPLE_LOGIN_PRIVATE_KEY_PATH	String	ㅤ	Apple login private key path
GOOGLE_LOGIN_CLIENT_ID	String	ㅤ	Google login client ID
GOOGLE_LOGIN_CLIENT_SECRET	String	ㅤ	Google login client secret
STRIPE_PUBLISHABLE_KEY	String	ㅤ	Stripe Publishable Key
STRIPE_SECRET_KEY	String	ㅤ	Stripe secret key
STRIPE_CONNECT_CLIENT_ID	String	ㅤ	Stripe connect client ID
STRIPE_WEBHOOK_SECRET_KEY	String	ㅤ	Stripe payment webhook secret key
BULL_JOB_ATTEMPTS	Number	ㅤ	Bull job attempts (default is `3`)
BULL_JOB_TIMEOUT	String	ㅤ	Bull job timeout (default is `1minute`)
BULL_JOB_BACKOFF_DELAY	Number	ㅤ	Bull job backoff delay (default is `3000`)
BULL_JOB_BACKOFF_TYPE	String	ㅤ	Bull job backoff type (default is 'fixed')
INVITE_CODE_EXPIRE_DAYS	Number	ㅤ	Invite code expire days (default is `7`)
FORM_REPORT_RATE	String	ㅤ	Form report rate (default is `5seconds`)
VERIFICATION_CODE_EXPIRE	String	ㅤ	Verification code expire (default is `10minutes`)
VERIFICATION_CODE_LIMIT	Number	ㅤ	Verification code limit (default is `5`)
ACCOUNT_DELETION_SCHEDULE_INTERVAL	String	ㅤ	Account deletion schedule interval (default is `2days`)
UNSPLASH_CLIENT_ID	String	ㅤ	Unsplash client ID (Access Key)
OPENAI_BASE_URL	String	ㅤ	OpenAI API base URL (default is `https://api.openai.com/v1`)
OPENAI_API_KEY	String	ㅤ	OpenAI API key, you can find it on https://platform.openai.com/api-keys
OPENAI_GPT_MODEL	String	ㅤ	GPT model (default is `gpt-3.5-turbo-0125`)
S3_ENDPOINT	String	ㅤ	S3 service endpoint
S3_REGION	String	ㅤ	S3 region
S3_BUCKET	String	ㅤ	S3 bucket
S3_ACCESS_KEY_ID	String	ㅤ	ㅤ
S3_SECRET_ACCESS_KEY	String	ㅤ	ㅤ
S3_PUBLIC_URL	String	ㅤ	Setup this if you bind a custom domain to your S3 bucket, e.g. `https://s3.heyform.net`

Authentication

Currently, HeyForm only supports login with Google and Apple.

S3 static files

Support for storage providers that adhere to the AWS S3 protocol, such as AWS S3 and Cloudflare R2.

Stripe

Connect with Stripe