search close

Windows Agent Installation

access_time Updated Sep 21, 2021

The Signal Sciences Agent is a small daemon process which provides the interface between your web server and our analysis platform. An inbound web request is passed to the agent, the agent then decides whether the requests should be permitted to continue or whether we should take action.

  1. Create an agent configuration file with any text editor:
    C:\Program Files\Signal Sciences\Agent\agent.conf

    accesskeyid = "AGENTACCESSKEYHERE"
    secretaccesskey = "AGENTSECRETACCESSKEYHERE"
    rpc-address = "127.0.0.1:737"
    
  2. Configure the agent by inputting the Agent Access Key and Agent Secret Key into the C:\Program Files\Signal Sciences\Agent\agent.conf.

    • The Agent Access Key and Agent Secret Key for your site are listed within the Signal Sciences console by going to Agents > View agent keys:

      The 'View agent keys' button.
    • The Agent Access Key and Agent Secret Key will be visible within the modal window:
      The agent keys window.

    • If you need to specify a custom location for the agent.conf file, set the absolute file path with the system environment variable SIGSCI_CONFIG.
    • If you are deploying the agent in reverse proxy mode, see the Reverse Proxy Mode configuration page for details on required configuration options.

    Additional configuration options are available on our Agent Configuration Page.

  3. Download the latest Signal Sciences Windows Agent from https://dl.signalsciences.net/?prefix=sigsci-agent/.

    • Running the MSI will install the Agent automatically with no prompts. It will install the executable in C:\Program Files\Signal Sciences\Agent, add a service entry for the Agent, and start the service if the agent configuration file is present and has valid accesskeyid and secretaccesskey settings.
    • The installed service name is sigsci-agent and can be controlled with PowerShell commandlets:
      • Start-Service sigsci-agent
      • Restart-Service sigsci-agent
      • Stop-Service sigsci-agent
    • The zip file contains the agent binary, which can be run from any location you prefer. Installing in this way requires the user to configure the Service entry and start the service manually.
    • Example services.msc screenshot:
Example 'services.msc' screenshot with the 'Signal Sciences Agent' service highlighted.

Next Steps

Install the Signal Sciences Module: