3. Installation

3.1 Import OVA

You can either import the OVA file manually through the VMWare web interface or deploy it using a console tool.

Manual OVA deployment

1. Go to VMWare web interface,
2. Click the “Create / Register VM” button to create a new virtual machine,
3. On step 1, choose “Deploy a virtual machine from an OVF or OVA file”,
4. Choose the file downloaded from the link you got from us at #2,
5. Keep clicking Next with more or less default parameters until you get to the step named “Additional settings”,
6. Set the required parameters (for more information, check section 3.2):
   1. Gateway URL: the URL of your future Remotix server (please stick to HTTP scheme until you set up TLS on step 4),
   2. Hub name: name of your Remotix server to be shown in Remotix Hub,
   3. Maintenance page port: port to access the Remotix server’s maintenance page to finish the configuration process (8080 by default),
   4. Maintenance page user: username to access the maintenance page,
   5. Maintenance page password: password to access the maintenance page,
   6. OS root user password: password for the root user to access the VM operating system,
7. Click “Finish”.

Deploy with ovftool

If you have OVF Tool installed, you can also deploy the virtual machine by executing the following command in the console:

ovftool \
--allowExtraConfig \
--extraConfig:guestinfo.rxgw_base_url="https://rxgw.example.com" \
--extraConfig:guestinfo.rxgw_hub_name="Camomile Ltd." \
--extraConfig:guestinfo.rxgw_maint_port="8080" \
--extraConfig:guestinfo.rxgw_maint_user="maint" \
--extraConfig:guestinfo.rxgw_maint_pass="m@1nt_p@ssw0rd" \
--extraConfig:guestinfo.os_root_pass="TheNewSecretP@ss" \
rxgw-onpremise-XX-vapp.ova \
vi://{{ EXSi_username }}:{{ ESXi_password }}@{{ ESXi_address }}

At the first boot of the guest OS, the configurator script will read OVF properties and configure the Gateway accordingly.

Note that all the placeholders shown in bold should be replaced with the correct info.

Next ⟶

3.2 Advanced settings

If you prefer having your virtual machine with as many parameters already set as possible, you may modify step 3.1 with some of the parameters listed here.

Available parameters and respective property names:

Required parameters

• Hub base URL (rxgw_base_url)
  FQDN (preferably) or IP (not recommended + will not work with https). Should also include the scheme (http or https).
  The server uses this URL to generate all Hub-related links. It also serves as a server name for the front proxy and a base address to generate endpoints for the tunnel.
• Hub site title (rxgw_hub_name)
  Your Remotix Gateway custom title. It will show up on all Hub-related pages.
• Maintenance page port (rxgw_maint_port)
  Port to access the Remotix server’s maintenance page where you change any server parameters and set some that are not available here, including licensing and TLS. The maintenance page i
• Maintenance page user (rxgw_maint_user)
• Maintenance page pass (rxgw_maint_pass)
  Maintenance page access credentials
• Guest OS root pass (os_root_pass)
  The configurator will change the root user password to the provided value.

Optional parameters

Currently only mailing-related optional parameters are accepted:

• SMTP server address (rxgw_smtp_server)
• SMTP FROM address (rxgw_smtp_from)
• SMTP username (rxgw_smtp_username)
• SMTP password (rxgw_smtp_password)
• SMTP use TLS (rxgw_smtp_use_tls)

The meaning of these parameters is described in #4.3 (setting mailing on the maintenance page).

Next ⟶