Environment Variables

Boolean flags default to false when unset.

Variable	Type	Default	Config Keys	Description	Source
API_BASE_PATH	string	"/api/v1"	http.paths.api	Base path for API routes. Config key: `http.paths.api`.	http.ts
COOKIE_DOMAIN	string	"localhost"	http.cookie.domain	The domain on which the application exposes the cookies. If your users try to use cookies outside your domain, this parameter will block them from using. We do not recommend the usage of cookies for storing important data. /	http.ts
COOKIE_SECRET	string	""	http.cookie.secret	Secret used to sign cookies. When set, `req.signedCookies` will contain verified, tamper-proof values. Leave empty to disable cookie signing. /	http.ts
COOKIE_SECURE	flag	—	http.cookie.secure	Flag to mark if a cookie is secure or not. When using HTTPS, you should ALWAYS mark the cookies as secure, even when you are using a Proxy in front. /	http.ts
CORS_ALLOWED_HEADERS	string	—	http.cors.allowedHeaders	The allowed headers in any request protected by CORS. If you want to allow all headers, do not set any value to this parameter. /	http.ts
CORS_CREDENTIALS	boolean	—	http.cors.credentials	The allowed credentials in any request protected by CORS. /	http.ts
CORS_EXPOSES_HEADERS	string	—	http.cors.exposedHeaders	The exposed headers in any request protected by CORS. If you want to expose all headers, do not set any value to this parameter. /	http.ts
CORS_MAX_AGE	int	—	http.cors.maxAge	Sets the maximum age of any CORS request. /	http.ts
CORS_METHODS	string	"GET,HEAD,PUT,PATCH,POST,DELETE"	http.cors.methods	The HTTP Verbs/Methods for which we want to enable CORS. /	http.ts
CORS_OPTIONS_SUCCESS	int	204	http.cors.optionsSuccessStatus	computed	http.ts
CORS_ORIGIN	string	"*"	http.cors.origin	The list of IPs for which we enable the access to our application. If you want to enable access to everyone set the value to "*" or leave it as it is. /	http.ts
CORS_PREFLIGHT	boolean	—	http.cors.preflightContinue	Pass the CORS preflight response to the next handler. /	http.ts
DOCS_BASE_PATH	string	"/api/docs"	http.paths.docs	Base path for documentation routes. Config key: `http.paths.docs`.	http.ts
DOCS_ENDPOINTS_OPENAPI	flag	—	docs.endpoints.openapi.file	Docs endpoints toggles. Config key: `docs.endpoints.openapi.file`.	docs.ts
DOCS_ENDPOINTS_OPENAPI_UI	flag	—	docs.endpoints.openapi.ui	Docs endpoints toggles. Config key: `docs.endpoints.openapi.ui`.	docs.ts
DOCS_ENDPOINTS_SCALAR	flag	—	docs.endpoints.scalar	Docs endpoints toggles. Config key: `docs.endpoints.scalar`.	docs.ts
DOCS_EXPOSE	flag	—	docs.expose	Enable docs endpoints. Config key: `docs.expose`.	docs.ts
DOCS_PASSWORD	string	"openapi"	docs.security.password	Docs basic auth password. Config key: `docs.security.password`.	docs.ts
DOCS_SECURED	flag	—	docs.security.enabled	Require auth for docs endpoints. Config key: `docs.security.enabled`.	docs.ts
DOCS_USERNAME	string	"openapi"	docs.security.username	Docs basic auth username. Config key: `docs.security.username`.	docs.ts
HTTP_BODY_JSON_LIMIT	string	"1mb"	http.body.jsonLimit	Request body parsing limits. /	http.ts
HTTP_BODY_TEXT_LIMIT	string	"1mb"	http.body.textLimit	HTTP body parsing limits. Config key: `http.body.textLimit`.	http.ts
HTTP_BODY_URLENCODED_LIMIT	string	"1mb"	http.body.urlencodedLimit	HTTP body parsing limits. Config key: `http.body.urlencodedLimit`.	http.ts
HTTP_HEADERS_TIMEOUT_MS	int	0	http.timeouts.headersMs	HTTP timeout settings. Config key: `http.timeouts.headersMs`.	http.ts
HTTP_LISTEN	string	"127.0.0.1"	http.listen	The IP address on which we want to listen for connections. If you intend to use a Proxy server in front of the application, we recommend using the default value: "127.0.0.1". Otherwise, set it to "0.0.0.0" or a specific ip. /	http.ts
HTTP_PORT	int	7200	http.port, http.urls.app, http.urls.ui	The PORT on which we listen for connections. Customize the value for this parameter as needed. /	http.ts
HTTP_REQUEST_TIMEOUT_MS	int	0	http.timeouts.requestMs	HTTP server timeout configuration. /	http.ts
HTTP_SHUTDOWN_TIMEOUT_MS	int	15000	http.timeouts.shutdownMs	Configuration value from environment. Config key: `http.timeouts.shutdownMs`.	http.ts
HTTP_STATIC_CONTENT_FOLDER	string	"./public"	http.static.folder	Static content serving settings. Config key: `http.static.folder`.	http.ts
HTTP_STATIC_CONTENT_GLOBAL	flag	—	http.static.global	Static content serving settings. Config key: `http.static.global`.	http.ts
HTTP_STATIC_CONTENT_PATH	string	""	http.static.path	Static content serving settings. Config key: `http.static.path`.	http.ts
HTTP_STATIC_CONTENT_SERVE	flag	—	http.static.serve	Static content serving settings. Config key: `http.static.serve`.	http.ts
HTTP_STATIC_SINGLE_PAGE_APPLICATION_ENABLE	flag	—	http.static.singlePageApplication.enable	computed	http.ts
HTTP_STATIC_SINGLE_PAGE_APPLICATION_INDEX_FILE	string	"index.html"	http.static.singlePageApplication.indexFile	Configuration value from environment. Config key: `http.static.singlePageApplication.indexFile`.	http.ts
HTTP_URLS_APP	url	computed	http.urls.app	The URL that can be used to access the application. This URL is used in various APIs that need to sign/display data about the application. For example, the Documentation API that exposes the route metadata will use this `http.urls.app` parameter to generate valid URL calls. /	http.ts
HTTP_URLS_UI	url	computed	http.urls.ui	The URL that can be used to access the frontend application. /	http.ts
LOG_HTTP_FORMAT	string	"combined"	logs.httpFormat	The format used to display the log information for HTTP requests. The supported formats are: "combined", "compact", "dev", "short", "tiny" /	logs.ts
SESSION_FILE_FOLDER	string	".sessions"	http.session.file.folder	Configuration value from environment. Config key: `http.session.file.folder`.	http.ts
SESSION_REDIS_DB	int	0	http.session.redis.db	Configuration value from environment. Config key: `http.session.redis.db`.	http.ts
SESSION_REDIS_HOST	string	"127.0.0.1"	http.session.redis.host	Configuration value from environment. Config key: `http.session.redis.host`.	http.ts
SESSION_REDIS_KEY_PREFIX	string	"quik:session:"	http.session.redis.keyPrefix	Configuration value from environment. Config key: `http.session.redis.keyPrefix`.	http.ts
SESSION_REDIS_PASSWORD	string	""	http.session.redis.password	Configuration value from environment. Config key: `http.session.redis.password`.	http.ts
SESSION_REDIS_PORT	int	6379	http.session.redis.port	Configuration value from environment. Config key: `http.session.redis.port`.	http.ts
SESSION_SECRET	string	"thisIsAS3cret"	http.session.secret	Since the session should be encoded and not to be easily seen by the user, a secret is required for the session configuration. /	http.ts
SESSION_STORE	string	"memory"	http.session.store	Session store driver: `memory`, `file`, or `redis`. Install the required peer dependency for non-memory drivers in `@quik/http-express`: - `file`: requires `session-file-store`. - `redis`: requires `connect-redis` and `ioredis`. /	http.ts
SESSION_TTL_SECONDS	int	86400	http.session.ttlSeconds	Session TTL in seconds forwarded to the store driver. /	http.ts