Skip to main content

Environment Variables

Boolean flags default to false when unset.

VariableTypeDefaultConfig KeysDescriptionSource
AUTH_AUTHORIZATION_ASSURANCE_LEVEL_FIELDstring"assuranceLevel"auth.authorization.fields.assuranceLevelConfiguration value from environment. Config key: `auth.authorization.fields.assuranceLevel`.auth.ts
AUTH_AUTHORIZATION_AUTHENTICATION_METHODS_FIELDstring"authenticationMethods"auth.authorization.fields.authenticationMethodsConfiguration value from environment. Config key: `auth.authorization.fields.authenticationMethods`.auth.ts
AUTH_AUTHORIZATION_COMPLETED_FACTORS_FIELDstring"completedFactors"auth.authorization.fields.completedFactorsConfiguration value from environment. Config key: `auth.authorization.fields.completedFactors`.auth.ts
AUTH_CHECK_FIELDstring"permissions"auth.authorization.fields.permissionAuthentication system configuration object. In this file, you can change various configuration parameters related to the authentication system. /auth.ts
JWT_ALGORITHMstring"HS256"auth.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"auth.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"auth.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"auth.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"auth.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"auth.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