Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Specifies the node configuration in the server farm. Generally, it contains the application host connection and other network-related configuration settings. Agent configuration uses the layered configuration in the following order;

  • <installdir>/appsettings.json

  • <installdir>/Configuration/appsettings.json

  • <installdir>/Configuration/CustomData/appsettings.json

  • Environment variables

  • Command line arguments

  • <installdir>/Configuration/CustomData/protectedsettings.json

Default The default configuration is stored in <installdir>/appsettings.json file and it is not recommended to change. Any change should be specified in <installdir>/Configuration/appsettings.json or <installdir>/Configuration/Data/appsettings.json or other layers.

...

Any environment variable that starts with "AK_" prefix overrides the configuration entries in appsettings.json file. For example, the host configuration connection can be specified as an environment variable;

Code Block
AK_DbProvider = "Postgres"
AK_DbConnStr = "Host=myserver;Database=emakin;Username=emakin;Password=mypassword;"

Configuration sub-section entries can be overridden with “__” (double underscores) separators. For example, if you want to change the webserver port you may define an environment variable as follows;

Code Block
AK_WEB__KESTREL__ENDPOINTS__HTTP__URL=http://*:81

Command Line Arguments

Any command line argument to the agent executable overrides the configuration entries.

...

Encrypting Configuration Settings

By default, all configuration parameters are stored in plain text json JSON files but sensitive settings like database connection string can be encrypted if needed. Encrypted settings are stored in this path and overwrites the previous layers.

  • <installdir>/Configuration/CustomData/protectedsettings.json

Note

Encrypted configuration settings can be only written and cannot be read back. If you lost this file all values are cannot be retrieved.

For example, the database connection string can be set with;

Code Block
.\AltiKare.Workflow.Agent.exe setconfig DbConnStr DBConnStr 'Host=myserver;Database=emakin;Username=emakin;Password=mypassword;'

After this command is executed a new protectedsettings.json file is created in ‘Configuration/Custom’ directory and stores the encrypted connection string.

Code Block
{
  "DbConnStr": "CfDJ8L..........6PT0Kw="
}

Any configuration value from <installdir>/appsettings.json file can be set with setconfig parameter and child sections can be specified with “:” qualifier.

...

Detailed information can be found in the CLI interface option.