# Upgrading to newer versions
Follow the instructions below for upgrading an existing agent:
# Windows
- Open Workato and go to your on-prem group page (opens new window).
- Open your on-prem group and find the agent that you want to upgrade. Check current agent version and click on
Update to <latest_agent_version>
.
Update on-prem agent to latest version
- The upgrade wizard will open. Check the release notes and follow the steps in the wizard, which are also mentioned below.
On-prem agent upgrade wizard
- Verify that the agent is stopped (either terminate Workato Agent Windows service or console-based agent)
- Uninstall the agent (for example, Start Menu → Workato → Uninstall). This should not change the
config.yml
file and the certificate files (cert.key
,cert.pem
) inC:\Program Files\Workato Agent/conf
. - Run the downloaded installer (this will automatically install to the same location)
- Run the agent. Depending on the setup, either start Workato Agent Windows service or run the agent from command line.
- Make sure your agent is active and verify its version number on the on-prem agent page (opens new window).
# Linux/MacOS
- Verify that the agent process is stopped. The upgrade will fail if any running agents are detected.
- Navigate to the agent directory (for example,
cd ~/programs/workato-agent/
). Do not navigate further into the/bin/
directory. - Run the upgrade script:
bin/upgrade.sh
. Make sure you have enough permissions. - Follow the instructions provided by the upgrade script. Confirm the upgrade when prompted.
- Upon successful completion of the upgrade, run the agent (for example,
bin/run.sh
). - Make sure your agent is active and verify its version number on the on-prem agent page (opens new window).
- The upgrade process is not triggered if no new versions are available. However, it might be necessary to repair a broken installation; in that case use the command line option when running the upgrade:
bin/upgrade.sh --force
.
# Troubleshoot
- For Linux/MacOS users, if you have anaconda installed on your terminal, be sure to deactivate any conda environments with
conda deactivate
as it will cause an error when upgrading. - On-prem agent versions
2.11.0
and newer are using latest Workato gateways. If you are upgrading from version older than2.11.0
make sure that you whitelist the new gateway IPs.