Splashtop Gateway upgrade is simple, smooth and straightforward. It can be achieved by directly running the installer, without the need of re-configuring the license and system environment.
To upgrade the Splashtop Gateway, follow the steps below:
- Backup existing Gateway data
- Download the installer
- Execute the installer
- Start the service
1. Backup existing Gateway data
To backup the existing Gateway data, the owner account must be used to log into the Splashtop Gateway Web Portal.
Go to System > Maintenance > Backup.
Click the Backup Now button, and follow the instructions to complete the task.
The backup zip file contains the installers of all endpoints, so its size will be a bit bulky.
2. Download the installer
The latest official release of Splashtop Gateway can be downloaded from our support portal, or click the link below:
Save the MSI format installer file into the machine where Splashtop Gateway is installed.
3. Execute the installer
Log into the server machine as Windows administrator. It is always advised to use an admin account to run the installer.
Browse to the folder where the MSI installer file is saved, and double click the file to initiate the upgrade process.
A setup wizard will be launched to guide through the upgrade. Follow the instructions as usual, read and accept the terms in the License Agreement.
Once you click button, the installer will start the installation process. This install usually takes less than a minute to complete.
4. Start the Gateway service
Click Launch Splashtop Gateway Web Portal.
In case of failing to open the portal, it is likely caused by the Gateway service. Click Start Splashtop Gateway Service to start it.
Now you are ready to log into Splashtop On-Prem management console using an Administrator account. Old configuration from previous version, such as Users, Computers, Groups, License and System Configuration, should all be retained and can be managed in the console.
- Before upgrading/rollback, please always backup existing Gateway. In case anything goes wrong you can restore to existing version.
- Run the MSI directly to upgrade Gateway. During the upgrade, existing sessions will be disconnected. After MSI finished installing, Streamers will reconnect to Gateway. With regular deployment size of up to a few hundred streamers, the reconnect process should not exceed 20 minutes. If you have number of Streamers in the thousands range, it is possible the reconnect process can take up to 2 hours.
- After upgrade finishes, give it 1 minute to init database, before launching Web Console. When you launch Web Console you should see the login screen. If you see OOBE web pages (that is, asking to accept EULA, set Database password and team owner, etc.), please restart Splashtop Gateway Service and reconnect to Web Console. DO NOT set DB password / team owner again.
- Please consider set aside system down time for the upgrade, if you need to inform end users. Upgrade with regular size deployment usually takes less than an hour and large size (3000+ Streamers) may take up to 3 hours for the whole process to complete.
- If you would like to rollback Splashtop Gateway to a previous version, please refer to this article article.