This documentation is for the on-premise edition of 1Gateway. The SaaS edition is documented in the customer portal.

Requirements

Minimum installation requirements are:

  • Java 1.8
  • MySQL 8 
  • 2 CPU cores
  • 8GB RAM
  • 4GB free disk space

For a busy production system we recommend 16GB RAM and 4 CPU cores.

The UI is supported on Google Chrome and Firefox.

1Gateway is packaged in three different ways:

  • as a windows installer
  • as a zip file
  • as a Docker image

Docker installation

To install 1Gateway as a Docker container (including mysql), run this command (docker-compose.yaml is located in the 1Gateway Root Directory):

docker-compose up
BASH

For the next steps, jump to plugin and license installation 

Zip installation

To install 1Gateway from the zip file, simply extract the zip file to a folder of your choice and run the startup shell script. For the next steps, jump to plugin and license installation 

Windows installation 

As a user with administrator rights, run the Windows installer. The installer package for windows is called 1Gateway-2.3-[buildinfo].exe. 

Run 1Gateway-2.3-buildinfo.exe

If this window appears, click on Yes

Accept the EULA

Accept the 1Gateway EULA

Select folder

Next

Install

Click on "Install"

Watch progress

Pay close attention to the progress bar as it inches to completion

Finish

1Gateway is now installed and running as a service.

 

Log in to 1Gateway

Launch a browser, preferably Chrome, and navigate to http://your-1gateway-server:8090. Login as user admin, password admin.

Install plugins and licenses

Make sure you have the 1gateway zip file that includes the plugin files and valid licences information ready. This file has been provided to you with the installation files.

1 - Login

Login to 1gateway, and make sure you are in "Advanced mode". If this is the first time you log in, the default user and password are both 'admin' (without the quotes).

2 - System Maintenance

Click on the menu icon and choose the option "System maintenance"


3 - Upload file


In the System maintenance view you can either drag and drop the downloaded zip file or select it by clicking the "choose file" button.

4 - Restart

After the upload installation will be confirmed. Restart 1Gateway to ensure any locked files are updated.