Skip to content
Disguise User Guide

Installation Instructions

Instructions

Installation and Update instructions must be run for each machine running Porta On-Prem.

See Also

Requirements Before Installation

Please work with IT to ensure the machines are set up on the same network before beginning the installation process.

Please ensure that the machine has been prepared beforehand: Initial Machine Setup

Installing Porta on Prem

This process covers installing on a new machine, or running a fresh install for an existing installation so that it is wiped. For steps on updating an existing installation, see Update Existing Installation below.

  1. Make sure Docker is running.

  2. Transfer the porta-onprem-bundle.zip archive to the Desktop of machine being installed.

  3. Right-click and extract the files to the Desktop.

  4. Open the unzipped porta-onprem-bundle folder and navigate to the porta-helpers folder.

    This folder contains the install and update scripts that will be used to install and update Porta on Prem, as well as the database folder which contains the helper scripts for running database operations.

  5. Right-click on install.bat and choose “Run as Administrator” to begin the installation process.

  6. When prompted, enter the sudo password for Ubuntu (WSL) and press Enter.

  7. When you are prompted about database replication, type y and press enter (even if you are only running one machine)

  8. When prompted, enter the Porta machine type. This would be main, backup, or arbiter, depending on which machine you are currently working with.

  9. When prompted, enter or confirm the Porta machine IP

  10. If prompted, enter the IP for the other Porta machines

  11. If you are installing for the FIRST TIME ONLY, or are re-installing after a failed attempt, and have not used Porta yet, then confirm that you would like to wipe the database with “y`

  12. Wait for the installation to continue. It can take up to 10 minutes for the installer to prompt you again. If an unexpected error occurs, the process will be aborted.

    • You may be prompted with gzip: porta-images.tar already exists; do you wish to overwrite (y or n)? — type y and press enter to continue

    It is normal to see the error message Error occurred in command: 'xargs docker rmi' after Error response from daemon: conflict: unable to delete 143f1a610ec2 (must be forced) - image is being used by stopped container, installation will not be aborted.

  13. When the install is nearing completion, you will be prompted with Should this database be bootstrapped?. If this is the first and only machine with Porta installed, type y and press Enter. If another machine is already running Porta, type n and press Enter.

  14. When the installation is complete, you will see a message that the installation was successful, and shortcuts to Porta on Prem and the Porta on Prem backup will be created on the desktop.

  15. You can double-check the version of Porta that was just installed by navigating to porta-onprem-bundle/porta-helpers/porta-checks and double-clicking on check-version.bat.

  16. If this was the main machine, repeat steps 1-16 on the back-up machine

    • Be sure to wait for the main machine to finish installing before starting the backup machine; the main machine database must be running before the backup machine’s database can be set up.

  17. If this was the backup machine, repeat steps 1-16 on the arbiter machine

    • Be sure to wait for the main and backup machines to finish installing before starting the arbiter machine; the other databases must be running before the arbiter machine’s database can be set up.

  18. See Porta Integrations Setup to set up the Porta Bridge and Unreal plugins (if applicable)

Update Existing Installation

  1. On the desktop, if there is an existing porta-onprem-bundle.zip, rename it to porta-onprem-bundle-old.zip.

  2. On the desktop, open the existing porta-onprem-bundle folder, navigate to the porta-helpers folder, and move the conf folder to the desktop.

    This folder contains the configuration files for the Porta on Prem installation and we can avoid inputting machine info if we use it with the new installation.

  3. Follow steps 1 through 4 in the #Installing-Porta-On-Prem section above (they are the same for updates and new installs).

  4. After doing installation steps 1-4 from the #Installing-Porta-On-Prem section, in the porta-helpers folder,navigate to the porta-database folder, then actions, and double-click on create-backup.bat to create a backup of the database before updating.

    Updating Porta on Prem will not overwrite the database, but it is always a good idea to have a backup before making changes.

  5. In the porta-helpers folder, right-click on update.bat and choose “Run as Administrator” to begin the update process.

  6. When prompted, enter the sudo password for Ubuntu (WSL) and press Enter.

  7. When you are prompted about database replication, type y and press Enter (even if you are only running one machine)

  8. When prompted, enter the Porta machine type. This would be main, backup, or arbiter, depending on which machine you are currently working with.

  9. When prompted, enter or confirm the Porta machine IP.

  10. If prompted, enter the IP for the other Porta machines.

  11. Wait for the update to continue. It can take up to 10 minutes for the update to prompt you again. If an error occurs, the process will be aborted.

    • You may be prompted with gzip: porta-images.tar already exists; do you wish to overwrite (y or n)? — type y and press Enter to continue.

    Note: Error occurred in command: 'xargs docker rmi' after Error response from daemon: conflict: unable to delete 143f1a610ec2 (must be forced) - image is being used by stopped container will not abort, this is normal.

  12. When the update is nearing completion, you will be prompted with Should this database be bootstrapped?. The answer will depend on the current state of the database replication group. We can check this by navigating to porta-onprem-bundle/porta-helpers/porta-database and double-clicking on view-ALL-group-repl-status.bat. This should print status entries from each machine in the group.

    • If the resulting output shows any entries with MEMBER_STATE of ONLINE and MEMBER_ROLE of PRIMARY, then the group is already bootstrapped and the answer should be “n`.
    • If the resulting output shows all entries with MEMBER_STATE of OFFLINE, then it is safe to bootstrap this machine and the answer should be “y`.
    • In all other cases, the answer should be “n`.

      • If you are still unsure how to proceed please choose n and contact support.

    • This output should look something like:
    Terminal window
    "Viewing group replication status as reported by PORTA-DB..."
    +---------------------------+--------------------------------------+----------------+-------------+--------------+-------------+----------------+----------------------------+
    | CHANNEL_NAME              | MEMBER_ID                            | MEMBER_HOST    | MEMBER_PORT | MEMBER_STATE | MEMBER_ROLE | MEMBER_VERSION | MEMBER_COMMUNICATION_STACK |
    +---------------------------+--------------------------------------+----------------+-------------+--------------+-------------+----------------+----------------------------+
    | group_replication_applier | 1a351ce3-ba19-11ee-9e59-0242ac120002 | 192.168.50.163 |        3306 | ONLINE       | PRIMARY   | 8.0.32         | XCom                       |
    | group_replication_applier | d7c0535c-ba19-11ee-9f28-0242ac140002 | 192.168.50.20  |        3307 | ONLINE       | SECONDARY   | 8.0.32         | XCom                       |
    | group_replication_applier | e4a0ac63-ba19-11ee-9f54-0242ac150002 | 192.168.50.42  |        3308 | ONLINE       | SECONDARY     | 8.0.32         | XCom                       |
    +---------------------------+--------------------------------------+----------------+-------------+--------------+-------------+----------------+----------------------------+
    

    "Viewing group replication status as reported by PORTA-DB-2..."
    +---------------------------+--------------------------------------+----------------+-------------+--------------+-------------+----------------+----------------------------+
    | CHANNEL_NAME              | MEMBER_ID                            | MEMBER_HOST    | MEMBER_PORT | MEMBER_STATE | MEMBER_ROLE | MEMBER_VERSION | MEMBER_COMMUNICATION_STACK |
    +---------------------------+--------------------------------------+----------------+-------------+--------------+-------------+----------------+----------------------------+
    | group_replication_applier | 1a351ce3-ba19-11ee-9e59-0242ac120002 | 192.168.50.163 |        3306 | ONLINE       | PRIMARY   | 8.0.32         | XCom                       |
    | group_replication_applier | d7c0535c-ba19-11ee-9f28-0242ac140002 | 192.168.50.20  |        3307 | ONLINE       | SECONDARY   | 8.0.32         | XCom                       |
    | group_replication_applier | e4a0ac63-ba19-11ee-9f54-0242ac150002 | 192.168.50.42  |        3308 | ONLINE       | SECONDARY     | 8.0.32         | XCom                       |
    +---------------------------+--------------------------------------+----------------+-------------+--------------+-------------+----------------+----------------------------+
    

    "Viewing group replication status as reported by PORTA-DB-3..."
    +---------------------------+--------------------------------------+----------------+-------------+--------------+-------------+----------------+----------------------------+
    | CHANNEL_NAME              | MEMBER_ID                            | MEMBER_HOST    | MEMBER_PORT | MEMBER_STATE | MEMBER_ROLE | MEMBER_VERSION | MEMBER_COMMUNICATION_STACK |
    +---------------------------+--------------------------------------+----------------+-------------+--------------+-------------+----------------+----------------------------+
    | group_replication_applier | 1a351ce3-ba19-11ee-9e59-0242ac120002 | 192.168.50.163 |        3306 | ONLINE       | PRIMARY   | 8.0.32         | XCom                       |
    | group_replication_applier | d7c0535c-ba19-11ee-9f28-0242ac140002 | 192.168.50.20  |        3307 | ONLINE       | SECONDARY   | 8.0.32         | XCom                       |
    | group_replication_applier | e4a0ac63-ba19-11ee-9f54-0242ac150002 | 192.168.50.42  |        3308 | ONLINE       | SECONDARY     | 8.0.32         | XCom                       |
    +---------------------------+--------------------------------------+----------------+-------------+--------------+-------------+----------------+----------------------------+

  13. If the database has not been bootstrapped, you will be prompted with Should the database be migrated?. If this is the final machine being updated, and no machines have been bootstrapped during their update process, type y and press enter. Otherwise, press Enter to confirm n.

  14. If the database has not been bootstrapped, you will be prompted with Should the database be seeded?. If you have not been instructed to seed for this update, type or confirm n. Otherwise, if this is the final machine being updated, and no machines have been bootstrapped during their update process, type y and press Enter. Otherwise, type n and press Enter.

  15. When the update is complete, you will see a message that the installation was successful.

  16. You can double-check the version of Porta that was just installed by navigating to porta-onprem-bundle/porta-helpers/porta-checks and double-clicking on check-version.bat.

  17. If Porta is open in a browser, refresh the page to load the update.

  18. If this was the main machine, repeat steps 1-14 on the backup machine

    • Be sure to wait for the main machine to finish installing before starting the backup machine; the main machine database must be running before the backup machine’s database can be set up

  19. If this was the backup machine, repeat steps 1-14 on the arbiter machine

    • Be sure to wait for the main and backup machines to finish installing before starting the arbiter machine; the other databases must be running before the arbiter machine’s database can be set up.

  20. If applicable, update your Porta Bridge and Unreal plugins configurations. See Porta Integrations Setup below for details.

Porta Integrations Setup

Porta Bridge

  1. Run the Bridge as Administrator.
  2. Fill out the D3 Connection Configuration.
  3. Before hitting the Start button, go to the menu Window > Porta.
  4. Make sure the Socket Server URL is http://porta-socket.server:6001
  5. Make sure the API URL is http://<PORTA-MACHINE-IP>:6001
    • Replace <PORTA-MACHINE-IP> with the IP address of the current machine running Porta
  6. Make sure the Http Listener IP Address is <BRIDGE-MACHINE-IP>
    • Replace <BRIDGE-MACHINE-IP> with the IP address of the machine running the Bridge.
    • This is likely the same as the Porta machine IP if the Bridge is running on the same machine as Porta
  7. Go to Window > D3 and hit the Start button to connect Porta to D3.

Unreal Plugin

Locally

If Unreal is running locally on the same machine as Porta on Prem, the Unreal plugin should be set up with the following:

  • Connection URL: http://porta-socket.server:6001
  • API URL: http://<PORTA-MACHINE-IP>:8000
    • Replace <PORTA-MACHINE-IP> with the IP address of the current machine running Porta.

Externally

If Unreal is running on different machine than Porta on Prem, the Unreal setup is slightly different.

  1. On the Unreal machine, open the hosts file as administrator in Windows (Located in C:\Windows\System32\drivers\etc)
    • This is often most easily done by opening the start menu and typing notepad to search for the Notepad application
    • Right-click the Notepad application and select “Run as administrator”
  2. Copy & paste the following entries at the bottom of the hosts file and replace each <XXXXXXX MACHINE IP> with the appropriate machine IPs. Save the hosts file as type All files (*.*) (it should have NO file extension). 
    <PORTA MACHINE IP> porta.server

The Unreal plugin should then be set up with the following:

  • Connection URL: http://porta.server:6001
  • API URL: http://porta.server:8000

Access Porta in Chrome

Use the “Main Company” and check the Socket Server URL to ensure the socket server is set to http://<PORTA-MACHINE-IP>:6001, NOT http://porta-socket.server

Default Login Credentials:

  • email: superadmin@disguise.one

Be sure to access Porta in the browser using its machine IP, NOT localhost

Porta: http://<PORTA-MACHINE-IP>:8080/
Porta API: http://<PORTA-MACHINE-IP>:8000/