- Getting Started
- Requirements
- Best Practices
- Installation
- Updating
- Identity Server
- Hardware and Software Requirements
- Prerequisites for Installation
- Installation
- Encrypting AppSettings.Production.json
- Maintenance Considerations
- Troubleshooting startup errors

Orchestrator installation guide
Encrypting AppSettings.Production.json
Learn about encrypting AppSettings.Production.json.
Overview
Identity Server, Webhooks, and Resource Catalog Service AppSettings.Production.json files contain sensitive information one may want to secure. It is possible to encrypt/decrypt these files using the UiPath.ConfigProtector.exe tool.
Once encrypted, the data cannot be changed by directly editing the AppSettings.Production.json file. It must be decrypted and then re-encrypted.
UiPath.ConfigProtector.exe
UiPath.ConfigProtector.exe is located in Orchestrator's installation directory. Its full path is: C:\Program Files (x86)\UiPath\Orchestrator\Tools\ConfigProtector.
Command Reference
| Parameter | Description |
|---|---|
|
| Encrypts the AppSettings.Production.json file. |
|
| Decrypts the AppSettings.Production.json file. |
-f / --configfile | Indicates the file name and path of AppSettings.Production.json . |
-o / --output | The encrypted/decrypted file is saved to a new file instead of overwriting the existing one. |
|
| Displays information about the available commands. |
|
| Displays version information. |
|
| Allows you to add a configuration section of your choice to the tool's settings. This command uses the dot notation. configprotector.exe --pe -f appsettings.Production.json --signing-settings Other.Path.Of.SigningCredentialSettings |
--keys / k | Allows you to encrypt/decrypt keys that are not hardcoded. This parameter need to be followed by a list of comma separated keys. configprotector.exe --pe -f appsettings.Production.json --keys Path.To.Key1,Path.To.Key2Note: This should only be used in rare cases, and for keys that support encryption (which are mostly connection strings). An example of this is adding a new ledger subscriber with a new connection string, where you want to encrypt the new key without having to first decrypt the whole configuration, and encrypt it afterwards. The default paths that the tool already encrypts should suffice. |
Identity Server
Encryption
To encrypt AppSettings.Production.json, perform the following steps AFTER installing Orchestrator:
- Open the Command Prompt.
- Run the following command:
UiPath.ConfigProtector.exe --pe -f "C:\Program Files (x86)\UiPath\Orchestrator\Identity\appsettings.Production.json"UiPath.ConfigProtector.exe --pe -f "C:\Program Files (x86)\UiPath\Orchestrator\Identity\appsettings.Production.json"
Decryption
- Open the Command Prompt.
- Run the following command:
UiPath.ConfigProtector.exe --de -f "C:\Program Files (x86)\UiPath\Orchestrator\Identity\appsettings.Production.json"UiPath.ConfigProtector.exe --de -f "C:\Program Files (x86)\UiPath\Orchestrator\Identity\appsettings.Production.json"
Webhooks
Before you encrypt the Webhooks appsettings.Production.json, apply the following steps:
- Open the certificate console.
- Navigate to Personal, then to Certificates, and right-click the certificate you want to use.
- Next, select All Tasks, and then Manage Private Keys.
- Add the IIS_IUSRS group and the application pool user.
- Make sure to set the server as
Location. - IIS_IUSRS is a local group. You should search it under local machine, not under domain.
In addition, you must add the signing certificate settings. If you want to use the same certificate, copy the SigningCredentialSettings section from the Identity Server appsettings.Production.json file.
"AppSettings": {
"SigningCredentialSettings": {
"StoreLocation": {
"Name": "66B6B5A95BD055C8A264E643F9F8B26C7BEAA841",
"Location": "LocalMachine",
"NameType": "Thumbprint"
}
}
}
"AppSettings": {
"SigningCredentialSettings": {
"StoreLocation": {
"Name": "66B6B5A95BD055C8A264E643F9F8B26C7BEAA841",
"Location": "LocalMachine",
"NameType": "Thumbprint"
}
}
}
Namerepresents the Thumbprint of your certificate.- We do not recommend using other values for
LocationandNameType.
Encryption
- Open the Command Prompt.
- Run the following command:
UiPath.ConfigProtector.exe --pe -f "C:\Program Files (x86)\UiPath\Orchestrator\Webhooks\appsettings.Production.json"UiPath.ConfigProtector.exe --pe -f "C:\Program Files (x86)\UiPath\Orchestrator\Webhooks\appsettings.Production.json"
Decryption
- Open the Command Prompt.
- Run the following command:
UiPath.ConfigProtector.exe --de -f "C:\Program Files (x86)\UiPath\Orchestrator\Webhooks\appsettings.Production.json"UiPath.ConfigProtector.exe --de -f "C:\Program Files (x86)\UiPath\Orchestrator\Webhooks\appsettings.Production.json"
Resource Catalog Service
Prior to encrypting the Resource Catalog Service appsettings.Production.json, you need to add the signing certificate settings. You can copy the SigningCredentialSettings section from the Identity Server appsettings.Production.json file if you want to use the same certificate.
"SigningCredentialSettings": {
"StoreLocation": {
"Name": "66B6B5A95BD055C8A264E643F9F8B26C7BEAA841",
"Location": "LocalMachine",
"NameType": "Thumbprint"
}
}
"SigningCredentialSettings": {
"StoreLocation": {
"Name": "66B6B5A95BD055C8A264E643F9F8B26C7BEAA841",
"Location": "LocalMachine",
"NameType": "Thumbprint"
}
}
Namerepresents the Thumbprint of your certificate.- We do not recommend using other values for
LocationandNameType.
Encryption
- Open the Command Prompt.
- Run the following command:
UiPath.ConfigProtector.exe --pe -f .\appsettings.Production.json --signing-settings SigningCredentialSettingsUiPath.ConfigProtector.exe --pe -f .\appsettings.Production.json --signing-settings SigningCredentialSettings
Decryption
- Open the Command Prompt.
- Run the following command:
UiPath.ConfigProtector.exe --de -f .\appsettings.Production.json --signing-settings SigningCredentialSettingsUiPath.ConfigProtector.exe --de -f .\appsettings.Production.json --signing-settings SigningCredentialSettings