/
Self-Hosted Remedio installation and configuration guide

Self-Hosted Remedio installation and configuration guide

OVAs Provided by the Remedio Team

You will receive the following 2 OVA files from the Remedio team to set up your environment:

  1. PostgreSQL (Database) Server OVA:

    • This virtual appliance contains the pre-configured PostgreSQL database server required for storing and managing Remedio data.

  2. Remedio Services (Application) Server OVA:

    • This virtual appliance contains the core Remedio services and application required to manage and monitor your environment.

Ensure both OVA files are available before beginning the installation process.

image-20250112-140622.png

  1. Ensure you have created two static IP address records and two DNS names for both the Services and PostgreSQL servers.

If your network subnet is 10.42.0.0 or 10.43.0.0, please contact your Remedio Technical Account Manager prior to installation.

If you are using Hyper-V and are unsure how to import the VHD files, please refer to this section.

Import and Configure the Remedio PostgreSQL OVA

  1. Open the VMware Console:

    • Launch the VMware vSphere Client or VMware Workstation, depending on your environment.

  2. Import the Remedio PostgreSQL OVA:

    • Select File > Deploy OVF Template option.

    • Browse to the location of the gytpol-postgres.ova file.

    • Follow the on-screen instructions to complete the import process.

  3. Post-Import Configuration:

    • Once the import is complete, locate the newly created VM in your VMware environment.

      • Edit the VM settings to ensure it meets the required specifications -
        please refer to System Requirements for Self-Hosted Remedio guide.

        • Set CPUs and the Memory according to the specifications document.

        • Add another 100 GB Hard Disk (resulting in a total of 2 disks):

          • Ensure the first disk has a size of 100 GB.

          • Add a second hard disk with a size of 100 GB.

          • Verify that both disks are SSD.

Failure to meet the specified settings prior to the installation procedure, may result in extended installation times or failures due to timeouts.

Steps to Access and Initialize PostgreSQL in the VM

  1. Open the Console of the PostgreSQL VM:

    • Use VMware to access the console of the VM where PostgreSQL is installed.

  2. Log in to the VM:

    • Enter the following credentials to log in:

      • Username: ubuntu

      • Password: m-33W8]aiUh

        • (Optional) To change the password, follow these steps:

          • Type passwd.

          • You will be prompted to enter your current password, followed by the new password twice for confirmation.

  3. Initialize PostgreSQL:

    • Once logged in, execute the following command to initialize PostgreSQL: sudo gyt postgres-init

  4. Verify the Initialization:

    • Check the output to ensure PostgreSQL has been successfully initialized.

image-20250128-130534.png

Configure the Network for PostgreSQL VM

  1. Follow Network Configuration Prompts:

    • When prompted during the setup process, configure the network settings for the VM.

    • You will be asked to choose between static and DHCP IP address allocation.

  2. Recommendation: Use a Static IP:

    • We recommend typing ‘static’ to manually configure the IP address for better reliability and control.

    • Enter the following details:

      • IP Address: Your desired static IP.

      • Subnet Mask: As per your network configuration (e.g., /24 or 24 ).

      • Gateway: Your network gateway IP address.

      • DNS Servers: Enter your preferred DNS servers.
        If you have multiple servers, input them one at a time. When finished, type done.

image-20250128-122331.png

  1. Verify the Network Configuration:

    • Once the setup is complete, test the network connectivity:

      • Ping the configured IP from another device on the network to confirm accessibility.

      • If static, ensure the settings align with your network’s configuration to avoid IP conflicts.

Password Configuration During Setup

As part of the setup process, you will be prompted to configure two important passwords. Follow these steps carefully:

  1. Wait for Password Prompts:

    • During the initialization process, the setup will ask you to provide passwords for critical components.

When setting the passwords, make sure it does not contain any of the following characters ', ", ~, ;, commas or spaces.

  1. Passwords to Set:

    • PostgreSQL Master Password:

      • This password secures the PostgreSQL database and will be required for administrative tasks.

      • Choose a strong and secure password. Record it safely for future reference

The password you set during this step cannot be changed later. Please make sure to choose a strong, secure password and store it safely. If it is lost or forgotten, it cannot be recovered, and you may need to repeat the setup process.

  1. Input the Passwords When Prompted:

    • When the setup script prompts you, type in the passwords carefully and confirm them when asked.

  2. Verify the Passwords:

    • Ensure you see a confirmation message or successful setup output for each password entry.

image-20250206-163411.png

Recommendations:

  • Use a password manager to securely generate and store these credentials.

  • Avoid reusing passwords from other systems for added security.

Do not forget these passwords. They will be required later in the installation process and for future management tasks.

After successfully initializing the PostgreSQL server, you will see a “PostgreSQL Initialization Completed” message and be returned to the ubuntu@gytpol-postgresql:~$ prompt.

image-20250206-163508.png

Import and Configure the Remedio Services OVA

  1. Open the VMware Console:

    • Launch the VMware vSphere Client or VMware Workstation, depending on your environment.

  2. Import the Remedio Services OVA:

    • Select File > Deploy OVF Template option.

    • Browse to the location of the gytpol-services.ova file.

    • Follow the on-screen instructions to complete the import process.

  3. Post-Import Configuration:

    • Once the import is complete, locate the newly created VM in your VMware environment.

    • Edit the VM settings to ensure it meets the required specifications:

      • Set CPUs:

        • Assign 6 CPUs to the VM.

      • Set Memory:

        • Allocate 12 GB of RAM.

      • Add a 50 GB Hard Disk (resulting in a total of 2 disks):

        • Ensure the first disk has a size of 100 GB.

        • Add a second hard disk with a size of 50 GB.

        • Verify that both disks are SSD.

Failure to meet the specified settings prior to the installation procedure, may result in extended installation times or failures due to timeouts.

  1. Power On the VM:

    • Start the VM from the VMware console.

  2. Verify DNS Record:

    • Ensure the DNS record for the Remedio server is resolvable:

      • Use a command like nslookup <server-name> or ping <server-name> from another machine to confirm.

Optional: create a snapshot of the VM before making any configuration changes. You can remove the snapshot once the configurations are complete.

Access the Services VM Console

  1. Open Services VM Console:

    • Switch to the console of the Services VM in VMware.

  2. Log in to the Services VM:

    • Use the following credentials to access the VM:

      • Username: ubuntu

      • Password: m-33W8]aiUh

        • (Optional) To change the password, follow these steps:

          • Type passwd.

          • You will be prompted to enter your current password, followed by the new password twice for confirmation.

If your domain name ends with .local, update the /etc/hosts file by adding the IP address and FQDN before proceeding with the next steps. For example:

10.10.10.10 gytpol-app.yourdomain.local

In the terminal window, type the following command: sudo nano /etc/hosts

In the nano editor, scroll to the end of the file and add the following line, replacing 10.10.10.10 and gytpol-app.yourdomain.local with your actual IP address and FQDN.

After making the changes, press Ctrl + O to save the file, then Enter to confirm.

Exit nano by pressing Ctrl + X.

 

  1. Run the command sudo gyt install

image-20250128-130606.png

Network Configuration for the Remedio Services VM

  1. Follow the Network Configuration Prompts:

    • During the initial setup of the Remedio Services VM, you will be prompted to configure the network settings.

  2. Choose an IP Address Configuration:

    • We recommend selecting ‘static’ to manually configure the IP address for better reliability and control.

      • Enter the following details:

        • IP Address: Your desired static IP.

        • Subnet Mask: As per your network configuration (e.g., /24 or 24)

        • Gateway: Your network's gateway IP address.

        • DNS Servers: Enter your preferred DNS servers.
          If you have multiple servers, input them one at a time. When finished, type done.

image-20250128-131110.png

At this stage, the Remedio Services server will initialize and install the required components, including Docker containers and configurations. Please wait until you see the message: “Finished - Mounting config volume.” Once this appears, you will proceed to the configuration values prompts, which are detailed in the steps below.

Providing Required Information During Setup

When prompted during the setup process, supply the following details carefully.

When setting the passwords, make sure it does not contain any of the following characters ', ", ~, ;, commas or spaces.

  1. GYTPOL_URL:

    • Enter the DNS name of the Remedio server. Make sure it’s FQDN. Make sure it’s lower case.

    • Example: gytpol-app.yourdomain.com

  2. MASTER_PASSWORD:

  3. POSTGRES_HOST:

    • Enter the IP address of the PostgreSQL VM.

    • Example: 192.168.1.100

  4. GYTPOL_ADMIN_USER_EMAIL (default):

    • Enter the email address for the first administrator user in the system.

    • Example: admin@yourdomain.com

  5. USER_MANAGEMENT_ADMIN_PASSWORD:

    • Set a password for accessing the User Management Console (separate screen for Admin access)

    • Choose a secure and memorable password. This is a new password.

image-20250206-165325.png

  1. The setup will request you to create an Initial User Password for the first user account in the system.

  • This is a new password for the first local user created in the GYTPOL_ADMIN_USER_EMAIL step (#4).

image-20250128-140840.png

Wait for the installation to complete. Once finished, you should see the message: “Finished - Publishing Release Notes” and return to the ubuntu@gytpol-services:~$ prompt.

At this point:

  1. The Access Key ID, Secret Access Key, API Key, and License ID will be displayed, and the same information will also be exported to /home/ubuntu/outputs.json.

    If you need the API Key for future use (e.g., reporting, BI tools), make sure to copy and store it securely.

  2. Please copy the outputs.json file from the Remedio Services Server and save it to your local machine.

image-20250414-085055.png

License request

  • Send the outputs.json file to license@gytpol.com.

  • The Remedio team will respond with the license key and sensor installation files.

Copying Sensor Installation Files/Packages to the Services OVA

The sensor files are provided in a ZIP format. Before copying the files, ensure you extract the sensor files into a folder.

To transfer sensor installation files to the services OVA, you can use a file transfer tool like WinSCP (graphical interface) or the scp command (command-line). Both options connect over port 12222.

Option 1: Using WinSCP

  1. Launch WinSCP and configure the connection:

    • File Protocol: SCP

    • Host name: The IP address or the Host name of the Remedio Services server.

    • Port: 12222

    • Username: ubuntu.

    • Password: The corresponding password.

  2. Transfer Files:

    • Drag and drop the extracted sensor files from your local machine to the target directory on the Remedio Services server.

      Please keep the default directory as /home/ubuntu for the file transfer.

Option 2: Using scp Command (Terminal)

  1. Open your terminal and use the following command:

  2. Copy code example: scp -P 12222 -o StrictHostKeyChecking=no ~/Downloads/gytpol-client_2.4.9.18-18_amd64.deb ubuntu@10.60.0.103:/home/ubuntu

image-20250112-144059.png

Options Explained:

  • -P 12222: Specifies the port 12222.

  • -o StrictHostKeyChecking=no: Skips the SSH host key verification for faster connections.

  • ~/Downloads/gytpol-client_2.4.9.18-18_amd64.deb: Local path to the file (on macOS for example).
    Can be also c:\temp\gytpol-client_2.4.9.18-18_amd64.deb for Windows.

  • ubuntu@10.60.0.103: Username and IP address of the Remedio Services server.

  • /home/ubuntu: The destination directory on the Remedio Services server.

Copy and Install Sensor Files in the Services OVA

  1. Copy All Sensor Installation Files:

    • Use WinSCP or the scp command (as described earlier) to transfer all sensor installation files you receive to the services OVA.

  2. Log in to the Services OVA:

    • Open the VMware console or use SSH to access the Remedio services server.

    • Use the credentials you configured during the setup.

  3. Run the Command for Each Sensor Installation File:
    sudo gyt copy-client <os> <channel> <version> [--force]

  • <os>: target operating system windows, linux, or mac

  • <channel>: latest, stable, or both

  • <version>: client version to copy

  • --force: allow downgrading from the currently configured version (optional)

For example:

sudo gyt copy-client windows both 3.1.36.0 sudo gyt copy-client linux latest 2.4.9.18 sudo gyt copy-client mac stable 2.3.5.18 --force

latest : Delivers the newest version, typically within about two weeks of release. This channel may include early fixes and new features.

stable : Delivers a version only after roughly four weeks of proven reliability. Critical fixes may be released earlier in both channels.

For the Windows Sensor, ensure you extract the files first instead of copying or uploading the ZIP file. Use only the MSI files and exclude the rest of the ZIP contents.

image-20250128-143337.png

Installing the License for Remedio

Installing the License:

Once you receive the license file from the Remedio team, upload it to the services VM using WinSCP or the scp command: sudo gyt install-license <LICENSE-FILENAME.txt>

Replace <LICENSE-FILENAME.txt> with the full path or name of the license file.

Please wait 10 to 15 seconds for the pods to start, then refresh the UI to confirm that the license is valid.

image-20250128-143554.png

Adding SSL Certificate to Remedio

By default, Remedio will run on https with self-signed certificate.

image-20250113-114231.png

To add a personal certificate, you will need to provide SSL certificate files (.crt and .key) for the DNS domain name associated with your Remedio server.

  • Obtain Certificate Files:

    • Acquire an SSL certificate (.crt file) and its corresponding private key (.key file) for your DNS domain name from a trusted Certificate Authority (CA) or generate self-signed certificates for testing.