GoAnywhere Gateway

Upgrade Guide
3.2.0
Copyright Terms and Conditions

Copyright © Fortra, LLC and its group of companies. All trademarks and registered trademarks are the property of their respective
owners.
The content in this document is protected by the Copyright Laws of the United States of America and other countries worldwide. The
unauthorized use and/or duplication of this material without express and written permission from Fortra is strictly prohibited. Excerpts and
links may be used, provided that full and clear credit is given to Fortra with appropriate and specific direction to the original content.
202409251039
Table of Contents

Upgrade GoAnywhere Gateway 5

Upgrade Process 5

Important Version Updates 6

3.2.0 Upgrade 6

Proxy Header Parsing 6

Gateway Server Configuration Encryption 6

Netty System Property 7

3.1.0 Upgrade 7

Remove the UseVMInterruptibleIO VM Option from gagateway and gagatewayd 7

System Requirements 8

Download the Upgrade File 10

License Prerequisite 11

Upgrading on Windows 13

Upgrading on Linux and UNIX 15

Upgrading on Docker 17

Miscellaneous Commands 18

Starting GoAnywhere Gateway 19

Stopping GoAnywhere Gateway 20

GoAnywhere Gateway Upgrade Guide www.goanywhere.com page: 3

Table of Contents

Downgrading GoAnywhere Gateway 21

page: 4 www.goanywhere.com GoAnywhere Gateway Upgrade Guide

 Upgrade GoAnywhere Gateway

Upgrade GoAnywhere
Gateway
This guide outlines the steps required for upgrading GoAnywhere Gateway to the latest
version.

Upgrade Process
An upgrade script (program) is available which will perform all the necessary steps to
upgrade GoAnywhere Gateway. Download the latest upgrade script by visiting the
GoAnywhere Customer Portal at https://my.goanywhere.com.

1. Verify you meet the minimum requirements for the upgrade.

2. Obtain the correct upgrade file.

3. Understand the License Prerequisite.

4. Follow the steps for the installed platform:

l Windows
l Linux/UNIX

GoAnywhere Gateway Upgrade Guide www.goanywhere.com page: 5

 Important Version Updates

Important Version Updates

3.2.0 Upgrade
Proxy Header Parsing
In Gateway 3.2.0 we added support for parsing version one and version two of the proxy
header. If enabled, this allows Gateway to provide the proper client IP address to
GoAnywhere MFT when traffic is routed through a load balancer. If you are operating
Gateway behind a load balancer and struggle to pass through the correct client IP address,
we suggest testing out these changes in a development environment.

For more information, please consult the GoAnywhere Gateway User Guide and review the
section for Reverse Proxy Element: proxyProtocol.

Gateway Server Configuration Encryption

As of Gateway 3.2.0, sensitive fields containing passwords in gateway.xml are now
automatically encrypted. Do not manually adjust the encrypted value unless you also set
the accompanying attribute to encrypted=false. This affects the following gateway.xml
elements:

l licenseProxy
l privateKeyStore
l server
l termination
l trustKeyStore

See the Gateway Server Configuration section in the GoAnywhere User Guide for more
information.

GoAnywhere Gateway Upgrade Guide www.goanywhere.com page: 6

Important Version Updates

Netty System Property

In Gateway 3.2.0, we added a new feature to improve performance on operating systems
that support epoll. We added a new system property com.fortra.netty.force.nio=true to
[installdirectory]/config/system.properties to ensure no change in behavior. We suggest
testing out the new performance improvement by removing the property if you are on an
operating system, such as Linux, that supports epoll.

3.1.0 Upgrade
NOTE: You must be on Gateway version 3.0.1 or greater to upgrade to Gateway 3.1.0.

The Gateway 3.1.0 release includes the following considerations:

Remove the UseVMInterruptibleIO VM Option from

gagateway and gagatewayd
If you are a Linux, IBMi, Unix, Solaris, or Mac OS X user, follow the steps below to remove
the UseVMInterruptibleIO from gagateway and bin/gagatewayd.

1. Go to your Gateway install directory, find the file named gagateway, and remove
the VM Option: -XX:-UseVMInterruptibleIO

2. Save the file.

3. Go to [installdirectory]/bin, where [installdirectory] is the installation directory for

Gateway.

4. Find the file named gagatewayd and remove the VM Option: -XX:-
UseVMInterruptibleIO

5. Save the file.

6. Restart Gateway for the changes to take effect.

page: 7 www.goanywhere.com GoAnywhere Gateway Upgrade Guide

 System Requirements

System Requirements
GoAnywhere Gateway installs to all popular enterprise server operating systems. Listed
below are the supported operating systems and minimum hardware/software requirements
for installing GoAnywhere Gateway.

Windows® (64-bit)

Versions Windows Server® 2012 R2

Windows Server® 2016

Windows Server® 2019

Windows Server® 2022

Windows 8®

Windows 10®

Windows 11®

Disk Space Usage 100 MB

Minimum Memory 256 MB

Linux® (64-bit)

Disk Space Usage 100 MB

Minimum Memory 256 MB

GoAnywhere Gateway Upgrade Guide www.goanywhere.com page: 8

System Requirements

All other UNIX Platforms (AIX, HP-UX, Solaris, Mac OS X)

Disk Space Usage 50 MB

Minimum Memory 256 MB

JRE (Java Runtime 11 must be installed prior to the installation.

Environment)

Docker

Disk Space Usage 50 MB

Minimum Memory 256 MB

Docker l Docker 18.09.1 or higher.

l Docker Compose 1.23.2 or higher (optional).

NOTE:
Docker Compose is included by default with Docker
Desktop for Windows. It is a separate install for
Mac and Linux.

page: 9 www.goanywhere.com GoAnywhere Gateway Upgrade Guide

 Download the Upgrade File

Download the Upgrade

File
The GoAnywhere Customer Portal is where you can create support requests, check the
status of a support case, download software updates and documentation, and manage
your Gateway license. You must create an account in order to use the portal.

The portal can be accessed by using your internet browser and navigating to
https://my.goanywhere.com

Depending on how many versions behind your GoAnywhere Gateway install is, you may
need to repeat the upgrade process until you are upgraded to the current version of 3.2.0.

Installed Version Upgrade Version

1.0.0 - 2.6.1 Upgrade to GoAnywhere Gateway 2.7.0 using the gagateway_

upgrade2_7_0.jar that is available on the Customer Portal.

2.7.0 - 3.0.1 Upgrade to GoAnywhere Gateway 3.0.1 by downloading the

gagateway_upgrade3_0_1.jar from the customer portal.
Place the JAR in the upgrader folder and run the required
update script.

GoAnywhere Gateway Upgrade Guide www.goanywhere.com page: 10

 License Prerequisite

License Prerequisite
If you are upgrading GoAnywhere Gateway from version 2.2.0 or earlier, a new license key
is required. The license key is issued through the GoAnywhere Customer Portal.

During the upgrade, you will be presented with a base 64 encoded license bundle
(example below) that will be used to upgrade your existing license. Follow the instructions
to activate your license.

Once your license is activated on the Customer Portal, download the license to your
workstation by clicking the Download button. You can also download the license at any
time by expanding the Active license row and clicking the Download button under the
license key.

Once the gateway.lic file is downloaded, copy the file to the installation directory on the
GoAnywhere Gateway server that produced the license activation request.

Windows Example
l Installation Directory: C:\Program Files\HelpSystems\GoAnywhere Gateway
l License File Location: C:\Program Files\HelpSystems\GoAnywhere
Gateway\gateway.lic

GoAnywhere Gateway Upgrade Guide www.goanywhere.com page: 11

License Prerequisite

Linux/Unix Example
l Installation Directory: /usr/local/HelpSystems/GoAnywhere_Gateway
l License File Location: /usr/local/HelpSystems/GoAnywhere_Gateway/gateway.lic

Docker Instructions
l Copy the license key into the target Docker container, into the correct directory,
using the command: docker cp gateway.lic <container id or
name>:/usr/local/HelpSystems/GoAnywhere_Gateway/.

Once the license has been placed in the correct installation directory, you must stop and
then start the GoAnywhere Gateway service.

The activated license exclusively belongs to the GoAnywhere Gateway installation that
produced the activation request. It cannot be used to upgrade or run any other install of
GoAnywhere Gateway.

page: 12 www.goanywhere.com GoAnywhere Gateway Upgrade Guide

 Upgrading on Windows

Upgrading on Windows
Before you begin, we recommend creating backups or VM snapshots of any GoAnywhere
MFT or Gateway servers. Consider testing an upgrade in your development environment
prior to upgrading your production environment.

Perform the following steps as an administrator to upgrade GoAnywhere Gateway running

on a Windows server.

1. Download the gagateway_upgrade3_2_0.jar from the Customer Portal at

https://my.goanywhere.com. If your browser renames the extension to .zip, rename
the extension to .jar.

2. Remove the version number from the file name (for example, gagateway_
upgrade3_2_0.jar would be renamed to gagateway_upgrade.jar).

3. Copy the upgrade file from the download location to the Windows system where
GoAnywhere Gateway is installed. The location to copy the file is [Install
Directory]\upgrader. The default installation directory is C:\Program
Files\HelpSystems\GoAnywhere Gateway.

4. Stop the GoAnywhere Gateway service.

5. Open a Command windows as an Administrator.

NOTE:
You must run the Command Prompt window as administrator to run the Upgrade.bat
file.

GoAnywhere Gateway Upgrade Guide www.goanywhere.com page: 13

Upgrading on Windows

6. Change the directory to the [Install Directory]\upgrader folder where GoAnywhere

Gateway is installed.

7. Run the upgrade.bat file to perform the upgrade. A message on the screen
confirms the upgrade success.

If you are upgrading from GoAnywhere Gateway 2.2.0 or earlier, you will be
presented with a License Activation request (see License Prerequisite ). Use this
request to activate and install your GoAnywhere Gateway license. Once installed,
run the upgrade again.

8. Start the GoAnywhere Gateway service. Verify the connection to GoAnywhere

Gateway is reestablished in GoAnywhere MFT.

The GoAnywhere Gateway connection in GoAnywhere MFT does not need to be

disconnected while the upgrade is performed. GoAnywhere MFT will reconnect to
GoAnywhere Gateway when the service is restarted.

page: 14 www.goanywhere.com GoAnywhere Gateway Upgrade Guide

 Upgrading on Linux and UNIX

Upgrading on Linux and

UNIX
Before you begin, we recommend creating backups or VM snapshots of any GoAnywhere
MFT or Gateway servers. Consider testing an upgrade in your development environment
prior to upgrading your production environment.

Perform the following steps as a root user to upgrade GoAnywhere Gateway running on a
Linux or UNIX-based platform.

1. Download the gagateway_upgrade3_2_0.jar from the Customer Portal at

https://my.goanywhere.com. If your browser renames the extension to .zip, rename
the extension to .jar.

2. Remove the version number from the file name (for example, gagateway_
upgrade3_2_0.jar would be renamed to gagateway_upgrade.jar).

3. Copy the upgrade file from the download location to the Windows system where
GoAnywhere Gateway is installed. The location to copy the file is [Install
Directory]\upgrader. The default installation directory is
/usr/local/HelpSystems/GoAnywhere_Gateway.

4. Stop the GoAnywhere Gateway service.

5. Change from the working directory to the upgrader folder, located in the
GoAnywhere Gateway installation folder. For example:
/usr/local/HelpSystems/GoAnywhere_Gateway/upgrader.

6. From a terminal screen, run the ./upgrade.sh script to perform the upgrade. A
message on the screen confirms the upgrade success.

If you are upgrading from GoAnywhere Gateway 2.2.0 or earlier, you will be
presented with a License Activation request (see License Prerequisite ). Use this
request to activate and install your GoAnywhere Gateway license. Once installed,
run the upgrade again.

GoAnywhere Gateway Upgrade Guide www.goanywhere.com page: 15

Upgrading on Linux and UNIX

7. Change the working directory back to /etc/init.d or wherever the GoAnywhere

Gateway service executable is located.

8. Start the GoAnywhere Gateway service. Verify the connection to GoAnywhere

Gateway is reestablished in GoAnywhere MFT.

The GoAnywhere Gateway connection in GoAnywhere MFT does not need to be

disconnected while the upgrade is performed. GoAnywhere MFT will reconnect to
GoAnywhere Gateway when the service is restarted.

page: 16 www.goanywhere.com GoAnywhere Gateway Upgrade Guide

 Upgrading on Docker

Upgrading on Docker
Use the following instructions to upgrade GoAnywhere Gateway on Docker. Be sure to
complete each step before proceeding:

1. Sign into the GoAnywhere MFT browser-based Administrator and verify that there
are no critical operations underway before proceeding with the Docker upgrade.

2. Backup GoAnywhere Gateway Docker volumes.

3. Pull the latest GoAnywhere Gateway Docker image.

l If using Docker Compose (recommended), use the following command:
docker-compose pull
l If not using Docker Compose, use the following command: docker pull
helpsystems/goanywhere-gateway:latest

NOTE:

If not using Docker Compose, you'll need to copy the license from the old
container or host machine into the new directory, using the command:
docker cp gateway.lic <container id or
name>:/usr/local/HelpSystems/GoAnywhere_Gateway/.
Alternatively, you can re-download and apply the license. See the
GoAnywhere Gateway User Guide for details.

4. Restart GoAnywhere Gateway container.

l If using Docker Compose (recommended), use the following command:
docker-compose up -d
l If not using Docker Compose, use the following commands:
docker stop <container name>

docker rm <container name>

docker run <options> <image>

GoAnywhere Gateway Upgrade Guide www.goanywhere.com page: 17

 Miscellaneous Commands

Miscellaneous Commands
Display GoAnywhere Gateway's Version

Perform the following steps to display the installed version of GoAnywhere Gateway:

1. Open a Command window or Terminal.

2. Change the directory to the installation directory.

3. Run the command ./gagateway version

Display the License Information

Perform the following steps to display the license information:

1. Open a Command window or Terminal.

2. Change the directory to the installation directory.

3. Run the command ./gagateway license. If a license is already installed, the

license information will be displayed on the console. If no license is installed,
information needed to request a license is displayed.

Display Java Runtime Environment (JRE) Configuration

Perform the following steps to display the JRE configuration:

1. Open a Command window or Terminal.

2. Change the directory to the installation directory.

3. Run the command ./gagateway jvmconfig

GoAnywhere Gateway Upgrade Guide www.goanywhere.com page: 18

 Starting GoAnywhere Gateway

Starting GoAnywhere
Gateway
The instructions for starting GoAnywhere Gateway depends on the operating system.
Perform the steps in the appropriate section to start GoAnywhere Gateway.

Windows
1. Log in to the target Windows system where GoAnywhere Gateway is installed.

2. Open the Services window from the Control Panel.

3. Right-click the GoAnywhere Gateway service in the Services window.

4. Click Start from the context menu.

Linux and UNIX

1. Log in to the target Linux/UNIX system where GoAnywhere Gateway is installed.

2. Open a Terminal window.

3. If your system supports systemd, execute the command systemctl start

gagatewayd Otherwise, execute the command /etc/init.d/gagatewayd
start

Docker

Starting the Docker container where GoAnywhere Gateway is installed will also start
GoAnywhere Gateway.

1. Ensure Docker is running.

2. Execute docker start <container id or name> or docker-compose

start from inside the directory containing the docker-compose.yml file.

GoAnywhere Gateway Upgrade Guide www.goanywhere.com page: 19

 Stopping GoAnywhere Gateway

Stopping GoAnywhere
Gateway
The instructions for stopping GoAnywhere Gateway depends on the operating system.
Perform the steps in the appropriate section to stop GoAnywhere Gateway.

Windows
1. Log in to the target Windows system where GoAnywhere Gateway is installed.

2. Open the Services window from the Windows Control Panel.

3. Right-click the GoAnywhere Gateway service in the Services window.

4. Choose Stop from the context menu.

Linux and UNIX

1. Log in to the target Linux/UNIX system where GoAnywhere Gateway is installed.

2. Open a Terminal window.

3. If your system supports systemd, execute the command systemctl stop

gagatewayd Otherwise, execute the command /etc/init.d/gagatewayd
stop

Docker
1. Determine the container name or ID.

2. Execute docker stop <container id or name> or docker-compose

stop from inside directory containing docker-compose.yml file.

GoAnywhere Gateway Upgrade Guide www.goanywhere.com page: 20

 Downgrading GoAnywhere Gateway

Downgrading
GoAnywhere Gateway
When an upgrade is performed, the upgrade process makes a backup of folders and files
that are changed during upgrade. These files are placed in
[installfolder]/backups/backup_[fromVersion]_[toVersion] (where [installfolder] is the
location where GoAnywhere Gateway is installed).

The backup folder names contain the existing and new version numbers of GoAnywhere
Gateway. For example, the 'backup_301_to_ 310' folder contains the files that were
backed up when GoAnywhere Gateway was upgraded from version 3.0.1 to version 3.1.0.

NOTE: If the upgrade fails before the backup directory is successfully created, then no
changes will be made and you can restart GoAnywhere Gateway.

The upgrade creates an upgrade log, which displays the location of the backup folder.
Example of the upgrade log:

Installed Version: 3.0.1

Upgrading to: 3.1.0
Checking the server status...
GoAnywhere Gateway appears to be down. Okay to upgrade.
Backing up currently installed files
Created the backup directory: C:\Program
Files\HelpSystems\GoAnywhere_Gateway\backups\backup_301_to_310

When the rollback is performed. The rollback returns GoAnywhere Gateway to the state it
was just before the upgrade was performed. If the new version of GoAnywhere Gateway is
deemed unfit, a rollback can be performed using the following steps:

GoAnywhere Gateway Upgrade Guide www.goanywhere.com page: 21

Downgrading GoAnywhere Gateway

1. Stop the GoAnywhere Gateway service.

2. Make a copy of the [installfolder] for archive purposes.

3. To ensure no library conflicts are introduced during the rollback, delete the
contents of [install_dir]/lib

4. Navigate to the backup folder and perform the following for each folder:

a. If the folder exists in the [install_dir]/backups folder, delete the

corresponding folder in the install directory.

b. Copy the folder from the backup directory to the install directory.

c. If folders exist in the backup folder that do not exist in the install folder, copy
them to the install folder.

5. Any individual files in the backup folder not contained in a folder should also be
copied to the install folder.

6. Reverse any steps taken to upgrade to Java if applicable.

7. Ensure the user profile used to start GoAnywhere Gateway has ownership
authority to the restored files. Unix/Linux systems, ensure the user profile used to
start GoAnywhere has execute permission to all shell scripts (*.sh).

8. Start the GoAnywhere Gateway service.

page: 22 www.goanywhere.com GoAnywhere Gateway Upgrade Guide