FRAMR. On-Premise

System Overview
The FRAMR On-Premise Server is delivered as a customer-customized image of a virtual machine (VM). This setup is optimized for use on VMWare ESXI 6.5+ or comparable virtualization systems. The VM is designed for high performance and reliability and requires specific hardware and network resources.
FRAMR On-Premise (VM) Specifications
  • Operating System: Ubuntu 24.04 LTS
    The VM uses Ubuntu 24.04 LTS, a long-term support version of Ubuntu known for its stability and security.
  • Web Server: Apache 2
    Apache 2 serves as the web server, providing a reliable and powerful platform for delivering web content.
  • Scripting Language: PHP 8.2
    PHP 8.2 is used to execute server-side scripts. This version offers numerous performance improvements and new features over older versions.
  • Database: MariaDB 10.5
    MariaDB 10.5 is a relational database known for its high performance and scalability.
Hardware Requirements
  • CPU
    At least 4 CPU cores
  • Memory (RAM)
    At least 8 GB
  • Disk Space
    At least 60 GB
Network Requirements
  • IP Address:
    Fixed IP address required
Virtualization Environment

The virtual machine is designed to run on VMWare ESXI 6.5 but can also be operated on other comparable virtualization systems with adjustments by the FRAMR team. The VM configuration must ensure that the minimum requirements for CPU, RAM, and disk space are met.

VMWare Installation and Configuration
  1. VM Setup:
    1. Transfer the FRAMR On-Premise image to your virtual machine on VMWare ESXI 6.5 and then import it into VMWare.
    2. Allocate at least 4 CPU cores, 8 GB of RAM, and 60 GB of disk space to the VM.
    3. Ensure that the VM has a fixed IP address.
  2. Network Configuration:
    1. Configure the network interface of the VM to use the fixed IP address.
    2. Ensure that all necessary ports (e.g., 80 for HTTP, 443 for HTTPS) are open in the firewall.
  3. Software Installation:
    1. Start the virtual machine and then enter the fixed IP address in your browser’s address bar to log into the FRAMR On-Premise cockpit.
    2. Log in using the provided credentials to create your first group and register your players in it.
Note:
Please use only the provided login credentials to register your players – the license is directly linked to this account.

Start the server in Recovery Mode

This guide shows you how to boot the virtual FRAMR. Server into maintenance mode (Recovery Mode) and then use the web interface to perform configuration tasks such as updating the license, managing users, or resetting passwords.


  1. Start or Reboot the Server
    Start or reboot the virtual FRAMR. On-Premise Server using your virtualization platform by selecting “Restart” or “Start” in the GUI.

  2. Focus the Monitor Window
    Once the server starts:
    • Click into the monitor window of the virtual server (typically the black console showing the boot process).
    • This activates keyboard focus, so your key presses are properly forwarded to the virtual machine.

  3. Interrupt the GRUB Countdown
    During the boot process, the GRUB bootloader appears briefly with a countdown (usually 20 seconds). Important: Before the countdown ends, press any key (e.g., the down arrow) to enter the GRUB menu.

  4. Select Maintenance Mode
    In the GRUB menu:
    • Use the arrow keys to navigate through the boot options.
    • Select “FRAMR On-Premise Maintenance Mode” (or a similar option like Recovery Mode or Maintenance Mode).
    • Press Enter to start the server in maintenance mode.
    The system will now boot into a minimal state for maintenance purposes.

  5. Access the Maintenance Web Interface
    • Determine the IP address of the server (this may be shown during boot or in your virtualization management interface).
    • Enter the IP address into a web browser on a device that is in the same network (for example, http://192.168.0.50).
    • The FRAMR. Server maintenance view should appear in the browser.

  6. Use the Maintenance Features
    Within the web interface, you have access to the following functions:
    • Upload configuration file: Upload a new .fmrl configuration file to install a new license.
    • Adjust system settings as needed.
    • Reset login attempts: If the main user (e.g., admin) was locked out due to too many failed login attempts.
    • Reset password: If the admin password was lost, you can restore it to the default state using the configuration file.
Notes and Tips
• Ensure your PC is in the same network segment as the FRAMR. Server.
• The web interface is generally only accessible while in maintenance mode.
• After making your changes, reboot the server to return to normal operation mode.

Update of the FRAMR. On-Premise User License & Adding Additional Players

If you want to add more players or update the license for your FRAMR. on-premise installation, please proceed as follows:


Step 1: Log in to the on-premise admin area


1. Open your browser.

2. Navigate to the address:

3. Log in with the admin account you received when your on-premise server was delivered.

Note: This account is responsible for managing licenses and system information.

Step 2: Copy the Server ID


After logging in, the on-premise management interface will be displayed. This gives you access to:

• Status information• Server settings• License managementAt the very top of the page, you will find the unique Server ID.


Here’s how to proceed:

• Highlight the Server ID and copy it manually OR• Click on the ID to copy it to the clipboard
Step 3: Send a license request to FRAMR. Support


Send the following information to FRAMR. Support by email at [email protected]:


• Server ID

• Username of the admin account


Example:

“Hello FRAMR. Support, please provide us with an updated license file for our on-premise installation. Here are the required details:Server ID: abcd1234-5678-efgh-ijkl-9876mnopqrstUsername: [email protected]

Thank you very much!”


Step 4: Import the license file


As soon as you receive a file with the extension .fmrl from support:

  1. Go back to the on-premise interface ([server-ip]/onpremise/)
  2. Scroll all the way down
  3. Find the section “Import License”
  4. Select the .fmrl file and upload it
  5. Click on Import
Step 5: Restart the server


After successfully importing the license:

• Restart the server once to apply the new licenses and configurations.

Tip: You can perform the restart via the management interface or your virtualization controller, depending on your setup.

You have successfully added additional players to the on-premise installation and updated the license. All new players can now be connected and managed.

Was this article helpful?

0 out of 0 liked this article

Still need help? Message Us