Environment Values

If needed, configure the Plauti Server installation by adjusting its Environment Values (Env Values).

Directions for use of the Env Values

Overriding Env Values

To override default values, set the corresponding key in your env.properties, config.json, or process.env (environment variable).

Load Order

Values are loaded in the following order, meaning any value you provide will be used first:

  1. env.properties in your current working directory
  2. Internal configuration (config.json, env.config.jsonc)
  3. Environment variables (process.env)
  4. Built-in defaults (as displayed in the list below)

Validation

  • All environment values must be strings or string lists (where applicable).
    A string-list is a basic string with key=value1,value2,value3
  • Validation is performed using schema validation; invalid, missing, or null values for required fields will throw errors at runtime.
  • Double check that all required keys are set for your platform and environment.
  • For list values (e.g., ALERT_EMAIL_LIST), supply a comma-separated list.
  • For secrets, use strong, random values of the required length.
  • If you see a validation error, look for missing required keys, typos in key names, invalid email addresses, or incorrectly formatted values.

The default Environment Values

Note:

  • For secret/private keys, only the type is shown for security reasons.
  • If a key is marked as required = " yes* ", then either this key or its counterpart (as indicated) is required, not both.
Name Type Default Required Description
HOST string 0.0.0.0 no The interface/IP the server will bind to for listening.
PORT number 8881 no The port number the server will listen on.
APP_URL string : url (must be provided for correct operation) no The URL where this server instance is accessible.
FRONTEND_URL string : url (defaults to APP_URL) no The URL of the frontend application.
CORS_ALLOW_LIST string array : list ( url1,url2 ) (string-list) no
ALERT_EMAIL_LIST string array : list (email1,email2) [] (empty list) no
LOG_FILE string plauti_server.log no Log file path/name for server logs.
LOG_LEVEL string : debug,error,warn,verbose,log debug no Logging verbosity: one of debug, info, log, verbose, warn, error, fatal.
DATABASE_URL string server.db no The database connection URI.
DATA_ENCRYPT_KEY string : min 9 <type: string, min 9 chars> yes Key used for encrypting sensitive data at rest.
JWT_SECRET string <type: string, 32 bytes, base64> yes Secret for signing JWT tokens.
JWT_LIFETIME string 1h no The lifetime of JWT tokens (e.g., 1h, 7d).
REFRESH_JWT_SECRET string <type: string, 32 bytes, base64> yes Secret for signing refresh JWT tokens.
REFRESH_JWT_LIFETIME string 1d no The lifetime of refresh JWT tokens (e.g., 1d, 30d).
SF_LOGIN_URL string : url https://test.salesforce.com/ no Salesforce login endpoint URL.
SF_LOGIN_CLIENT_ID string (provided by default) <type: string> yes Salesforce OAuth client ID for login.
SF_LOGIN_CLIENT_SECRET string (provided by default) <type: string> yes Salesforce OAuth client secret for login.
SF_CONNECT_CLIENT_ID string (provided by default) <type: string> yes Salesforce OAuth client ID for connect.
SF_CONNECT_CLIENT_SECRET string (provided by default) <type: string> yes Salesforce OAuth client secret for connect.
AZURE_TENANT_ID string (provided by default) <type: string> yes Azure directory (tenant) ID.
AZURE_LOGIN_CLIENT_ID string (provided by default) <type: string> yes Azure OAuth client ID for login.
AZURE_LOGIN_CLIENT_SECRET string (provided by default) <type: string> yes Azure OAuth client secret for login.
AZURE_CONNECT_CLIENT_ID string (provided by default) <type: string> yes Azure OAuth client ID for connect.
AZURE_CONNECT_CLIENT_SECRET string (provided by default) <type: string> yes Azure OAuth client secret for connect.
MAXIMUM_AMOUNT_OF_CPUS number 4 no Upper limit for CPUs that can be used by the application/process.
MAXIMUM_AMOUNT_OF_PROCESSES number 4 no Upper limit for processes that can be spawned by the application.
MS_TENANT_ID string - yes* Microsoft tenant ID. Required if SF_ORGANIZATION_ID not set.
SF_ORGANIZATION_ID string - yes* Salesforce organization ID. Required if MS_TENANT_ID not set.
SF_LOGIN_CLIENT_URI string (empty by default) - no Salesforce URI for login, be aware that this key is not dynamic with the usage of sandbox orgs.
SF_CONNECT_CLIENT_URI string (empty by default) - no Salesforce URI for connect, be aware that this key is not dynamic with the usage of sandbox orgs.