S
S
StifleR
2.10
Search
K

StifleR Server Configuration File

The StifleR Server configuration file is used to configure global settings for the StifleR server. The config file (StifleR.Service.exe.config) is located within in the program files directory in which StifleR was installed. The settings below are located within the <appSettings> section of the file:
Example:
<appSettings>
<add key="Setting Key Value Name" value="some value"/>
</appSettings>
Note: Not all values in the StifleR.Service.exe.config file are documented here. Please contact 2Pint Support prior to making changes to undocumented settings.
You must restart the "2Pint Software StifleR Server" service for the changes in the configuration file to take effect. In general, numerical value 0 = False and 1 = True. Individual values are to be considered default.
Setting Key Value Name
Values and Descriptions
AcceptClients
Value: 0 or 1 (default) Description: Determines whether the StifleR server will accept client communications.
ActiveDirectorySiteLookup
Value: 0 or 1 (default) Description: Enables or disabled AD site lookups.
AgentGroupMembership
Value: domain\group name Description: This is the name of the AD group used to control client access to the StifleR server. To enable this feature, see the setting: RequireAgentGroupMembership.
AllowAnonymousRead
Value: 0 (default) or 1 Description: If value = 0, anonymous read access is disabled and limited to the group defined by the "DefaultStifleRRead" value. If value = 1, anonymous read access is allowed.
AllowAnonymousSignalRConnections
Value: 0 or 1 (default) Description: Determines whether anonymous SignalR connections are allowed. If the value is set to 1 – then any StifleR client can connect. This is default currently, as older StifleR Clients (pre- 1.9.7.4) are not capable of ANY authentication and would be rejected if this were set to “0”. This can be disabled by setting the ConnectionSendCredentials option to “0” in the configuration file of the client.
AutoAddLocations
Value: 0 or 1 (default) Description: Determines whether or not clients that report from unknown locations should be automatically added.
AutoAddLocationsBandwidth
Value: 1024 Description: Sets which Data speed should new locations get. Value is in kbps.
BandwidthTuning
Value: 25 Description: Sets BITS flag decimal value for which bandwidth tuning functions use. 0 = no bandwidth tuning.
BingMapKey
Value: <key> Description: Key to use for BING Map Support.
CertificateClientThumbprint
Value: <thumbprint> Description: The thumbprint for the client certificate. Should be defined if RequireAgentClientCertificate = 1. This section is for client certificate verification, and not for TLS/SSL for https based communications. See WebServiceCertificateThumbprint and SignalRCertificateThumbprint instead.
CertificateRootThumbprint
Value: <thumbprint> Description: The thumbprint for the trusted certificate root. Should be defined if RequireAgentClientCertificate = 1.
ClientSettingsProvider.ServiceUri
Value: <uri> Description: Not currently in use.
ConfigMgrServerAdminService
Value: <https://cm.fqdn.local> Description: The URL for the Configuration Manager service running the Admin Service.
DefaultRoamingBandwidth
Value: 0 (default) or value in kbps Description: Which Data speed should roaming machines have, 0 means unlimited, i.e. no policy.
DefaultStifleRAdmins
Value: Domain\AD Group Name Description: AD Groups that are granted full admin rights to the StifleR platform.
DefaultStifleRRead
Value: Domain\AD Group Name Description: This group has read access to StifleR global data, all locations, and all items.
EnableDebugLogging
Value: 0 (default) or 1 Description: Enables debugging. This log will be fairly verbose, so remember to set it to "0" to switch it off afterwards. Errors and warnings will always be logged to the event log. See the ServerDebugLogPath setting for the location of the debug log file.
EnableStifleREngineWMI
Value: 0 or 1 (default) Description: Whether the StifleR WMI provider should be enabled or not.
ExpectedRedLeaderCheckInInterval
Value: 5000 Description: If a Red Leader has not checked in within this time period, another one will be elected. Value in msecs.
GenerateNewLocationsWithPowerShell
Value: 0 (default) or 1 Description: If 1, then a PowerShell script will be executed when new locations are created. If the value =1, the script identified in PowerShellExtensionLocationCreateScriptPath is executed as soon as a new subnet has been created.
HighBandwidthWarningDecreaseFactor
Value: 1.4 Description: How much we lower the bandwidth if the location is still using too much bandwidth. 1.4 = a 40% decrease.
HighBandwidthWarningIncreaseDuration
Value: 10000 Description: If a Red Leader has been below the allocated bandwidth for this period of time, we increase the bandwidth usage by HighBandwidthWarningIncreaseFactor. Value is in KBps.
HighBandwidthWarningIncreaseFactor
Value: 5 Description: When a high bandwidth usage warning has been lifted, this value specifies how much more to increase the value. 100/5 = 20% increase from the throttled value.
HomeChainSystemAgentId
Value: StiflerService Description: Legacy value to be removed in future versions.
LatencyWarningDecreaseDuration
Value: 10000 Description: Number of milliseconds before a latency decrease WMI event is signaled. i.e. if latency has been lower than existing * LatencyWarningDecreaseFactor than target for 10 seconds, a WMI event is triggered. Value is in msec.
LatencyWarningDecreaseFactor
Value: 1.4 Description: Factor used to calculate whether or not to signal an event. 1.4 equals a decrease by 40%.
LatencyWarningIncreaseDuration
Value: 10000 Description: Number of milliseconds before a latency increase WMI event is signaled. i.e. if latency has been higher than target * LatencyWarningIncreaseFactor for 10 seconds a WMI event is triggered. Value is in msec.
LatencyWarningIncreaseFactor
Value: 5 Description: Factor used to calculate whether or not to signal an event. Calculated as: if TunedBandwidth + (TargetBandwidth / LatencyWarningIncreaseFactor) > TargetBandwidth
LicenseKey
Value: <StifleRLicenseKey> Description: The StifleR server license key.
ListenToUrl
Value: <http://* | https://*>:<StifleRPort> Ex: http://*:1414
Description: Which Data binding to use to listen for incoming client connections. This should be https:// in a production environment.
LocationWSListenToUrl
Value: <http://* | https://*>:<APIPort> Ex: http://*:9000 Description: Which Data binding to use for the web API used by dashboards or scripts. This should be https:// in a production environment.
LowBandwidthWarningIncreaseDuration
Value: 10000 Description: Not used currently.
ModifyNewLocationsWithPowerShell
Value: 0 (default) or 1 Description: If the value =1, the script identified in PowerShellExtensionLocationModifyScriptPath is executed as soon as a new subnet has been created.
NonRedLeaderBITSBandwidth
Value: 128 Description: Which Data speed should non Red Leader machines have for BITS jobs. Value is in kbps.
NonRedLeaderDOBandwidth
Value: 128 Description: Which Data speed should non Red Leader machines have for Delivery Optimization jobs. Value is in kbps.
PowerShellExtensionLocationCreateScriptPath
Value: %PROGRAMDATA%\2Pint Software\StifleR\Server\GenerateLocation.ps1 Description: Path to script for PS Generation of sites. This will be executed when GenerateNewLocationsWithPowerShell = 1.
PowerShellExtensionLocationModifyScriptPath
Value: "%PROGRAMDATA%\2Pint Software\StifleR\Server\ModifyLocation.ps1" Description: Path to script for location modification. This will be executed when ModifyNewLocationsWithPowerShell = 1.
RedLeaderAssignmentInterval
Value: 10000 Description: How often we reiterate the Red Leader list to communicate with Red Leaders. Value in msec.
RedLeaderCacheSizeFactor
Value: 1.2 Description: Percentage of larger size of Cache, i.e. we switch Red Leader if a new client has 20% larger cache size. This forces large disk machines to be Red Leaders. 1.2 = 20% etc.
RedLeaderElectionInterval
Value: 30000 Description: How long we wait between each run of informing Red Leaders that they should stay Red Leaders. Value is in msec.
RedLeaderForceCacheSizeFactor
Value: 4 Description: Percentage of larger size of Cache, i.e. we switch Red Leader if a new client has 4x cache size. Even if other components, such as NIC speed, is slower.
RequestAgentToken
Value: <agent token> Description: String value of the token to accept connections for. See the Client Token section at the Permissions page for more info.
RequireAgentClientCertificate
Value: 1 (default) or 0 Description: If value = 1, the client is required to attach a client certificate to the SignalR connection. This requires the CertificateClientThumbprint and CertificateRootThumbprint values to be configured (added) with a thumbprint of a local certificate which is then present in the personal (MY) store in the local machine store location of the client. The first certificate in the store chain from that thumbprint is used. The server will then verify the certificate. Failing to verify the certificates will return a 403 error to the requesting client.
RequireAgentGroupMembership
Value: 0 (default) or 1 Description: This setting is used to require that only StifleR clients who are part of a specific AD group are granted access. To enable this setting, the value must be set to 1. Once defined, the setting AgentGroupMembership must be defined to identify the AD group name. Note: If the client or the server is not in a domain, or a trusted domain, then the Local System account uses ANONYMOUS LOGON. This cannot be verified against a group, and would fail if the server is configured with RequireAgentGroupMembership.
RequireDashboardClientCertificate
Value: 0 (default) or 1 Description: If value is set to 1, a client certificate is required to connect to the StifleR Dashboard.
RogueLeaderInterval
Value: 120 Description: Raise event if Red Leader is still checking in, but the server cannot talk to the client, but client can talk back. This then sets the NotLeaderMaterial = true; Value in sec.
SaveElectionData
Value: 1 (default) or 0
Description:
Whether to keep election data or not, we save max 100 elections per subnet.
ServerDebugLogPath
Value: %PROGRAMDATA%\2Pint Software\StifleR\Logs Description: The path of the debug log file when debug logging is enabled. Ensure that the service account has access to the path if no log is appearing.
SignalRCertificateThumbprint
Value: 1234567890abcdef1234567890abcdefg1234567 Description: Certificate thumbprint to use for https SignalR traffic.
SignalRFW
Value: 1 (default) or 0 Description: Automatically configure the Windows Firewall exceptions for SignalR client connections.
SkipNetworkList
Value: <subnet ID, subnet / subnet mask> Ex: 172.1.0.0, 192.168.0.0/255.255.0.0 Description: Controls which networks should be ignored, any network that falls within the defined range is ignored.
SQLHistory
Value: 0 (default) or 1 Description: Enables content download history in a SQL database.
StifleRDashboardAccess
Value: Domain\AD Group Name Description: AD Groups that are granted limited access to the StifleR dashboard.
UseDataQueue
Value: 1 (default) or 0 Description: Uses in memory queue system instead of updating internal data lists for every message, recommended.
UseWMIEnumerator
Value: 1 (default) or 0 Description: Enables the WMI Enumerator function to get WMI data.
WebServiceCertificateThumbprint
Value: 1234567890abcdef1234567890abcdefg1234567"
Description: Certificate thumbprint to use for https, for web service communication
WellConnectedSplitbandwidth
Value: 0 or 1 (default) Description: If "WellConnectedSplitbandwidth" value= 0, all active clients get the same Bandwidth. If "WellConnectedSplitbandwidth" value= 1, the WellConnectedBITSBandwidth / WellConnectedDOBandwidth values will be split between all ACTIVE clients. If only the TargetBandwidth is set – the Red Leader will be allocated that bandwidth and all others will use the default Non-Red Leader bandwidth (as per a regular subnet).
WSAPIFW
Value: 1 (default) or 0 Description: Automatically configure the Windows Firewall exceptions for StifleR API connections.