Skip to main content

Environment Variables

This list is generated from default configuration files that call getEnv(). Values are shown exactly as defaults. Boolean flags default to false when unset.

VariableTypeDefaultModulesConfig KeysDescriptionSource
API_BASE_PATHstring"/api/v1"@quik/httphttp.paths.apiBase path for API routes. Config key: `http.paths.api`.http.ts
APP_DESCRIPTIONstring""@quik/coreapp.descriptionA short text that describes the application you are developing. /app.ts
APP_NAMEstring"QuikLand by Spark"@quik/coreapp.nameThe name of the application you are developing. /app.ts
APP_TIMEZONEstring"UTC"@quik/coreapp.timezoneDefault application timezone. Config key: `app.timezone`.app.ts
APP_VERSIONstringcomputed@quik/coreapp.versionThe version of the application you are developing. /app.ts
AUTH_AUTHORIZATION_ASSURANCE_LEVEL_FIELDstring"assuranceLevel"@quik/authorizationauth.authorization.fields.assuranceLevelConfiguration value from environment. Config key: `auth.authorization.fields.assuranceLevel`.auth.ts
AUTH_AUTHORIZATION_AUTHENTICATION_METHODS_FIELDstring"authenticationMethods"@quik/authorizationauth.authorization.fields.authenticationMethodsConfiguration value from environment. Config key: `auth.authorization.fields.authenticationMethods`.auth.ts
AUTH_AUTHORIZATION_COMPLETED_FACTORS_FIELDstring"completedFactors"@quik/authorizationauth.authorization.fields.completedFactorsConfiguration value from environment. Config key: `auth.authorization.fields.completedFactors`.auth.ts
AUTH_CHECK_FIELDstring"permissions"@quik/authorizationauth.authorization.fields.permissionAuthentication system configuration object. In this file, you can change various configuration parameters related to the authentication system. /auth.ts
AUTH_PASSKEY_CHALLENGE_TIME_TO_LIVE_MSint300000@quik/passportauth.passkey.challenge.timeToLiveMsPasskey challenge lifetime in milliseconds. /auth.ts
AUTH_PASSKEY_HTTP_BASE_PATHstring"/auth/passkey"@quik/passportauth.passkey.http.basePathConfiguration value from environment. Config key: `auth.passkey.http.basePath`.auth.ts
AUTH_PASSKEY_HTTP_BEARER_TOKEN_EXPIRES_INstring"1h"@quik/passportauth.passkey.http.bearerTokenExpiresInConfiguration value from environment. Config key: `auth.passkey.http.bearerTokenExpiresIn`.auth.ts
AUTH_PASSKEY_HTTP_ENABLEDflag@quik/passportauth.passkey.http.enabledBuilt-in HTTP endpoint settings for the passkey routes. /auth.ts
AUTH_PASSKEY_HTTP_ISSUE_BEARER_TOKENflag@quik/passportauth.passkey.http.issueBearerTokencomputedauth.ts
AUTH_PASSKEY_HTTP_PERSIST_SESSIONflag@quik/passportauth.passkey.http.persistSessioncomputedauth.ts
AUTH_PASSKEY_RELYING_PARTY_IDstring"localhost"@quik/passportauth.passkey.relyingParty.idDomain identifier for your application, for example `example.com`. /auth.ts
AUTH_PASSKEY_RELYING_PARTY_NAMEstring"Quik"@quik/passportauth.passkey.relyingParty.nameUser-facing name shown by passkey-capable clients. /auth.ts
CACHE_DRIVERstring"memory"@quik/cachecache.driverCache driver to use: `memory`, `file`, or `redis`. Install the required peer dependency for non-memory drivers: - `file`: no extra packages needed. - `redis`: requires `ioredis`. /cache.ts
CACHE_FILE_FOLDERstring".cache"@quik/cachecache.file.folderConfiguration value from environment. Config key: `cache.file.folder`.cache.ts
CACHE_REDIS_DBint0@quik/cachecache.redis.dbConfiguration value from environment. Config key: `cache.redis.db`.cache.ts
CACHE_REDIS_HOSTstring"127.0.0.1"@quik/cachecache.redis.hostConfiguration value from environment. Config key: `cache.redis.host`.cache.ts
CACHE_REDIS_KEY_PREFIXstring"quik:cache:"@quik/cachecache.redis.keyPrefixConfiguration value from environment. Config key: `cache.redis.keyPrefix`.cache.ts
CACHE_REDIS_PASSWORDstring""@quik/cachecache.redis.passwordConfiguration value from environment. Config key: `cache.redis.password`.cache.ts
CACHE_REDIS_PORTint6379@quik/cachecache.redis.portConfiguration value from environment. Config key: `cache.redis.port`.cache.ts
COMMUNICATION_EMAIL_ADDRESSstring"quikland@localhost"@quik/communicationcommunication.email.config.addressThe account or email address used to connect to the email sending server. /communication.ts
COMMUNICATION_EMAIL_ENABLEDflag@quik/communicationcommunication.email.enabledFlag used to enable or disable the email handling service. /communication.ts
COMMUNICATION_EMAIL_ENGINEstring"test"@quik/communicationcommunication.email.engineThe desired email handling transport to be used in the application. /communication.ts
COMMUNICATION_EMAIL_FROMstring"quikland@localhost"@quik/communicationcommunication.email.fromThe email address used as the FROM address in the emails sent through the application. /communication.ts
COMMUNICATION_EMAIL_PASSWORDstring""@quik/communicationcommunication.email.config.passwordThe password for the account used to send an email. /communication.ts
COMMUNICATION_EMAIL_PORTstring"25"@quik/communicationcommunication.email.config.portThe port used to connect to the email server. /communication.ts
COMMUNICATION_EMAIL_RETRY_ATTEMPTSint1@quik/communicationcommunication.email.retry.attemptsEmail channel configuration. Config key: `communication.email.retry.attempts`.communication.ts
COMMUNICATION_EMAIL_RETRY_BACKOFF_FACTORint1@quik/communicationcommunication.email.retry.backoffFactorEmail channel configuration. Config key: `communication.email.retry.backoffFactor`.communication.ts
COMMUNICATION_EMAIL_RETRY_DELAY_MILLISECONDSint0@quik/communicationcommunication.email.retry.delayMillisecondsEmail channel configuration. Config key: `communication.email.retry.delayMilliseconds`.communication.ts
COMMUNICATION_EMAIL_SECUREflag@quik/communicationcommunication.email.config.secureA flag used to define if the server is using a secure connection or not. /communication.ts
COMMUNICATION_EMAIL_SERVERstring"localhost"@quik/communicationcommunication.email.config.serverThe URL or IP of the email sending server. /communication.ts
COMMUNICATION_EMAIL_TIMEOUT_MILLISECONDSint0@quik/communicationcommunication.email.timeoutMillisecondsEmail channel configuration. Config key: `communication.email.timeoutMilliseconds`.communication.ts
COMMUNICATION_SMS_CLIENT_IDENTIFIERstring""@quik/communicationcommunication.sms.config.clientIdentifierSMS channel configuration. Config key: `communication.sms.config.clientIdentifier`.communication.ts
COMMUNICATION_SMS_CLIENT_SECRETstring""@quik/communicationcommunication.sms.config.clientSecretSMS channel configuration. Config key: `communication.sms.config.clientSecret`.communication.ts
COMMUNICATION_SMS_ENABLEDflag@quik/communicationcommunication.sms.enabledSMS channel configuration. Config key: `communication.sms.enabled`.communication.ts
COMMUNICATION_SMS_ENGINEstring"test"@quik/communicationcommunication.sms.engineSMS channel configuration. Config key: `communication.sms.engine`.communication.ts
COMMUNICATION_SMS_FROMstring@quik/communicationcommunication.sms.fromSMS channel configuration. Config key: `communication.sms.from`.communication.ts
COMMUNICATION_SMS_RETRY_ATTEMPTSint1@quik/communicationcommunication.sms.retry.attemptsSMS channel configuration. Config key: `communication.sms.retry.attempts`.communication.ts
COMMUNICATION_SMS_RETRY_BACKOFF_FACTORint1@quik/communicationcommunication.sms.retry.backoffFactorSMS channel configuration. Config key: `communication.sms.retry.backoffFactor`.communication.ts
COMMUNICATION_SMS_RETRY_DELAY_MILLISECONDSint0@quik/communicationcommunication.sms.retry.delayMillisecondsSMS channel configuration. Config key: `communication.sms.retry.delayMilliseconds`.communication.ts
COMMUNICATION_SMS_TIMEOUT_MILLISECONDSint0@quik/communicationcommunication.sms.timeoutMillisecondsSMS channel configuration. Config key: `communication.sms.timeoutMilliseconds`.communication.ts
COMMUNICATION_WHATSAPP_ACCESS_TOKENstring@quik/communicationcommunication.whatsapp.config.accessTokenConfiguration value from environment. Config key: `communication.whatsapp.config.accessToken`.communication.ts
COMMUNICATION_WHATSAPP_ENABLEDflag@quik/communicationcommunication.whatsapp.enabledcomputedcommunication.ts
COMMUNICATION_WHATSAPP_ENGINEstring"test"@quik/communicationcommunication.whatsapp.engineConfiguration value from environment. Config key: `communication.whatsapp.engine`.communication.ts
COMMUNICATION_WHATSAPP_FROMstring@quik/communicationcommunication.whatsapp.fromConfiguration value from environment. Config key: `communication.whatsapp.from`.communication.ts
COMMUNICATION_WHATSAPP_GRAPH_API_VERSIONstring"v22.0"@quik/communicationcommunication.whatsapp.config.graphApiVersionConfiguration value from environment. Config key: `communication.whatsapp.config.graphApiVersion`.communication.ts
COMMUNICATION_WHATSAPP_PHONE_NUMBER_IDENTIFIERstring""@quik/communicationcommunication.whatsapp.config.phoneNumberIdentifierConfiguration value from environment. Config key: `communication.whatsapp.config.phoneNumberIdentifier`.communication.ts
COMMUNICATION_WHATSAPP_RETRY_ATTEMPTSint1@quik/communicationcommunication.whatsapp.retry.attemptsConfiguration value from environment. Config key: `communication.whatsapp.retry.attempts`.communication.ts
COMMUNICATION_WHATSAPP_RETRY_BACKOFF_FACTORint1@quik/communicationcommunication.whatsapp.retry.backoffFactorConfiguration value from environment. Config key: `communication.whatsapp.retry.backoffFactor`.communication.ts
COMMUNICATION_WHATSAPP_RETRY_DELAY_MILLISECONDSint0@quik/communicationcommunication.whatsapp.retry.delayMillisecondsConfiguration value from environment. Config key: `communication.whatsapp.retry.delayMilliseconds`.communication.ts
COMMUNICATION_WHATSAPP_TIMEOUT_MILLISECONDSint0@quik/communicationcommunication.whatsapp.timeoutMillisecondsConfiguration value from environment. Config key: `communication.whatsapp.timeoutMilliseconds`.communication.ts
COOKIE_DOMAINstring"localhost"@quik/httphttp.cookie.domainThe 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_SECRETstring""@quik/httphttp.cookie.secretSecret used to sign cookies. When set, `req.signedCookies` will contain verified, tamper-proof values. Leave empty to disable cookie signing. /http.ts
COOKIE_SECUREflag@quik/httphttp.cookie.secureFlag 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_HEADERSstring@quik/httphttp.cors.allowedHeadersThe 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_CREDENTIALSboolean@quik/httphttp.cors.credentialsThe allowed credentials in any request protected by CORS. /http.ts
CORS_EXPOSES_HEADERSstring@quik/httphttp.cors.exposedHeadersThe 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_AGEint@quik/httphttp.cors.maxAgeSets the maximum age of any CORS request. /http.ts
CORS_METHODSstring"GET,HEAD,PUT,PATCH,POST,DELETE"@quik/httphttp.cors.methodsThe HTTP Verbs/Methods for which we want to enable CORS. /http.ts
CORS_OPTIONS_SUCCESSint204@quik/httphttp.cors.optionsSuccessStatuscomputedhttp.ts
CORS_ORIGINstring"*"@quik/httphttp.cors.originThe 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_PREFLIGHTboolean@quik/httphttp.cors.preflightContinuePass the CORS preflight response to the next handler. /http.ts
DATABASE_CONFIGURATIONstring"mysql"@quik/databasedb.configurationThe default database configuration to be used in the application. The framework can support multiple database configurations that can be accessed at runtime as needed. If you don't want to use a database connection, set this value to empty. /db.ts
DATABASE_DEBUGGINGflag@quik/databasedb.debugEnable database debug mode. Config key: `db.debug`.db.ts
DATABASE_LOGGINGflag@quik/databasedb.loggingEnable database logging. Config key: `db.logging`.db.ts
DATABASE_MIGRATIONS_SNAPSHOT_FILEstring"./migrations/.schema-snapshot.json"@quik/databasedb.migrations.snapshotFilecomputeddb.ts
DATABASE_MYSQL_BIG_NUMBERS_STRINGflag@quik/databasedb.mysql.bigNumberStringsMySQL connection setting. Config key: `db.mysql.bigNumberStrings`.db.ts
DATABASE_MYSQL_DATABASEstring"quik"@quik/databasedb.mysql.databaseThe name of the database you want to use for your application. /db.ts
DATABASE_MYSQL_HOSTNAMEstring"localhost"@quik/databasedb.mysql.hostnameThe address of the database server. /db.ts
DATABASE_MYSQL_PASSWORDstring""@quik/databasedb.mysql.passwordThe password used to connect to the database server. /db.ts
DATABASE_MYSQL_PORTint3306@quik/databasedb.mysql.portThe port on which the database server is exposed. /db.ts
DATABASE_MYSQL_SUPPORT_BIG_NUMBERSflag@quik/databasedb.mysql.supportBigNumbersWhen using the `mysql` engine, the bigint numbers are treated as integers by default. If you don't want to expose these numbers as integers, set this flag to `true`. /db.ts
DATABASE_MYSQL_TIMEZONEstring"Z"@quik/databasedb.mysql.timezonecomputeddb.ts
DATABASE_MYSQL_USERNAMEstring"root"@quik/databasedb.mysql.usernameThe user used to connect to the database server. /db.ts
DATABASE_POSTGRES_DATABASEstring"quik"@quik/databasedb.postgres.databaseThe name of the database you want to use for your application. /db.ts
DATABASE_POSTGRES_HOSTNAMEstring"localhost"@quik/databasedb.postgres.hostnameThe address of the database server. /db.ts
DATABASE_POSTGRES_PASSWORDstring"postgres"@quik/databasedb.postgres.passwordThe password used to connect to the database server. /db.ts
DATABASE_POSTGRES_PORTint5432@quik/databasedb.postgres.portThe port on which the database server is exposed. /db.ts
DATABASE_POSTGRES_SCHEMAstring"public"@quik/databasedb.postgres.schemaThe name of the schema from the database you want to use for your application. /db.ts
DATABASE_POSTGRES_USERNAMEstring"postgres"@quik/databasedb.postgres.usernameThe user used to connect to the database server. /db.ts
DATABASE_SQLITE_FILENAMEstring":memory:"@quik/databasedb.sqlite.filenameThe SQLite database filename. /db.ts
DOCS_BASE_PATHstring"/api/docs"@quik/httphttp.paths.docsBase path for documentation routes. Config key: `http.paths.docs`.http.ts
DOCS_ENDPOINTS_ENTITY_AS_INTERFACEflag@quik/entitydocs.endpoints.entity.asInterfaceDocs endpoints toggles. Config key: `docs.endpoints.entity.asInterface`.docs.ts
DOCS_ENDPOINTS_ENTITY_AS_TYPEflag@quik/entitydocs.endpoints.entity.asTypeDocs endpoints toggles. Config key: `docs.endpoints.entity.asType`.docs.ts
DOCS_ENDPOINTS_ENTITY_METADATAflag@quik/entitydocs.endpoints.entity.metadataDocs endpoints toggles. Config key: `docs.endpoints.entity.metadata`.docs.ts
DOCS_ENDPOINTS_OPENAPIflag@quik/httpdocs.endpoints.openapi.fileDocs endpoints toggles. Config key: `docs.endpoints.openapi.file`.docs.ts
DOCS_ENDPOINTS_OPENAPI_UIflag@quik/httpdocs.endpoints.openapi.uiDocs endpoints toggles. Config key: `docs.endpoints.openapi.ui`.docs.ts
DOCS_ENDPOINTS_SCALARflag@quik/httpdocs.endpoints.scalarDocs endpoints toggles. Config key: `docs.endpoints.scalar`.docs.ts
DOCS_EXPOSEflag@quik/httpdocs.exposeEnable docs endpoints. Config key: `docs.expose`.docs.ts
DOCS_PASSWORDstring"openapi"@quik/httpdocs.security.passwordDocs basic auth password. Config key: `docs.security.password`.docs.ts
DOCS_SCALAR_PASSKEY_AUTHORIZATION_HEADER_NAMEstring"Authorization"@quik/passportdocs.scalar.passkey.authorization.headerNameConfiguration value from environment. Config key: `docs.scalar.passkey.authorization.headerName`.docs.ts
DOCS_SCALAR_PASSKEY_AUTHORIZATION_SCHEMEstring"Bearer"@quik/passportdocs.scalar.passkey.authorization.schemeConfiguration value from environment. Config key: `docs.scalar.passkey.authorization.scheme`.docs.ts
DOCS_SCALAR_PASSKEY_AUTHORIZATION_TOKEN_PATHstring""@quik/passportdocs.scalar.passkey.authorization.tokenPathConfiguration value from environment. Config key: `docs.scalar.passkey.authorization.tokenPath`.docs.ts
DOCS_SCALAR_PASSKEY_BEGIN_METHODstring"POST"@quik/passportdocs.scalar.passkey.begin.methodConfiguration value from environment. Config key: `docs.scalar.passkey.begin.method`.docs.ts
DOCS_SCALAR_PASSKEY_BEGIN_URLstring"/auth/passkey/options"@quik/passportdocs.scalar.passkey.begin.urlConfiguration value from environment. Config key: `docs.scalar.passkey.begin.url`.docs.ts
DOCS_SCALAR_PASSKEY_DESCRIPTIONstring"Authenticate with a passkey and reuse the resulting session in Scalar."@quik/passportdocs.scalar.passkey.descriptionConfiguration value from environment. Config key: `docs.scalar.passkey.description`.docs.ts
DOCS_SCALAR_PASSKEY_ENABLEDflag@quik/passportdocs.scalar.passkey.enabledcomputeddocs.ts
DOCS_SCALAR_PASSKEY_INCLUDE_CREDENTIALSflag@quik/passportdocs.scalar.passkey.includeCredentialscomputeddocs.ts
DOCS_SCALAR_PASSKEY_TITLEstring"Passkey Authentication"@quik/passportdocs.scalar.passkey.titleConfiguration value from environment. Config key: `docs.scalar.passkey.title`.docs.ts
DOCS_SCALAR_PASSKEY_VERIFY_METHODstring"POST"@quik/passportdocs.scalar.passkey.verify.methodConfiguration value from environment. Config key: `docs.scalar.passkey.verify.method`.docs.ts
DOCS_SCALAR_PASSKEY_VERIFY_URLstring"/auth/passkey/verify"@quik/passportdocs.scalar.passkey.verify.urlConfiguration value from environment. Config key: `docs.scalar.passkey.verify.url`.docs.ts
DOCS_SECUREDflag@quik/httpdocs.security.enabledRequire auth for docs endpoints. Config key: `docs.security.enabled`.docs.ts
DOCS_USERNAMEstring"openapi"@quik/httpdocs.security.usernameDocs basic auth username. Config key: `docs.security.username`.docs.ts
HTTP_BODY_JSON_LIMITstring"1mb"@quik/httphttp.body.jsonLimitRequest body parsing limits. /http.ts
HTTP_BODY_TEXT_LIMITstring"1mb"@quik/httphttp.body.textLimitHTTP body parsing limits. Config key: `http.body.textLimit`.http.ts
HTTP_BODY_URLENCODED_LIMITstring"1mb"@quik/httphttp.body.urlencodedLimitHTTP body parsing limits. Config key: `http.body.urlencodedLimit`.http.ts
HTTP_HEADERS_TIMEOUT_MSint0@quik/httphttp.timeouts.headersMsHTTP timeout settings. Config key: `http.timeouts.headersMs`.http.ts
HTTP_LISTENstring"127.0.0.1"@quik/httphttp.listenThe 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_PORTint7200@quik/httphttp.port, http.urls.app, http.urls.uiThe PORT on which we listen for connections. Customize the value for this parameter as needed. /http.ts
HTTP_REQUEST_TIMEOUT_MSint0@quik/httphttp.timeouts.requestMsHTTP server timeout configuration. /http.ts
HTTP_SHUTDOWN_TIMEOUT_MSint15000@quik/httphttp.timeouts.shutdownMsConfiguration value from environment. Config key: `http.timeouts.shutdownMs`.http.ts
HTTP_STATIC_CONTENT_FOLDERstring"./public"@quik/httphttp.static.folderStatic content serving settings. Config key: `http.static.folder`.http.ts
HTTP_STATIC_CONTENT_GLOBALflag@quik/httphttp.static.globalStatic content serving settings. Config key: `http.static.global`.http.ts
HTTP_STATIC_CONTENT_PATHstring""@quik/httphttp.static.pathStatic content serving settings. Config key: `http.static.path`.http.ts
HTTP_STATIC_CONTENT_SERVEflag@quik/httphttp.static.serveStatic content serving settings. Config key: `http.static.serve`.http.ts
HTTP_STATIC_SINGLE_PAGE_APPLICATION_ENABLEflag@quik/httphttp.static.singlePageApplication.enablecomputedhttp.ts
HTTP_STATIC_SINGLE_PAGE_APPLICATION_INDEX_FILEstring"index.html"@quik/httphttp.static.singlePageApplication.indexFileConfiguration value from environment. Config key: `http.static.singlePageApplication.indexFile`.http.ts
HTTP_URLS_APPurlcomputed@quik/httphttp.urls.appThe 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_UIurlcomputed@quik/httphttp.urls.uiThe URL that can be used to access the frontend application. /http.ts
I18N_COOKIEstring"quik:lang"@quik/i18ni18n.cookieThe name of the cookie used to identify the desired language for sending the messages to the customer. /i18n.ts
I18N_DEBUGboolean@quik/i18ni18n.debugDebug the i18n configuration. /i18n.ts
I18N_DEFAULT_LANGstring"en"@quik/i18ni18n.default, i18n.fallbackThe default language used for the translation of the application. / The fallback language for the case when a translation item does not exist in the desired language. /i18n.ts
I18N_SUPPORTED_LANGSarray",", "de,en,es,fr,it,nl,pt,ro"@quik/i18ni18n.supported, i18n.preloadA list of supported languages for translation that can be used in the application. / A list of supported languages for translation that will be preloaded in the application. /i18n.ts
JWT_ALGORITHMstring"HS256"@quik/authorizationauth.jwt.algorithmThe signing algorithm used when creating and verifying JWT tokens. Use `RS256` when signing with an RSA private key. /auth.ts
JWT_AUDIENCEstring"dev.quik.land"@quik/authorizationauth.jwt.audienceThe audience is used by the sign and verify functions to create/validate a JWT Token. In the sign function, the audience is added to the token in order to easily check if the received token was created by your application and was received by the intended audience. /auth.ts
JWT_EXPIRE_TIMEstring"1d"@quik/authorizationauth.jwt.expireTimeDefines how long a JWT token can be valid. Each JWT token signed by the application, except for the short-lived ones, are valid for this amount of time. /auth.ts
JWT_ISSUERstring"dev.quik.land"@quik/authorizationauth.jwt.issuerThe issuer is used by the sign and verify functions to create/validate a JWT Token. In the sign function, the issuer is added to the token in order to easily check if the received token was created by your application. /auth.ts
JWT_REMEMBER_ME_TIMEstring"1y"@quik/authorizationauth.jwt.rememberMeTimeWhen the user of the application wants to be remembered for a longer period of time this configuration parameter is used. In order to use this `rememberMeTime` configuration parameter, you must pass the `rememberMe` parameter to the sign method. /auth.ts
JWT_SECRETstring"thisisasecret"@quik/authorizationauth.jwt.secretThe secret used to encode the JWT Token when you are signing it. Without this your JWT Token isn't secure. Also, do not share this value publicly as there will be security issues for your application. /auth.ts
LOG_FILEstring"app.log"@quik/logginglogs.fileThe file used to store the log messages. Fill a value to this configuration parameter only if you want to store the logs in a file. /logs.ts
LOG_FOLDERstring"./storage/logs"@quik/logginglogs.folderThe location where you want to store the log files when using the file logger. Set this to a value outside of your application. /logs.ts
LOG_HTTP_FORMATstring"combined"@quik/httplogs.httpFormatThe format used to display the log information for HTTP requests. The supported formats are: "combined", "compact", "dev", "short", "tiny" /logs.ts
LOG_LEVELstring"debug"@quik/logginglogs.levelThe level of detail you want to see in the logs of your application. The levels supported by the framework are: `error`, `warn`, `info`, `http-old`, `verbose`, `debug`, `silly`. The `silly` level logs everything while `error` only the errors that appear in the application. /logs.ts
LOGGER_TYPEstring"console"@quik/logginglogs.typeThe type of logger used in the application. At the moment the framework support only 4 types: console, file, json, json_file. You can find these types in the `LoggerType` Enum. /logs.ts
LOGS_ENABLEDflag@quik/logginglogs.enabledFlag used to enable or disable the application logging functionality. We recommend setting this flag to true since debugging and seeing what happens, when an error occurs, is better than not seeing anything. /logs.ts
MFA_CHALLENGE_MAX_ATTEMPTSint5@quik/mfamfa.challenge.maxAttemptsConfiguration value from environment. Config key: `mfa.challenge.maxAttempts`.mfa.ts
MFA_CHALLENGE_TIME_TO_LIVE_MSint300000@quik/mfamfa.challenge.timeToLiveMsConfiguration value from environment. Config key: `mfa.challenge.timeToLiveMs`.mfa.ts
MFA_CODE_LENGTHint6@quik/mfamfa.code.lengthConfiguration value from environment. Config key: `mfa.code.length`.mfa.ts
MFA_EMAIL_SUBJECTstring"Your authentication code"@quik/mfamfa.email.subjectConfiguration value from environment. Config key: `mfa.email.subject`.mfa.ts
MFA_ENABLEDflag@quik/mfamfa.enabledcomputedmfa.ts
MFA_TOTP_DIGITSint6@quik/mfamfa.totp.digitsConfiguration value from environment. Config key: `mfa.totp.digits`.mfa.ts
MFA_TOTP_ISSUERstring"Quik"@quik/mfamfa.totp.issuerConfiguration value from environment. Config key: `mfa.totp.issuer`.mfa.ts
MFA_TOTP_QR_CODE_QUIET_ZONE_MODULESint4@quik/mfamfa.totp.qrCode.quietZoneModulesConfiguration value from environment. Config key: `mfa.totp.qrCode.quietZoneModules`.mfa.ts
MFA_TOTP_QR_CODE_SIZE_PIXELSint256@quik/mfamfa.totp.qrCode.sizePixelsConfiguration value from environment. Config key: `mfa.totp.qrCode.sizePixels`.mfa.ts
MFA_TOTP_STEP_SECONDSint30@quik/mfamfa.totp.stepSecondsConfiguration value from environment. Config key: `mfa.totp.stepSeconds`.mfa.ts
MFA_TOTP_WINDOWint1@quik/mfamfa.totp.windowConfiguration value from environment. Config key: `mfa.totp.window`.mfa.ts
OAUTH_SERVER_ACCESS_TOKEN_TIME_TO_LIVE_SECONDSint3600@quik/oauth-serveroauth.server.accessToken.timeToLiveSecondsConfiguration value from environment. Config key: `oauth.server.accessToken.timeToLiveSeconds`.oauth.ts
OAUTH_SERVER_AUTHORIZATION_CODE_TIME_TO_LIVE_SECONDSint300@quik/oauth-serveroauth.server.authorizationCode.timeToLiveSecondsConfiguration value from environment. Config key: `oauth.server.authorizationCode.timeToLiveSeconds`.oauth.ts
OAUTH_SERVER_ENABLEDflag@quik/oauth-serveroauth.server.enabledcomputedoauth.ts
OAUTH_SERVER_HTTP_AUTHENTICATION_PREFIXstring"/auth"@quik/oauth-serveroauth.server.http.authenticationPrefixConfiguration value from environment. Config key: `oauth.server.http.authenticationPrefix`.oauth.ts
OAUTH_SERVER_HTTP_MANAGEMENT_PREFIXstring"/"@quik/oauth-serveroauth.server.http.managementPrefixConfiguration value from environment. Config key: `oauth.server.http.managementPrefix`.oauth.ts
OAUTH_SERVER_ISSUERstring"http://localhost:3000"@quik/oauth-serveroauth.server.issuerConfiguration value from environment. Config key: `oauth.server.issuer`.oauth.ts
OAUTH_SERVER_JWKS_KEY_IDENTIFIERstring"oauth-server-default"@quik/oauth-serveroauth.server.jwks.keyIdentifierConfiguration value from environment. Config key: `oauth.server.jwks.keyIdentifier`.oauth.ts
OAUTH_SERVER_JWKS_RSA_MODULUS_LENGTHint2048@quik/oauth-serveroauth.server.jwks.rsaModulusLengthConfiguration value from environment. Config key: `oauth.server.jwks.rsaModulusLength`.oauth.ts
OAUTH_SERVER_JWKS_SIGNING_PRIVATE_KEY_PEMstring""@quik/oauth-serveroauth.server.jwks.signing.privateKeyPemConfiguration value from environment. Config key: `oauth.server.jwks.signing.privateKeyPem`.oauth.ts
OAUTH_SERVER_JWKS_SIGNING_PUBLIC_KEY_PEMstring""@quik/oauth-serveroauth.server.jwks.signing.publicKeyPemConfiguration value from environment. Config key: `oauth.server.jwks.signing.publicKeyPem`.oauth.ts
OAUTH_SERVER_PKCE_REQUIRED_BY_DEFAULTstring"true"@quik/oauth-serveroauth.server.pkce.requiredByDefaultConfiguration value from environment. Config key: `oauth.server.pkce.requiredByDefault`.oauth.ts
OAUTH_SERVER_REFRESH_TOKEN_ROTATE_ON_USEstring"true"@quik/oauth-serveroauth.server.refreshToken.rotateOnUseConfiguration value from environment. Config key: `oauth.server.refreshToken.rotateOnUse`.oauth.ts
OAUTH_SERVER_REFRESH_TOKEN_TIME_TO_LIVE_SECONDSint2592000@quik/oauth-serveroauth.server.refreshToken.timeToLiveSecondsConfiguration value from environment. Config key: `oauth.server.refreshToken.timeToLiveSeconds`.oauth.ts
QUIK_APP_KEYstring@quik/corecrypto.appKeyThe default features file for the application /crypto.ts
QUIK_BOOTSTRAP_TIMEOUTnumber15000@quik/corequik.bootstrap.timeoutConfiguration value from environment. Config key: `quik.bootstrap.timeout`.quik.ts
QUIK_DEBUGflag@quik/corequik.debugEnable Quik debug mode. Config key: `quik.debug`.quik.ts
QUIK_EXPOSE_ERROR_DETAILSflag@quik/corequik.errors.detailsThe default features file for the application /quik.ts
SCHEDULER_EXECUTOR_DATABASEflag@quik/schedulerscheduler.executor.databaseDefault scheduler configuration derived from environment variables. /scheduler.ts
SCHEDULER_MAX_CONCURRENCYint1@quik/schedulerscheduler.maxConcurrencyMax scheduler concurrency. Config key: `scheduler.maxConcurrency`.scheduler.ts
SCHEDULER_QUEUE_BATCH_SIZEint10@quik/queue-workerscheduler.queue.batchSizeConfiguration value from environment. Config key: `scheduler.queue.batchSize`.scheduler.ts
SCHEDULER_QUEUE_INTERVAL_MSint2000@quik/queue-workerscheduler.queue.intervalMsDefault scheduler configuration derived from environment variables. /scheduler.ts
SESSION_FILE_FOLDERstring".sessions"@quik/httphttp.session.file.folderConfiguration value from environment. Config key: `http.session.file.folder`.http.ts
SESSION_REDIS_DBint0@quik/httphttp.session.redis.dbConfiguration value from environment. Config key: `http.session.redis.db`.http.ts
SESSION_REDIS_HOSTstring"127.0.0.1"@quik/httphttp.session.redis.hostConfiguration value from environment. Config key: `http.session.redis.host`.http.ts
SESSION_REDIS_KEY_PREFIXstring"quik:session:"@quik/httphttp.session.redis.keyPrefixConfiguration value from environment. Config key: `http.session.redis.keyPrefix`.http.ts
SESSION_REDIS_PASSWORDstring""@quik/httphttp.session.redis.passwordConfiguration value from environment. Config key: `http.session.redis.password`.http.ts
SESSION_REDIS_PORTint6379@quik/httphttp.session.redis.portConfiguration value from environment. Config key: `http.session.redis.port`.http.ts
SESSION_SECRETstring"thisIsAS3cret"@quik/httphttp.session.secretSince 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_STOREstring"memory"@quik/httphttp.session.storeSession 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_SECONDSint86400@quik/httphttp.session.ttlSecondsSession TTL in seconds forwarded to the store driver. /http.ts
STORAGE_LOCAL_DESTINATIONstring"./storage"@quik/storagestorage.local.destinationLocal storage configuration. Config key: `storage.local.destination`.storage.ts
STORAGE_LOCAL_ENABLEDflag@quik/storagestorage.local.enabledDefault configuration values for the storage module. /storage.ts
STORAGE_LOCAL_HTTP_BASE_PATHstring"/storage/local"@quik/storagestorage.local.http.basePathLocal storage configuration. Config key: `storage.local.http.basePath`.storage.ts
STORAGE_LOCAL_PUBLIC_URLstring""@quik/storagestorage.local.publicUrlLocal storage configuration. Config key: `storage.local.publicUrl`.storage.ts
STORAGE_LOCAL_SIGNED_DOWNLOAD_EXPIREnumber60@quik/storagestorage.local.signed.downloadLocal storage configuration. Config key: `storage.local.signed.download`.storage.ts
STORAGE_LOCAL_SIGNED_SECRETstring""@quik/storagestorage.local.signed.secretLocal storage configuration. Config key: `storage.local.signed.secret`.storage.ts
STORAGE_LOCAL_SIGNED_UPLOAD_EXPIREnumber60@quik/storagestorage.local.signed.uploadLocal storage configuration. Config key: `storage.local.signed.upload`.storage.ts
STORAGE_LOCAL_UPLOADstring"./temp"@quik/storagestorage.local.uploadLocal storage configuration. Config key: `storage.local.upload`.storage.ts
STORAGE_S3_ACCESS_KEYstring@quik/storagestorage.s3.accessKeyIdS3 storage configuration. Config key: `storage.s3.accessKeyId`.storage.ts
STORAGE_S3_BUCKETstring@quik/storagestorage.s3.bucketS3 storage configuration. Config key: `storage.s3.bucket`.storage.ts
STORAGE_S3_ENABLEDflag@quik/storagestorage.s3.enabledS3 storage configuration. Config key: `storage.s3.enabled`.storage.ts
STORAGE_S3_ENDPOINTstring@quik/storagestorage.s3.endpointS3 storage configuration. Config key: `storage.s3.endpoint`.storage.ts
STORAGE_S3_PATH_STYLEflag@quik/storagestorage.s3.pathStyleUrlS3 storage configuration. Config key: `storage.s3.pathStyleUrl`.storage.ts
STORAGE_S3_REGIONstring"eu-west-1"@quik/storagestorage.s3.regionS3 storage configuration. Config key: `storage.s3.region`.storage.ts
STORAGE_S3_SECRET_KEYstring@quik/storagestorage.s3.secretAccessKeyS3 storage configuration. Config key: `storage.s3.secretAccessKey`.storage.ts
STORAGE_S3_SIGNED_DOWNLOAD_EXPIREnumber60@quik/storagestorage.s3.signed.downloadS3 storage configuration. Config key: `storage.s3.signed.download`.storage.ts
STORAGE_S3_SIGNED_UPLOAD_EXPIREnumber60@quik/storagestorage.s3.signed.uploadS3 storage configuration. Config key: `storage.s3.signed.upload`.storage.ts
TELEMETRY_AUTO_INSTRUMENTATIONSflag@quik/telemetrytelemetry.autoInstrumentationsEnable auto-instrumentations. Config key: `telemetry.autoInstrumentations`.telemetry.ts
TELEMETRY_ENABLEDflag@quik/telemetrytelemetry.enabledEnable telemetry module. Config key: `telemetry.enabled`.telemetry.ts
TELEMETRY_LOGGING_BRIDGEflag@quik/telemetrytelemetry.logging.bridgeBridge telemetry into logging. Config key: `telemetry.logging.bridge`.telemetry.ts
TELEMETRY_LOGGING_PASSTHROUGHflag@quik/telemetrytelemetry.logging.passthroughAllow telemetry logger passthrough. Config key: `telemetry.logging.passthrough`.telemetry.ts
TELEMETRY_OTLP_ENDPOINTstring""@quik/telemetrytelemetry.exporter.otlp.endpointOTLP exporter endpoint. Config key: `telemetry.exporter.otlp.endpoint`.telemetry.ts
TELEMETRY_SERVICE_NAMEstring""@quik/telemetrytelemetry.serviceNameService name for telemetry traces. Config key: `telemetry.serviceName`.telemetry.ts
USER_LANGUAGE_FIELDstring@quik/corequik.user.languageFieldConfiguration value from environment. Config key: `quik.user.languageField`.quik.ts
WEBSOCKET_HEARTBEAT_ENABLEDget@quik/websocketwebsocket.heartbeat.enabledEnables server-side heartbeat checks. /websocket.ts
WEBSOCKET_HEARTBEAT_INTERVAL_MILLISECONDSnumber30000@quik/websocketwebsocket.heartbeat.intervalMillisecondsInterval between heartbeat pings. /websocket.ts
WEBSOCKET_HEARTBEAT_PING_MESSAGE_TYPEstring"quik.websocket.ping"@quik/websocketwebsocket.heartbeat.pingMessageTypeApplication-level ping message type. /websocket.ts
WEBSOCKET_HEARTBEAT_PONG_MESSAGE_TYPEstring"quik.websocket.pong"@quik/websocketwebsocket.heartbeat.pongMessageTypeApplication-level pong message type. /websocket.ts
WEBSOCKET_HEARTBEAT_TIMEOUT_MILLISECONDSnumber10000@quik/websocketwebsocket.heartbeat.timeoutMillisecondsTime allowed for a peer to answer the latest ping. /websocket.ts
WEBSOCKET_PATHstring"/ws"@quik/websocketwebsocket.pathHTTP upgrade path used by WebSocket adapters. /websocket.ts