Skip to main content

Deployment

  • Updated

OC Configurator can be deployed in two different ways, depending on the OC Scanner deployment approach.

With Agentless Single Scanner

The deployment of OC Configurator for the agentless single scanner approach is straightforward. You will need to put the following two files in any folder of your choice on the server you want to deploy OC Configurator. By convention, we recommend creating a subfolder C:\oc_configurator or a folder oc_configurator on the Desktop and place the following two files in there:

  1. OctopusConfigurator.exe file (OC Configurator application)
  2. configuration.settings file (stores encrypted application settings)
    If this file doesn’t exist, OC Configurator will create it for you after the first starting of the application.

With Agent-Based And/Or Agentless Multiple Scanners

The installation for the agent-based and/or agentless multiple scanner approaches requires additionally an IIS web server for OC Configurator. The web server is needed to host a small API web application to receive over HTTP/s data by OC Scanners deployed on different machines. The API allows you to configure centrally all OC Scanners over their depending on scan files within OC Configurator. Because the setup of the OC Configurator API server requires a directory structure, we created a helper console application named UpdaterApi.exe file, which is taking care of creating the needed directory structure.

Installation steps for OC Configurator API:

  1. Create a folder on the server, where you want to deploy OC Configurator including the API. By convention, we recommend creating a folder C:\inetpub\oc_configurator.
  2. Create a subfolder updater in that folder, e.g., C:\inetpub\oc_configurator\updater.
  3. Move the UpdaterApi.exe file into the updater folder and run it. It will download the appropriate files from the Octopus Cloud and create the required directory structure.
  4. After the UpdaterApi.exe process is completed, go one level up in the folder structure to see the entire created directory structure.
  5. Don’t be overwhelmed by the number of files and folders created. They are needed for OC Configurator API to work correctly. The most important folder for you is the configs folder. It stores the OctopusConfigurator.exe file (the OC Configurator application) which is used to configure our OC Scanners over their scan files. For faster access to OC Configurator, we recommend creating a shortcut of the configs folder on the Desktop.
  6. The UpdaterApi.exe process also created a scheduled task named octopus_cloud_api_updater_task for you, which is running daily with the SYSTEM account. The scheduled task is taking care of updates of OC Configurator API and other internal processes.
  7. The next step is to create an OC Configurator IIS website. The website is needed for Octopus Configurator API to be reachable by OC Scanners deployed on different machines to communicate with the central OC Configurator. The communication is always from the OC Scanners towards the OC Configurator API. No access required from OC Configurator server towards the OC Scanner machines.
  8. Open the IIS Manager on the machine where you installed OC Configurator.
  9. In IIS Manager, select Add new website.
  10. Enter in Site name the value OC Configurator API
  11. For Physical path select the folder of the OC Configurator API installation, e.g., C:\inetpub\oc_configurator
  12. In the Binding section, you define the central endpoint URL for OC Scanners to communicate with OC Configurator API. Choose the binding Type and the Port for the API.
  13. Click OK to add the new website.
  14. To ensure OC Configurator API works correctly in the environment, you need to test it from any machine that will host the OC Scanner application. Connect to a specific machine that will host OC Scanner.
  15. On that machine, open a web browser and enter one of the following addresses, which matches your configured binding above:
    • http://[oc-configurator-api-server-address]/Service.svc
    • https://[oc-configurator-api-server-address]/Service.svc
    • http://[oc-configurator-api-server-address]:[port number]/Service.svc
    • https://[oc-configurator-api-server-address]:[port number]/Service.svc

oc-configurator-api-server-address is the IP address or the DNS hostname, depending on how your server/network is configured. If OC Configurator API opens successfully with the title “Service Service” and the sentence “You have created a service.”, the API service is set up correctly and ready.

Related articles