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.
| Variable | Type | Default | Modules | Config Keys | Description | Source |
|---|---|---|---|---|---|---|
API_BASE_PATH | string | "/api/v1" | @quik/http | http.paths.api | Base path for API routes. Config key: `http.paths.api`. | http.ts |
APP_DESCRIPTION | string | "" | @quik/core | app.description | A short text that describes the application you are developing. / | app.ts |
APP_NAME | string | "QuikLand by Spark" | @quik/core | app.name | The name of the application you are developing. / | app.ts |
APP_TIMEZONE | string | "UTC" | @quik/core | app.timezone | Default application timezone. Config key: `app.timezone`. | app.ts |
APP_VERSION | string | computed | @quik/core | app.version | The version of the application you are developing. / | app.ts |
AUTH_AUTHORIZATION_ASSURANCE_LEVEL_FIELD | string | "assuranceLevel" | @quik/authorization | auth.authorization.fields.assuranceLevel | Configuration value from environment. Config key: `auth.authorization.fields.assuranceLevel`. | auth.ts |
AUTH_AUTHORIZATION_AUTHENTICATION_METHODS_FIELD | string | "authenticationMethods" | @quik/authorization | auth.authorization.fields.authenticationMethods | Configuration value from environment. Config key: `auth.authorization.fields.authenticationMethods`. | auth.ts |
AUTH_AUTHORIZATION_COMPLETED_FACTORS_FIELD | string | "completedFactors" | @quik/authorization | auth.authorization.fields.completedFactors | Configuration value from environment. Config key: `auth.authorization.fields.completedFactors`. | auth.ts |
AUTH_CHECK_FIELD | string | "permissions" | @quik/authorization | auth.authorization.fields.permission | Authentication 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_MS | int | 300000 | @quik/passport | auth.passkey.challenge.timeToLiveMs | Passkey challenge lifetime in milliseconds. / | auth.ts |
AUTH_PASSKEY_HTTP_BASE_PATH | string | "/auth/passkey" | @quik/passport | auth.passkey.http.basePath | Configuration value from environment. Config key: `auth.passkey.http.basePath`. | auth.ts |
AUTH_PASSKEY_HTTP_BEARER_TOKEN_EXPIRES_IN | string | "1h" | @quik/passport | auth.passkey.http.bearerTokenExpiresIn | Configuration value from environment. Config key: `auth.passkey.http.bearerTokenExpiresIn`. | auth.ts |
AUTH_PASSKEY_HTTP_ENABLED | flag | — | @quik/passport | auth.passkey.http.enabled | Built-in HTTP endpoint settings for the passkey routes. / | auth.ts |
AUTH_PASSKEY_HTTP_ISSUE_BEARER_TOKEN | flag | — | @quik/passport | auth.passkey.http.issueBearerToken | computed | auth.ts |
AUTH_PASSKEY_HTTP_PERSIST_SESSION | flag | — | @quik/passport | auth.passkey.http.persistSession | computed | auth.ts |
AUTH_PASSKEY_RELYING_PARTY_ID | string | "localhost" | @quik/passport | auth.passkey.relyingParty.id | Domain identifier for your application, for example `example.com`. / | auth.ts |
AUTH_PASSKEY_RELYING_PARTY_NAME | string | "Quik" | @quik/passport | auth.passkey.relyingParty.name | User-facing name shown by passkey-capable clients. / | auth.ts |
CACHE_DRIVER | string | "memory" | @quik/cache | cache.driver | Cache 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_FOLDER | string | ".cache" | @quik/cache | cache.file.folder | Configuration value from environment. Config key: `cache.file.folder`. | cache.ts |
CACHE_REDIS_DB | int | 0 | @quik/cache | cache.redis.db | Configuration value from environment. Config key: `cache.redis.db`. | cache.ts |
CACHE_REDIS_HOST | string | "127.0.0.1" | @quik/cache | cache.redis.host | Configuration value from environment. Config key: `cache.redis.host`. | cache.ts |
CACHE_REDIS_KEY_PREFIX | string | "quik:cache:" | @quik/cache | cache.redis.keyPrefix | Configuration value from environment. Config key: `cache.redis.keyPrefix`. | cache.ts |
CACHE_REDIS_PASSWORD | string | "" | @quik/cache | cache.redis.password | Configuration value from environment. Config key: `cache.redis.password`. | cache.ts |
CACHE_REDIS_PORT | int | 6379 | @quik/cache | cache.redis.port | Configuration value from environment. Config key: `cache.redis.port`. | cache.ts |
COMMUNICATION_EMAIL_ADDRESS | string | "quikland@localhost" | @quik/communication | communication.email.config.address | The account or email address used to connect to the email sending server. / | communication.ts |
COMMUNICATION_EMAIL_ENABLED | flag | — | @quik/communication | communication.email.enabled | Flag used to enable or disable the email handling service. / | communication.ts |
COMMUNICATION_EMAIL_ENGINE | string | "test" | @quik/communication | communication.email.engine | The desired email handling transport to be used in the application. / | communication.ts |
COMMUNICATION_EMAIL_FROM | string | "quikland@localhost" | @quik/communication | communication.email.from | The email address used as the FROM address in the emails sent through the application. / | communication.ts |
COMMUNICATION_EMAIL_PASSWORD | string | "" | @quik/communication | communication.email.config.password | The password for the account used to send an email. / | communication.ts |
COMMUNICATION_EMAIL_PORT | string | "25" | @quik/communication | communication.email.config.port | The port used to connect to the email server. / | communication.ts |
COMMUNICATION_EMAIL_RETRY_ATTEMPTS | int | 1 | @quik/communication | communication.email.retry.attempts | Email channel configuration. Config key: `communication.email.retry.attempts`. | communication.ts |
COMMUNICATION_EMAIL_RETRY_BACKOFF_FACTOR | int | 1 | @quik/communication | communication.email.retry.backoffFactor | Email channel configuration. Config key: `communication.email.retry.backoffFactor`. | communication.ts |
COMMUNICATION_EMAIL_RETRY_DELAY_MILLISECONDS | int | 0 | @quik/communication | communication.email.retry.delayMilliseconds | Email channel configuration. Config key: `communication.email.retry.delayMilliseconds`. | communication.ts |
COMMUNICATION_EMAIL_SECURE | flag | — | @quik/communication | communication.email.config.secure | A flag used to define if the server is using a secure connection or not. / | communication.ts |
COMMUNICATION_EMAIL_SERVER | string | "localhost" | @quik/communication | communication.email.config.server | The URL or IP of the email sending server. / | communication.ts |
COMMUNICATION_EMAIL_TIMEOUT_MILLISECONDS | int | 0 | @quik/communication | communication.email.timeoutMilliseconds | Email channel configuration. Config key: `communication.email.timeoutMilliseconds`. | communication.ts |
COMMUNICATION_SMS_CLIENT_IDENTIFIER | string | "" | @quik/communication | communication.sms.config.clientIdentifier | SMS channel configuration. Config key: `communication.sms.config.clientIdentifier`. | communication.ts |
COMMUNICATION_SMS_CLIENT_SECRET | string | "" | @quik/communication | communication.sms.config.clientSecret | SMS channel configuration. Config key: `communication.sms.config.clientSecret`. | communication.ts |
COMMUNICATION_SMS_ENABLED | flag | — | @quik/communication | communication.sms.enabled | SMS channel configuration. Config key: `communication.sms.enabled`. | communication.ts |
COMMUNICATION_SMS_ENGINE | string | "test" | @quik/communication | communication.sms.engine | SMS channel configuration. Config key: `communication.sms.engine`. | communication.ts |
COMMUNICATION_SMS_FROM | string | — | @quik/communication | communication.sms.from | SMS channel configuration. Config key: `communication.sms.from`. | communication.ts |
COMMUNICATION_SMS_RETRY_ATTEMPTS | int | 1 | @quik/communication | communication.sms.retry.attempts | SMS channel configuration. Config key: `communication.sms.retry.attempts`. | communication.ts |
COMMUNICATION_SMS_RETRY_BACKOFF_FACTOR | int | 1 | @quik/communication | communication.sms.retry.backoffFactor | SMS channel configuration. Config key: `communication.sms.retry.backoffFactor`. | communication.ts |
COMMUNICATION_SMS_RETRY_DELAY_MILLISECONDS | int | 0 | @quik/communication | communication.sms.retry.delayMilliseconds | SMS channel configuration. Config key: `communication.sms.retry.delayMilliseconds`. | communication.ts |
COMMUNICATION_SMS_TIMEOUT_MILLISECONDS | int | 0 | @quik/communication | communication.sms.timeoutMilliseconds | SMS channel configuration. Config key: `communication.sms.timeoutMilliseconds`. | communication.ts |
COMMUNICATION_WHATSAPP_ACCESS_TOKEN | string | — | @quik/communication | communication.whatsapp.config.accessToken | Configuration value from environment. Config key: `communication.whatsapp.config.accessToken`. | communication.ts |
COMMUNICATION_WHATSAPP_ENABLED | flag | — | @quik/communication | communication.whatsapp.enabled | computed | communication.ts |
COMMUNICATION_WHATSAPP_ENGINE | string | "test" | @quik/communication | communication.whatsapp.engine | Configuration value from environment. Config key: `communication.whatsapp.engine`. | communication.ts |
COMMUNICATION_WHATSAPP_FROM | string | — | @quik/communication | communication.whatsapp.from | Configuration value from environment. Config key: `communication.whatsapp.from`. | communication.ts |
COMMUNICATION_WHATSAPP_GRAPH_API_VERSION | string | "v22.0" | @quik/communication | communication.whatsapp.config.graphApiVersion | Configuration value from environment. Config key: `communication.whatsapp.config.graphApiVersion`. | communication.ts |
COMMUNICATION_WHATSAPP_PHONE_NUMBER_IDENTIFIER | string | "" | @quik/communication | communication.whatsapp.config.phoneNumberIdentifier | Configuration value from environment. Config key: `communication.whatsapp.config.phoneNumberIdentifier`. | communication.ts |
COMMUNICATION_WHATSAPP_RETRY_ATTEMPTS | int | 1 | @quik/communication | communication.whatsapp.retry.attempts | Configuration value from environment. Config key: `communication.whatsapp.retry.attempts`. | communication.ts |
COMMUNICATION_WHATSAPP_RETRY_BACKOFF_FACTOR | int | 1 | @quik/communication | communication.whatsapp.retry.backoffFactor | Configuration value from environment. Config key: `communication.whatsapp.retry.backoffFactor`. | communication.ts |
COMMUNICATION_WHATSAPP_RETRY_DELAY_MILLISECONDS | int | 0 | @quik/communication | communication.whatsapp.retry.delayMilliseconds | Configuration value from environment. Config key: `communication.whatsapp.retry.delayMilliseconds`. | communication.ts |
COMMUNICATION_WHATSAPP_TIMEOUT_MILLISECONDS | int | 0 | @quik/communication | communication.whatsapp.timeoutMilliseconds | Configuration value from environment. Config key: `communication.whatsapp.timeoutMilliseconds`. | communication.ts |
COOKIE_DOMAIN | string | "localhost" | @quik/http | 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 | "" | @quik/http | 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 | — | @quik/http | 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 | — | @quik/http | 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 | — | @quik/http | http.cors.credentials | The allowed credentials in any request protected by CORS. / | http.ts |
CORS_EXPOSES_HEADERS | string | — | @quik/http | 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 | — | @quik/http | http.cors.maxAge | Sets the maximum age of any CORS request. / | http.ts |
CORS_METHODS | string | "GET,HEAD,PUT,PATCH,POST,DELETE" | @quik/http | http.cors.methods | The HTTP Verbs/Methods for which we want to enable CORS. / | http.ts |
CORS_OPTIONS_SUCCESS | int | 204 | @quik/http | http.cors.optionsSuccessStatus | computed | http.ts |
CORS_ORIGIN | string | "*" | @quik/http | 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 | — | @quik/http | http.cors.preflightContinue | Pass the CORS preflight response to the next handler. / | http.ts |
DATABASE_CONFIGURATION | string | "mysql" | @quik/database | db.configuration | The 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_DEBUGGING | flag | — | @quik/database | db.debug | Enable database debug mode. Config key: `db.debug`. | db.ts |
DATABASE_LOGGING | flag | — | @quik/database | db.logging | Enable database logging. Config key: `db.logging`. | db.ts |
DATABASE_MIGRATIONS_SNAPSHOT_FILE | string | "./migrations/.schema-snapshot.json" | @quik/database | db.migrations.snapshotFile | computed | db.ts |
DATABASE_MYSQL_BIG_NUMBERS_STRING | flag | — | @quik/database | db.mysql.bigNumberStrings | MySQL connection setting. Config key: `db.mysql.bigNumberStrings`. | db.ts |
DATABASE_MYSQL_DATABASE | string | "quik" | @quik/database | db.mysql.database | The name of the database you want to use for your application. / | db.ts |
DATABASE_MYSQL_HOSTNAME | string | "localhost" | @quik/database | db.mysql.hostname | The address of the database server. / | db.ts |
DATABASE_MYSQL_PASSWORD | string | "" | @quik/database | db.mysql.password | The password used to connect to the database server. / | db.ts |
DATABASE_MYSQL_PORT | int | 3306 | @quik/database | db.mysql.port | The port on which the database server is exposed. / | db.ts |
DATABASE_MYSQL_SUPPORT_BIG_NUMBERS | flag | — | @quik/database | db.mysql.supportBigNumbers | When 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_TIMEZONE | string | "Z" | @quik/database | db.mysql.timezone | computed | db.ts |
DATABASE_MYSQL_USERNAME | string | "root" | @quik/database | db.mysql.username | The user used to connect to the database server. / | db.ts |
DATABASE_POSTGRES_DATABASE | string | "quik" | @quik/database | db.postgres.database | The name of the database you want to use for your application. / | db.ts |
DATABASE_POSTGRES_HOSTNAME | string | "localhost" | @quik/database | db.postgres.hostname | The address of the database server. / | db.ts |
DATABASE_POSTGRES_PASSWORD | string | "postgres" | @quik/database | db.postgres.password | The password used to connect to the database server. / | db.ts |
DATABASE_POSTGRES_PORT | int | 5432 | @quik/database | db.postgres.port | The port on which the database server is exposed. / | db.ts |
DATABASE_POSTGRES_SCHEMA | string | "public" | @quik/database | db.postgres.schema | The name of the schema from the database you want to use for your application. / | db.ts |
DATABASE_POSTGRES_USERNAME | string | "postgres" | @quik/database | db.postgres.username | The user used to connect to the database server. / | db.ts |
DATABASE_SQLITE_FILENAME | string | ":memory:" | @quik/database | db.sqlite.filename | The SQLite database filename. / | db.ts |
DOCS_BASE_PATH | string | "/api/docs" | @quik/http | http.paths.docs | Base path for documentation routes. Config key: `http.paths.docs`. | http.ts |
DOCS_ENDPOINTS_ENTITY_AS_INTERFACE | flag | — | @quik/entity | docs.endpoints.entity.asInterface | Docs endpoints toggles. Config key: `docs.endpoints.entity.asInterface`. | docs.ts |
DOCS_ENDPOINTS_ENTITY_AS_TYPE | flag | — | @quik/entity | docs.endpoints.entity.asType | Docs endpoints toggles. Config key: `docs.endpoints.entity.asType`. | docs.ts |
DOCS_ENDPOINTS_ENTITY_METADATA | flag | — | @quik/entity | docs.endpoints.entity.metadata | Docs endpoints toggles. Config key: `docs.endpoints.entity.metadata`. | docs.ts |
DOCS_ENDPOINTS_OPENAPI | flag | — | @quik/http | docs.endpoints.openapi.file | Docs endpoints toggles. Config key: `docs.endpoints.openapi.file`. | docs.ts |
DOCS_ENDPOINTS_OPENAPI_UI | flag | — | @quik/http | docs.endpoints.openapi.ui | Docs endpoints toggles. Config key: `docs.endpoints.openapi.ui`. | docs.ts |
DOCS_ENDPOINTS_SCALAR | flag | — | @quik/http | docs.endpoints.scalar | Docs endpoints toggles. Config key: `docs.endpoints.scalar`. | docs.ts |
DOCS_EXPOSE | flag | — | @quik/http | docs.expose | Enable docs endpoints. Config key: `docs.expose`. | docs.ts |
DOCS_PASSWORD | string | "openapi" | @quik/http | docs.security.password | Docs basic auth password. Config key: `docs.security.password`. | docs.ts |
DOCS_SCALAR_PASSKEY_AUTHORIZATION_HEADER_NAME | string | "Authorization" | @quik/passport | docs.scalar.passkey.authorization.headerName | Configuration value from environment. Config key: `docs.scalar.passkey.authorization.headerName`. | docs.ts |
DOCS_SCALAR_PASSKEY_AUTHORIZATION_SCHEME | string | "Bearer" | @quik/passport | docs.scalar.passkey.authorization.scheme | Configuration value from environment. Config key: `docs.scalar.passkey.authorization.scheme`. | docs.ts |
DOCS_SCALAR_PASSKEY_AUTHORIZATION_TOKEN_PATH | string | "" | @quik/passport | docs.scalar.passkey.authorization.tokenPath | Configuration value from environment. Config key: `docs.scalar.passkey.authorization.tokenPath`. | docs.ts |
DOCS_SCALAR_PASSKEY_BEGIN_METHOD | string | "POST" | @quik/passport | docs.scalar.passkey.begin.method | Configuration value from environment. Config key: `docs.scalar.passkey.begin.method`. | docs.ts |
DOCS_SCALAR_PASSKEY_BEGIN_URL | string | "/auth/passkey/options" | @quik/passport | docs.scalar.passkey.begin.url | Configuration value from environment. Config key: `docs.scalar.passkey.begin.url`. | docs.ts |
DOCS_SCALAR_PASSKEY_DESCRIPTION | string | "Authenticate with a passkey and reuse the resulting session in Scalar." | @quik/passport | docs.scalar.passkey.description | Configuration value from environment. Config key: `docs.scalar.passkey.description`. | docs.ts |
DOCS_SCALAR_PASSKEY_ENABLED | flag | — | @quik/passport | docs.scalar.passkey.enabled | computed | docs.ts |
DOCS_SCALAR_PASSKEY_INCLUDE_CREDENTIALS | flag | — | @quik/passport | docs.scalar.passkey.includeCredentials | computed | docs.ts |
DOCS_SCALAR_PASSKEY_TITLE | string | "Passkey Authentication" | @quik/passport | docs.scalar.passkey.title | Configuration value from environment. Config key: `docs.scalar.passkey.title`. | docs.ts |
DOCS_SCALAR_PASSKEY_VERIFY_METHOD | string | "POST" | @quik/passport | docs.scalar.passkey.verify.method | Configuration value from environment. Config key: `docs.scalar.passkey.verify.method`. | docs.ts |
DOCS_SCALAR_PASSKEY_VERIFY_URL | string | "/auth/passkey/verify" | @quik/passport | docs.scalar.passkey.verify.url | Configuration value from environment. Config key: `docs.scalar.passkey.verify.url`. | docs.ts |
DOCS_SECURED | flag | — | @quik/http | docs.security.enabled | Require auth for docs endpoints. Config key: `docs.security.enabled`. | docs.ts |
DOCS_USERNAME | string | "openapi" | @quik/http | docs.security.username | Docs basic auth username. Config key: `docs.security.username`. | docs.ts |
HTTP_BODY_JSON_LIMIT | string | "1mb" | @quik/http | http.body.jsonLimit | Request body parsing limits. / | http.ts |
HTTP_BODY_TEXT_LIMIT | string | "1mb" | @quik/http | http.body.textLimit | HTTP body parsing limits. Config key: `http.body.textLimit`. | http.ts |
HTTP_BODY_URLENCODED_LIMIT | string | "1mb" | @quik/http | http.body.urlencodedLimit | HTTP body parsing limits. Config key: `http.body.urlencodedLimit`. | http.ts |
HTTP_HEADERS_TIMEOUT_MS | int | 0 | @quik/http | http.timeouts.headersMs | HTTP timeout settings. Config key: `http.timeouts.headersMs`. | http.ts |
HTTP_LISTEN | string | "127.0.0.1" | @quik/http | 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 | @quik/http | 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 | @quik/http | http.timeouts.requestMs | HTTP server timeout configuration. / | http.ts |
HTTP_SHUTDOWN_TIMEOUT_MS | int | 15000 | @quik/http | http.timeouts.shutdownMs | Configuration value from environment. Config key: `http.timeouts.shutdownMs`. | http.ts |
HTTP_STATIC_CONTENT_FOLDER | string | "./public" | @quik/http | http.static.folder | Static content serving settings. Config key: `http.static.folder`. | http.ts |
HTTP_STATIC_CONTENT_GLOBAL | flag | — | @quik/http | http.static.global | Static content serving settings. Config key: `http.static.global`. | http.ts |
HTTP_STATIC_CONTENT_PATH | string | "" | @quik/http | http.static.path | Static content serving settings. Config key: `http.static.path`. | http.ts |
HTTP_STATIC_CONTENT_SERVE | flag | — | @quik/http | http.static.serve | Static content serving settings. Config key: `http.static.serve`. | http.ts |
HTTP_STATIC_SINGLE_PAGE_APPLICATION_ENABLE | flag | — | @quik/http | http.static.singlePageApplication.enable | computed | http.ts |
HTTP_STATIC_SINGLE_PAGE_APPLICATION_INDEX_FILE | string | "index.html" | @quik/http | http.static.singlePageApplication.indexFile | Configuration value from environment. Config key: `http.static.singlePageApplication.indexFile`. | http.ts |
HTTP_URLS_APP | url | computed | @quik/http | 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 | @quik/http | http.urls.ui | The URL that can be used to access the frontend application. / | http.ts |
I18N_COOKIE | string | "quik:lang" | @quik/i18n | i18n.cookie | The name of the cookie used to identify the desired language for sending the messages to the customer. / | i18n.ts |
I18N_DEBUG | boolean | — | @quik/i18n | i18n.debug | Debug the i18n configuration. / | i18n.ts |
I18N_DEFAULT_LANG | string | "en" | @quik/i18n | i18n.default, i18n.fallback | The 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_LANGS | array | ",", "de,en,es,fr,it,nl,pt,ro" | @quik/i18n | i18n.supported, i18n.preload | A 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_ALGORITHM | string | "HS256" | @quik/authorization | auth.jwt.algorithm | The signing algorithm used when creating and verifying JWT tokens. Use `RS256` when signing with an RSA private key. / | auth.ts |
JWT_AUDIENCE | string | "dev.quik.land" | @quik/authorization | auth.jwt.audience | The 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_TIME | string | "1d" | @quik/authorization | auth.jwt.expireTime | Defines 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_ISSUER | string | "dev.quik.land" | @quik/authorization | auth.jwt.issuer | The 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_TIME | string | "1y" | @quik/authorization | auth.jwt.rememberMeTime | When 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_SECRET | string | "thisisasecret" | @quik/authorization | auth.jwt.secret | The 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_FILE | string | "app.log" | @quik/logging | logs.file | The 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_FOLDER | string | "./storage/logs" | @quik/logging | logs.folder | The 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_FORMAT | string | "combined" | @quik/http | logs.httpFormat | The format used to display the log information for HTTP requests. The supported formats are: "combined", "compact", "dev", "short", "tiny" / | logs.ts |
LOG_LEVEL | string | "debug" | @quik/logging | logs.level | The 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_TYPE | string | "console" | @quik/logging | logs.type | The 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_ENABLED | flag | — | @quik/logging | logs.enabled | Flag 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_ATTEMPTS | int | 5 | @quik/mfa | mfa.challenge.maxAttempts | Configuration value from environment. Config key: `mfa.challenge.maxAttempts`. | mfa.ts |
MFA_CHALLENGE_TIME_TO_LIVE_MS | int | 300000 | @quik/mfa | mfa.challenge.timeToLiveMs | Configuration value from environment. Config key: `mfa.challenge.timeToLiveMs`. | mfa.ts |
MFA_CODE_LENGTH | int | 6 | @quik/mfa | mfa.code.length | Configuration value from environment. Config key: `mfa.code.length`. | mfa.ts |
MFA_EMAIL_SUBJECT | string | "Your authentication code" | @quik/mfa | mfa.email.subject | Configuration value from environment. Config key: `mfa.email.subject`. | mfa.ts |
MFA_ENABLED | flag | — | @quik/mfa | mfa.enabled | computed | mfa.ts |
MFA_TOTP_DIGITS | int | 6 | @quik/mfa | mfa.totp.digits | Configuration value from environment. Config key: `mfa.totp.digits`. | mfa.ts |
MFA_TOTP_ISSUER | string | "Quik" | @quik/mfa | mfa.totp.issuer | Configuration value from environment. Config key: `mfa.totp.issuer`. | mfa.ts |
MFA_TOTP_QR_CODE_QUIET_ZONE_MODULES | int | 4 | @quik/mfa | mfa.totp.qrCode.quietZoneModules | Configuration value from environment. Config key: `mfa.totp.qrCode.quietZoneModules`. | mfa.ts |
MFA_TOTP_QR_CODE_SIZE_PIXELS | int | 256 | @quik/mfa | mfa.totp.qrCode.sizePixels | Configuration value from environment. Config key: `mfa.totp.qrCode.sizePixels`. | mfa.ts |
MFA_TOTP_STEP_SECONDS | int | 30 | @quik/mfa | mfa.totp.stepSeconds | Configuration value from environment. Config key: `mfa.totp.stepSeconds`. | mfa.ts |
MFA_TOTP_WINDOW | int | 1 | @quik/mfa | mfa.totp.window | Configuration value from environment. Config key: `mfa.totp.window`. | mfa.ts |
OAUTH_SERVER_ACCESS_TOKEN_TIME_TO_LIVE_SECONDS | int | 3600 | @quik/oauth-server | oauth.server.accessToken.timeToLiveSeconds | Configuration value from environment. Config key: `oauth.server.accessToken.timeToLiveSeconds`. | oauth.ts |
OAUTH_SERVER_AUTHORIZATION_CODE_TIME_TO_LIVE_SECONDS | int | 300 | @quik/oauth-server | oauth.server.authorizationCode.timeToLiveSeconds | Configuration value from environment. Config key: `oauth.server.authorizationCode.timeToLiveSeconds`. | oauth.ts |
OAUTH_SERVER_ENABLED | flag | — | @quik/oauth-server | oauth.server.enabled | computed | oauth.ts |
OAUTH_SERVER_HTTP_AUTHENTICATION_PREFIX | string | "/auth" | @quik/oauth-server | oauth.server.http.authenticationPrefix | Configuration value from environment. Config key: `oauth.server.http.authenticationPrefix`. | oauth.ts |
OAUTH_SERVER_HTTP_MANAGEMENT_PREFIX | string | "/" | @quik/oauth-server | oauth.server.http.managementPrefix | Configuration value from environment. Config key: `oauth.server.http.managementPrefix`. | oauth.ts |
OAUTH_SERVER_ISSUER | string | "http://localhost:3000" | @quik/oauth-server | oauth.server.issuer | Configuration value from environment. Config key: `oauth.server.issuer`. | oauth.ts |
OAUTH_SERVER_JWKS_KEY_IDENTIFIER | string | "oauth-server-default" | @quik/oauth-server | oauth.server.jwks.keyIdentifier | Configuration value from environment. Config key: `oauth.server.jwks.keyIdentifier`. | oauth.ts |
OAUTH_SERVER_JWKS_RSA_MODULUS_LENGTH | int | 2048 | @quik/oauth-server | oauth.server.jwks.rsaModulusLength | Configuration value from environment. Config key: `oauth.server.jwks.rsaModulusLength`. | oauth.ts |
OAUTH_SERVER_JWKS_SIGNING_PRIVATE_KEY_PEM | string | "" | @quik/oauth-server | oauth.server.jwks.signing.privateKeyPem | Configuration value from environment. Config key: `oauth.server.jwks.signing.privateKeyPem`. | oauth.ts |
OAUTH_SERVER_JWKS_SIGNING_PUBLIC_KEY_PEM | string | "" | @quik/oauth-server | oauth.server.jwks.signing.publicKeyPem | Configuration value from environment. Config key: `oauth.server.jwks.signing.publicKeyPem`. | oauth.ts |
OAUTH_SERVER_PKCE_REQUIRED_BY_DEFAULT | string | "true" | @quik/oauth-server | oauth.server.pkce.requiredByDefault | Configuration value from environment. Config key: `oauth.server.pkce.requiredByDefault`. | oauth.ts |
OAUTH_SERVER_REFRESH_TOKEN_ROTATE_ON_USE | string | "true" | @quik/oauth-server | oauth.server.refreshToken.rotateOnUse | Configuration value from environment. Config key: `oauth.server.refreshToken.rotateOnUse`. | oauth.ts |
OAUTH_SERVER_REFRESH_TOKEN_TIME_TO_LIVE_SECONDS | int | 2592000 | @quik/oauth-server | oauth.server.refreshToken.timeToLiveSeconds | Configuration value from environment. Config key: `oauth.server.refreshToken.timeToLiveSeconds`. | oauth.ts |
QUIK_APP_KEY | string | — | @quik/core | crypto.appKey | The default features file for the application / | crypto.ts |
QUIK_BOOTSTRAP_TIMEOUT | number | 15000 | @quik/core | quik.bootstrap.timeout | Configuration value from environment. Config key: `quik.bootstrap.timeout`. | quik.ts |
QUIK_DEBUG | flag | — | @quik/core | quik.debug | Enable Quik debug mode. Config key: `quik.debug`. | quik.ts |
QUIK_EXPOSE_ERROR_DETAILS | flag | — | @quik/core | quik.errors.details | The default features file for the application / | quik.ts |
SCHEDULER_EXECUTOR_DATABASE | flag | — | @quik/scheduler | scheduler.executor.database | Default scheduler configuration derived from environment variables. / | scheduler.ts |
SCHEDULER_MAX_CONCURRENCY | int | 1 | @quik/scheduler | scheduler.maxConcurrency | Max scheduler concurrency. Config key: `scheduler.maxConcurrency`. | scheduler.ts |
SCHEDULER_QUEUE_BATCH_SIZE | int | 10 | @quik/queue-worker | scheduler.queue.batchSize | Configuration value from environment. Config key: `scheduler.queue.batchSize`. | scheduler.ts |
SCHEDULER_QUEUE_INTERVAL_MS | int | 2000 | @quik/queue-worker | scheduler.queue.intervalMs | Default scheduler configuration derived from environment variables. / | scheduler.ts |
SESSION_FILE_FOLDER | string | ".sessions" | @quik/http | http.session.file.folder | Configuration value from environment. Config key: `http.session.file.folder`. | http.ts |
SESSION_REDIS_DB | int | 0 | @quik/http | http.session.redis.db | Configuration value from environment. Config key: `http.session.redis.db`. | http.ts |
SESSION_REDIS_HOST | string | "127.0.0.1" | @quik/http | http.session.redis.host | Configuration value from environment. Config key: `http.session.redis.host`. | http.ts |
SESSION_REDIS_KEY_PREFIX | string | "quik:session:" | @quik/http | http.session.redis.keyPrefix | Configuration value from environment. Config key: `http.session.redis.keyPrefix`. | http.ts |
SESSION_REDIS_PASSWORD | string | "" | @quik/http | http.session.redis.password | Configuration value from environment. Config key: `http.session.redis.password`. | http.ts |
SESSION_REDIS_PORT | int | 6379 | @quik/http | http.session.redis.port | Configuration value from environment. Config key: `http.session.redis.port`. | http.ts |
SESSION_SECRET | string | "thisIsAS3cret" | @quik/http | 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" | @quik/http | 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 | @quik/http | http.session.ttlSeconds | Session TTL in seconds forwarded to the store driver. / | http.ts |
STORAGE_LOCAL_DESTINATION | string | "./storage" | @quik/storage | storage.local.destination | Local storage configuration. Config key: `storage.local.destination`. | storage.ts |
STORAGE_LOCAL_ENABLED | flag | — | @quik/storage | storage.local.enabled | Default configuration values for the storage module. / | storage.ts |
STORAGE_LOCAL_HTTP_BASE_PATH | string | "/storage/local" | @quik/storage | storage.local.http.basePath | Local storage configuration. Config key: `storage.local.http.basePath`. | storage.ts |
STORAGE_LOCAL_PUBLIC_URL | string | "" | @quik/storage | storage.local.publicUrl | Local storage configuration. Config key: `storage.local.publicUrl`. | storage.ts |
STORAGE_LOCAL_SIGNED_DOWNLOAD_EXPIRE | number | 60 | @quik/storage | storage.local.signed.download | Local storage configuration. Config key: `storage.local.signed.download`. | storage.ts |
STORAGE_LOCAL_SIGNED_SECRET | string | "" | @quik/storage | storage.local.signed.secret | Local storage configuration. Config key: `storage.local.signed.secret`. | storage.ts |
STORAGE_LOCAL_SIGNED_UPLOAD_EXPIRE | number | 60 | @quik/storage | storage.local.signed.upload | Local storage configuration. Config key: `storage.local.signed.upload`. | storage.ts |
STORAGE_LOCAL_UPLOAD | string | "./temp" | @quik/storage | storage.local.upload | Local storage configuration. Config key: `storage.local.upload`. | storage.ts |
STORAGE_S3_ACCESS_KEY | string | — | @quik/storage | storage.s3.accessKeyId | S3 storage configuration. Config key: `storage.s3.accessKeyId`. | storage.ts |
STORAGE_S3_BUCKET | string | — | @quik/storage | storage.s3.bucket | S3 storage configuration. Config key: `storage.s3.bucket`. | storage.ts |
STORAGE_S3_ENABLED | flag | — | @quik/storage | storage.s3.enabled | S3 storage configuration. Config key: `storage.s3.enabled`. | storage.ts |
STORAGE_S3_ENDPOINT | string | — | @quik/storage | storage.s3.endpoint | S3 storage configuration. Config key: `storage.s3.endpoint`. | storage.ts |
STORAGE_S3_PATH_STYLE | flag | — | @quik/storage | storage.s3.pathStyleUrl | S3 storage configuration. Config key: `storage.s3.pathStyleUrl`. | storage.ts |
STORAGE_S3_REGION | string | "eu-west-1" | @quik/storage | storage.s3.region | S3 storage configuration. Config key: `storage.s3.region`. | storage.ts |
STORAGE_S3_SECRET_KEY | string | — | @quik/storage | storage.s3.secretAccessKey | S3 storage configuration. Config key: `storage.s3.secretAccessKey`. | storage.ts |
STORAGE_S3_SIGNED_DOWNLOAD_EXPIRE | number | 60 | @quik/storage | storage.s3.signed.download | S3 storage configuration. Config key: `storage.s3.signed.download`. | storage.ts |
STORAGE_S3_SIGNED_UPLOAD_EXPIRE | number | 60 | @quik/storage | storage.s3.signed.upload | S3 storage configuration. Config key: `storage.s3.signed.upload`. | storage.ts |
TELEMETRY_AUTO_INSTRUMENTATIONS | flag | — | @quik/telemetry | telemetry.autoInstrumentations | Enable auto-instrumentations. Config key: `telemetry.autoInstrumentations`. | telemetry.ts |
TELEMETRY_ENABLED | flag | — | @quik/telemetry | telemetry.enabled | Enable telemetry module. Config key: `telemetry.enabled`. | telemetry.ts |
TELEMETRY_LOGGING_BRIDGE | flag | — | @quik/telemetry | telemetry.logging.bridge | Bridge telemetry into logging. Config key: `telemetry.logging.bridge`. | telemetry.ts |
TELEMETRY_LOGGING_PASSTHROUGH | flag | — | @quik/telemetry | telemetry.logging.passthrough | Allow telemetry logger passthrough. Config key: `telemetry.logging.passthrough`. | telemetry.ts |
TELEMETRY_OTLP_ENDPOINT | string | "" | @quik/telemetry | telemetry.exporter.otlp.endpoint | OTLP exporter endpoint. Config key: `telemetry.exporter.otlp.endpoint`. | telemetry.ts |
TELEMETRY_SERVICE_NAME | string | "" | @quik/telemetry | telemetry.serviceName | Service name for telemetry traces. Config key: `telemetry.serviceName`. | telemetry.ts |
USER_LANGUAGE_FIELD | string | — | @quik/core | quik.user.languageField | Configuration value from environment. Config key: `quik.user.languageField`. | quik.ts |
WEBSOCKET_HEARTBEAT_ENABLED | get | — | @quik/websocket | websocket.heartbeat.enabled | Enables server-side heartbeat checks. / | websocket.ts |
WEBSOCKET_HEARTBEAT_INTERVAL_MILLISECONDS | number | 30000 | @quik/websocket | websocket.heartbeat.intervalMilliseconds | Interval between heartbeat pings. / | websocket.ts |
WEBSOCKET_HEARTBEAT_PING_MESSAGE_TYPE | string | "quik.websocket.ping" | @quik/websocket | websocket.heartbeat.pingMessageType | Application-level ping message type. / | websocket.ts |
WEBSOCKET_HEARTBEAT_PONG_MESSAGE_TYPE | string | "quik.websocket.pong" | @quik/websocket | websocket.heartbeat.pongMessageType | Application-level pong message type. / | websocket.ts |
WEBSOCKET_HEARTBEAT_TIMEOUT_MILLISECONDS | number | 10000 | @quik/websocket | websocket.heartbeat.timeoutMilliseconds | Time allowed for a peer to answer the latest ping. / | websocket.ts |
WEBSOCKET_PATH | string | "/ws" | @quik/websocket | websocket.path | HTTP upgrade path used by WebSocket adapters. / | websocket.ts |