Configuring Orchid Recorder for Automatic Updates (Windows)

Beginning in version 24.12, Orchid Recorder supports automatic updates on Windows systems, for selected license types only. Using this feature helps to ensure that your system is always up-to-date (without adding another task to your to-do list).

There are a few different settings available to configure the automatic updates. To edit these, you may use either of the following methods:

• You can use the Advanced Settings feature in the software (which is described in the Orchid Recorder Administrator Guide).
• You can modify the Orchid Recorder properties file (as described below).

*To perform this change, you will need to be signed in as an Administrator.

1. Open the Orchid Recorder properties file. (If you need help, refer back to the How to Edit a Configuration File section.)

2. Work with the package.config_mode property to enable or disable automatic updates. Applicable settings include the following:
   1. full-management: This setting will cause the operating system to automatically perform Orchid updates.
   2. disabled: This setting will disable the package management feature.

If you enable automatic updates, there are several other properties you may wish to set.

3. Add the package.choco.upgrade_scheduler.options property to set the schedule for when to automatically try and upgrade the ipc-orchid package. Note that this property uses the Microsoft Windows schtasks.exe utility, and permits the following options: /ST, /SC, /MO, /D, /M, /I, /SD, /ED, and /DELAY. Attempting to use options outside of this list may break unattended upgrades. Per the image below, our sample system is configured to try and upgrade ipc-orchid every Sunday at 1 AM (server time). Please refer to schtasks.exe documentation for more information. (Default: /ST 01:00 /SC WEEKLY /D /SUN)
4. Add the package.choco.repo.channel property to set the repository channel from which to download ipc-orchid NuGet packages, from an official IPConfigure-hosted server. (Default: production)
5. Add the package.choco.repo.source_location property to configure the NuGet source location for retrieving ipc-orchid packages. This value is not required, but is intended for use in situations where the NuGet repository setup does not permit channel configuration. Note that if you set this property, this value will take precedence over package.choco.repo.channel.
   

6. Save and close the file.
7. After you update the Orchid Recorder properties file, you must restart the Orchid Recorder services. (If you need extra help, refer back to the How to Manage the Orchid Recorder Services in Windows section.)
8. Once the restart is complete, you may return to Orchid Recorder.