SAF Documentation

Appearance

@saflib/identity-http

Interface: IdentityHttpEnvSchema ​

Environment variables for the @saflib/identity-http package, including inherited variables. Generated by @saflib/env. To update, make changes to the adjacent env.schema.json, navigate to the package root, and run npm exec saf-env generate.

Properties ​

ALLOW_DB_CREATION? ​

optional ALLOW_DB_CREATION: "true" | "false"

Whether to allow the creation of new databases. Useful for ensuring existing production environments don't inadvertently create new databases.

CLIENT_SUBDOMAINS ​

CLIENT_SUBDOMAINS: string

Comma-separated list of client subdomains, e.g. 'www,app,auth,'. Include an empty string (such as in the example) to indicate there's a client for the root domain.

DEPLOYMENT_NAME ​

DEPLOYMENT_NAME: string

The name of the deployment, e.g. 'production', 'staging', 'development'. This may be used in strings such as database file names and logging metadata; each deployment should have a unique name.

DOMAIN ​

DOMAIN: string

The root domain of the deployment, e.g. 'saf.com'.

DOMAIN_REDIRECTS? ​

optional DOMAIN_REDIRECTS: string

Comma-separated list of domains to redirect to the root domain, e.g. 'old-subdomain1.saf.com,old-subdomain2.saf.com'.

IDENTITY_SERVICE_ADMIN_EMAILS? ​

optional IDENTITY_SERVICE_ADMIN_EMAILS: string

Comma-separated list of emails who will get the 'admin' scope. Emails must be validated to receive this scope.

IDENTITY_SERVICE_DISABLE_RATE_LIMITING? ​

optional IDENTITY_SERVICE_DISABLE_RATE_LIMITING: string

Whether to disable rate limiting. Set to 'true' to disable.

IDENTITY_SERVICE_HTTP_PORT ​

IDENTITY_SERVICE_HTTP_PORT: string

MOCK_INTEGRATIONS? ​

optional MOCK_INTEGRATIONS: "true" | "false"

Whether to mock 3rd party integrations. Set to 'true' to mock. And integration packages should respect this setting.

NODE_ENV ​

NODE_ENV: "development" | "production" | "test"

The environment of the deployment. Generally should avoid using this, consider its use deprecated, prefer instead more specific environment variables.

NODEMAILER_TRANSPORT_CONFIG ​

NODEMAILER_TRANSPORT_CONFIG: string

JSON string which can be passed into nodemailer.createTransport. See https://nodemailer.com/usage for more details.

PROTOCOL ​

PROTOCOL: "https" | "http"

The protocol of the deployment, e.g. 'https'

SERVICE_SUBDOMAINS ​

SERVICE_SUBDOMAINS: string

Comma-separated list of service subdomains, e.g. 'revenue,geo,identity,core'.

TZ ​

TZ: "UTC"

The timezone of the deployment, e.g. 'America/New_York'. Must be UTC.