Installation & Licensing

Installation

The installation of GAMS Engine highly depends on your setup. When you purchase GAMS Engine, you will receive a ZIP file that contains everything you need to get started including installation instructions tailored to your setup. The general installation instructions are given below.

  • Install Docker from https://docs.docker.com/engine/install/. Start docker afterwards.
  • Install Docker Compose from https://docs.docker.com/compose/install/
  • Extract gams_engine.zip file into a folder
  • Open a terminal and cd into that folder
  • Run the script ./up.sh with admin privileges. The following arguments can be used:
    • -p: Engine port
      Specifies the port through which you want to reach Engine. This works only for the non-SSL (unencrypted) setup.
    • -w: Number of workers
      Specifies how many GAMS workers should be enabled.
    • -c: Certificate file
      For the SSL setup, the path to the certificate file must be specified here.
    • -k: Certificate key file
      For the SSL setup, the path to the certificate key file must be specified here.
      Note:

      Note that when using the encrypted setup, port 80 and port 443 must be available!

    The script downloads and initializes all required Engine files. This may take a moment.

  • Once the script is finished, GAMS Engine should be running. Depending on whether an SSL or an unencrypted setup has been selected, Engine and Engine UI can be reached via:
    • SSL setup: Open http(s)://mydomain.com in your browser (replace mydomain with your URL).
    • Unencrypted setup: Engine runs on the port you selected before (default is port 80). Open http://192.168.178.184:80 in your browser (replace IP and port accordingly).

    • This will open the Engine UI. Login with the default credentials username: admin and password: admin.

  • Install Docker from https://docs.docker.com/engine/install/. Start docker afterwards.
  • Extract gams_engine.zip file into a folder
  • Open a terminal and cd into that folder
  • Run the script .\up.cmd. The following arguments can be used:
    • \p: Engine port
      Specifies the port through which you want to reach Engine. This works only for the non-SSL (unencrypted) setup.
    • \w: Numer of workers
      Specifies how many GAMS workers should be enabled.
    • \c: Certificate file
      For the SSL setup, the path to the certificate file must be specified here.
    • \k: Certificate key file
      For the SSL setup, the path to the certificate key file must be specified here.
      Note:

      Note that when using the encrypted setup, port 80 and port 443 must be available!

    The script downloads and initializes all components required for GAMS Engine. This may take a moment.

  • Once the script is finished, GAMS Engine should be running. Depending on whether the SSL or the unencrypted setup has been selected, Engine and Engine UI can be reached via:
    • SSL setup: Open http(s)://mydomain.com in your browser (replace mydomain with your URL).
    • Unencrypted setup: Engine runs on the port you selected before (default is port 80). Open http://192.168.178.184:80 in your browser (replace IP and port accordingly).

    • This will open the Engine UI. Login with the default credentials username: admin and password: admin.

Licensing

For a GAMS Engine setup, both a tailored GAMS license and an Engine license are required. The license keys can be entered directly in the Engine UI in the Users section by clicking on the corresponding buttons. For the Engine license, click on the Update Engine license button at the top of the page and enter the key.

Providing Engine and GAMS license keys

A GAMS license can be specified system-wide or user-specific.

  • System-wide means that all users of the running Engine instance use the same license when solving their GAMS models. The system-wide license can be entered at the top of the page via the Update GAMS license button, right next to the Update Engine license button.
  • A user-specific GAMS license is only valid for the individual owners of the license. If a user has such a license, this will always be used for GAMS jobs instead of the system-wide license. Also, if an inviter with such a license invites another person to use GAMS Engine, the invitee automatically inherits the license of the inviter.
    User licenses are entered in the user list under Actions → Update license.