Configure Session Remote Start
Configuration file
Session Remote Start configuration parameters are stored in the Web.config file found under the Session Remote Start installation directory ('C:\Program Files\Citrix\SessionRemoteStart\' by default).
| Parameter | Optional/Required | Description |
|---|---|---|
| StoreFrontServer | Required | The Web URL of the store explicitly created for Session Remote Start |
<add key="StoreFrontServer" value="https://<baseURL>/Citrix/<storename>Web"/> |
||
| RestAPIUrl | Optional | CVAD RestAPI URL For On-Prem should be https:// [DdcServerAddress], For Citrix DaaS should be https://api.cloud.com
|
| RestAPICredentialName | Optional | The credential created in previous section -'CVAD_RestAPI_Credential' by default.
|
| LocalFqdn | Required | FQDN of Session Remote Start server. Customers to edit this parameter - <add key="LocalFqdn" value="FQDN OF Session Remote Start SERVER"/>
|
| SiteId | Optional | For CVAD, fill with site ID. For Citrix DaaS, empty. |
| CustomerId | Optional | For CVAD, ‘CitrixOnPremises’. For Citrix DaaS, customer ID. |
| IcaClientName | Required | A unique hostname used for Session Remote Start initiated launches. Must be consistent with the value of ’$HostName’ in Logon Script DisconnectSession.ps1. |
| Customers can leave the default “srs-server” parameter here. Also, keep the same in DisconnectSession.ps1 | ||
<add key="IcaClientName" value="srs-server"/> |
||
| MaxRequestConcurrency | Optional | The number of concurrent API requests. 100 by default. |
| SessionIdCacheTtlSeconds | Optional | TTL of authentication session between Session Remote Start and StoreFront. 300 by default. |
| DeliveryGroupsCacheTtlMinutes | Optional | TTL of Delivery Group - Tag mapping cache. 10 by default. |
| DesktopsCacheTtlMinutes | Optional | TTL of Desktop name cache. 10 by default. |
| LogToConsole | Optional | Enable console logging. Default “False”. |
| LogToConsoleLevel | Optional | Trace severity level. See Log file configuration for details. 5 by default. |
| LogToDebug | Optional | Developer use only. |
| LogToDebugLevel | Optional | Developer use only. |
| OverwriteLogFile | Optional | Overwrite the log file on the next service start. False by default. |
| LogFileName | Optional | Log file location. "%AppData%\Citrix\SessionRemoteStart\Logs\SessionRemoteStart.log" by default. If empty, no logging will occur. |
| LogToFileLevel | Optional | Trace severity level. See Log file configuration for details. 5 by default. |
| LogToEventViewer | Optional | Enable event viewerlogging. Default “False”. The log path is %SystemRoot%\System32\Winevt\Logs\Application.evtx (Windows Logs > Application) and event source name is “SessionRemoteStart”. |
| LogToEventViewerLevel | Optional | Trace severity level. See Log file configuration for details. 5 by default. |
| RequestTimeoutSeconds | Optional | The timeout seconds of HTTP request from a 3rd-party service. 300 by default. |
| AutoRefreshConnections | Optional | True if Session Remote Start will auto refresh connections periodically. |
| UseLegacyStoreFront | Optional | True if StoreFront is an earlier version. False by default. |
| ProductVersion | Optional | The version of the current product build. It can be updated automatically when upgrading. |
| TelemetryDataDirectory | Optional | The directory of telemetry data. "%AppData%\Citrix\SessionRemoteStart\TelemetryData" by default even if it is empty. |
| LaunchDebugMode | Optional | Enable launch debug mode. Default False. If set to True, the ICA file is saved to disk instead of being launched. Note: For security reasons, the ICA file does not contain sensitive information. As a result, it can only be used for connection testing and cannot be used to actually launch a session. |
| IcaFileDirectory | Optional | The directory of ICA files. "%AppData%\Citrix\SessionRemoteStart\IcaFiles" by default. |
| IcaLog | Optional | True if you save the ICA communication log. False by default. Recommend False for saving space. |
| IcaLogFile | Optional | ICA log path. "%AppData%\Citrix\SessionRemoteStart\IcaLogs" by default. |
| mTLSEnabled | Optional | True to enable mTLS support. False by default. |
| SmartAccessFarmName | Optional | Farm name, for example: _XD_192.168.1.19_443
|
| SmartAccessConditions | Optional | List of conditions, for example: PL_WB_10.107.197.243, PL_WB_10.107.197.244
|
For log-related configuration, please refer to the Log file Configuration section.
Configuration file permissions
Check permissions of Web.config: (C:\Program Files\Citrix\SessionRemoteStart\Web.config by default)
Make sure administrator accounts have full control while other groups/users don’t have modify permission:
Log file Configuration
Currently, Session Remote Start logging supports CDF, AOT, and File tracing. CDF and AOT are always available. Others are based on configuration file settings.
Trace severity level
- 0 - Critical
- 1 - Urgent
- 2 - Significant
- 3 - Important
- 4 - ImportantDetailed
- 5 - Informational
- 6 - InformationalDetailed
- 7 - Notable
- 8 - NotableDetailed
- 9 - Insignificant
Log to File
Logging to file is enabled by default. To disable, set LogFileName in Web.config to empty.
The default log path is shown below, where {Session Remote Start user} should be replaced with the user hosting the SRS service. If the Application Pool identity has not been modified, it defaults to SrsAppPool. If the identity has been changed to srs, replace {Session Remote Start user} with srs.
"C:\Users\{Session Remote Start user}\AppData\Roaming\Citrix\SessionRemoteStart\Logs\SessionRemoteStart.log".
Customers can change the log file location and permissions as per their requirements, please see the steps required to change the Log file location and permissions.