Config Keys

This list is generated from module default configuration files.

Key	Default	Environment	Description	Source
docs.expose	—	DOCS_EXPOSE	Expose docs endpoints. Boolean flag (defaults to false when unset).	docs.ts
docs.endpoints	—	—	Configuration value.	docs.ts
docs.endpoints.openapi	—	—	Docs endpoints toggles.	docs.ts
docs.endpoints.openapi.file	—	DOCS_ENDPOINTS_OPENAPI	Docs endpoints toggles.	docs.ts
docs.endpoints.openapi.ui	—	DOCS_ENDPOINTS_OPENAPI_UI	Docs endpoints toggles.	docs.ts
docs.endpoints.scalar	—	DOCS_ENDPOINTS_SCALAR	Docs endpoints toggles.	docs.ts
docs.security	—	—	Configuration value.	docs.ts
docs.security.enabled	—	DOCS_SECURED	Boolean flag (defaults to false when unset).	docs.ts
docs.security.username	"openapi"	DOCS_USERNAME	Configuration value.	docs.ts
docs.security.password	"openapi"	DOCS_PASSWORD	Configuration value.	docs.ts
http.listen	"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	7200	HTTP_PORT	The PORT on which we listen for connections. Customize the value for this parameter as needed. /	http.ts
http.paths	—	—	Configuration value.	http.ts
http.paths.api	"/api/v1"	API_BASE_PATH	Base path for API routes.	http.ts
http.paths.docs	"/api/docs"	DOCS_BASE_PATH	Base path for documentation routes.	http.ts
http.urls	—	—	A map with the default URLs that can be generated by the framework for your application. /	http.ts
http.urls.app	computed	HTTP_URLS_APP, HTTP_PORT	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	computed	HTTP_URLS_UI, HTTP_PORT	The URL that can be used to access the frontend application. /	http.ts
http.cookie	—	—	Cookie configuration object. Through these parameters, we can limit the scope of our cookies and who can access the data exposed by them. We recommend that you use SECURE cookies when deployed in production. /	http.ts
http.cookie.domain	"localhost"	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
http.cookie.secure	—	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
http.cookie.secret	""	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
http.cors	—	—	Cross-Origin Request Sharing Configuration QObject. Through this object we configure the CORS functionality of the HTTP server. Through CORS we can enable or disable access to various methods, headers etc. Also, we can limit the access to our application only for certain IPs. /	http.ts
http.cors.origin	"*"	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
http.cors.methods	"GET,HEAD,PUT,PATCH,POST,DELETE"	CORS_METHODS	The HTTP Verbs/Methods for which we want to enable CORS. /	http.ts
http.cors.allowedHeaders	—	CORS_ALLOWED_HEADERS	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
http.cors.exposedHeaders	—	CORS_EXPOSES_HEADERS	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
http.cors.credentials	—	CORS_CREDENTIALS	The allowed credentials in any request protected by CORS. /	http.ts
http.cors.maxAge	—	CORS_MAX_AGE	Sets the maximum age of any CORS request. /	http.ts
http.cors.optionsSuccessStatus	204	CORS_OPTIONS_SUCCESS	Provides a status code to use for successful OPTIONS requests, since some legacy browsers (IE11, various SmartTVs) choke on 204. /	http.ts
http.cors.preflightContinue	—	CORS_PREFLIGHT	Pass the CORS preflight response to the next handler. /	http.ts
http.session	—	—	Configuration value.	http.ts
http.session.secret	"thisIsAS3cret"	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
http.session.store	"memory"	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
http.session.ttlSeconds	86400	SESSION_TTL_SECONDS	Session TTL in seconds forwarded to the store driver. /	http.ts
http.session.file	—	—	Configuration value.	http.ts
http.session.file.folder	".sessions"	SESSION_FILE_FOLDER	Configuration value.	http.ts
http.session.redis	—	—	Configuration value.	http.ts
http.session.redis.host	"127.0.0.1"	SESSION_REDIS_HOST	Configuration value.	http.ts
http.session.redis.port	6379	SESSION_REDIS_PORT	Configuration value.	http.ts
http.session.redis.password	""	SESSION_REDIS_PASSWORD	Configuration value.	http.ts
http.session.redis.db	0	SESSION_REDIS_DB	Configuration value.	http.ts
http.session.redis.keyPrefix	"quik:session:"	SESSION_REDIS_KEY_PREFIX	Configuration value.	http.ts
http.helmet	—	—	Helmet security middleware options passed directly to `helmet()`. Set a key to `false` to disable that protection, or provide an object to configure it. Defaults disable `contentSecurityPolicy` and `crossOriginEmbedderPolicy` for broad compatibility. /	http.ts
http.helmet.contentSecurityPolicy	false,	—	Configuration value.	http.ts
http.helmet.crossOriginEmbedderPolicy	false	—	Configuration value.	http.ts
http.headers	—	—	Default response headers merged into every response. Endpoint-specific headers override these defaults. /	http.ts
http.body	—	—	Request body parsing limits. /	http.ts
http.body.jsonLimit	"1mb"	HTTP_BODY_JSON_LIMIT	HTTP body parsing limits.	http.ts
http.body.urlencodedLimit	"1mb"	HTTP_BODY_URLENCODED_LIMIT	HTTP body parsing limits.	http.ts
http.body.textLimit	"1mb"	HTTP_BODY_TEXT_LIMIT	HTTP body parsing limits.	http.ts
http.timeouts	—	—	HTTP server timeout configuration. /	http.ts
http.timeouts.requestMs	0	HTTP_REQUEST_TIMEOUT_MS	HTTP timeout configuration.	http.ts
http.timeouts.headersMs	0	HTTP_HEADERS_TIMEOUT_MS	HTTP timeout configuration.	http.ts
http.timeouts.shutdownMs	15000	HTTP_SHUTDOWN_TIMEOUT_MS	HTTP timeout configuration.	http.ts
http.static	—	—	Configuration value.	http.ts
http.static.serve	—	HTTP_STATIC_CONTENT_SERVE	Boolean flag (defaults to false when unset).	http.ts
http.static.global	—	HTTP_STATIC_CONTENT_GLOBAL	Boolean flag (defaults to false when unset).	http.ts
http.static.folder	"./public"	HTTP_STATIC_CONTENT_FOLDER	Configuration value.	http.ts
http.static.path	""	HTTP_STATIC_CONTENT_PATH	Configuration value.	http.ts
http.static.singlePageApplication	—	—	Configuration value.	http.ts
http.static.singlePageApplication.enable	—	HTTP_STATIC_SINGLE_PAGE_APPLICATION_ENABLE	Boolean flag (defaults to false when unset).	http.ts
http.static.singlePageApplication.indexFile	"index.html"	HTTP_STATIC_SINGLE_PAGE_APPLICATION_INDEX_FILE	Configuration value.	http.ts
logs.httpFormat	"combined"	LOG_HTTP_FORMAT	The format used to display the log information for HTTP requests. The supported formats are: "combined", "compact", "dev", "short", "tiny" /	logs.ts