GUI installation

• Download the latest GUI tar.gz package from http://www.voipmonitor.org/download-gui?version=latest
• Untar to /var/www/ (On debian like systems) or /var/www/html (On redhat like systems) and rename created folder to voipmonitor
• Open web browser and point it to voipmonitor http://yourserver/voipmonitor (you can choose whatever directory you want) and follow installation steps

Note: you need to install the sniffer too - complete installation Content#Installaion

System Requirements

The VoIPmonitor GUI has specific hardware and software requirements.

Hardware Architecture Requirements

IMPORTANT: The VoIPmonitor GUI requires an x86 (32-bit or 64-bit) architecture system. The GUI is not supported on aarch64 (ARM64) platforms.

If you need to run VoIPmonitor on ARM64/aarch64 hardware:

• The sensor/sniffer component can be compiled from source for ARM64 architectures - see Compiling from Source
• You must run the GUI on a separate x86 system that connects to the ARM64 sensor's database
• This client-server architecture allows the ARM64 sensor to capture traffic while the x86 GUI provides the web interface

For more information about supported architectures, see the FAQ entry on architecture support.

License key

Obtaining a Trial License (30 Days)

For a new installation, you can obtain a 30-day trial license for testing purposes through one of the following methods:

Method 1: Contact Support

Send a request to the VoIPmonitor support team to obtain a trial license. This method is useful if you encounter issues with automated license generation.

Method 2: Members' Area (Automated)

Log in to the VoIPmonitor members' area and find the license token in the "my services" section.

Troubleshooting Shopping Cart Issues

If you are unable to complete the trial order process (the checkout does not proceed):

1. Review the items in your shopping cart
2. Ensure there is only one trial product in the cart
3. Remove any duplicate or conflicting items (multiple trial products can block checkout)
4. Proceed with the checkout process once only one trial product remains

This is a common issue - accidentally adding the trial product multiple times to the shopping cart will prevent the automated order from completing.

Troubleshooting Email Verification Issues

If you are using the Members' Area method and cannot receive the verification email:

1. Check your inbox and spam/junk folder for the verification email
2. If the email contains a typo or is not found, contact support to manually resend the verification email to the correct email address
3. Verification links are typically valid for 24 hours - if expired, request a new verification email

If you continue to experience issues receiving the verification email, you can use Method 1 (Contact Support) as an alternative.

Troubleshooting "Only One Trial Is Allowed" Error

When using the Members' Area, you may encounter an error stating that only one trial license is allowed. This occurs when:

• You previously used a trial license (even on a different or deleted server)
• The trial status in the back-end system was not properly reset after the trial expired

To resolve this issue:

1. Contact VoIPmonitor support and explain that the automated portal is showing "only one trial is allowed" for your account
2. Specify that you need a trial license for a new installation or testing environment
3. Support will manually correct the trial license status in the back-end system
4. Once the status is corrected, return to the Members' Area and generate the trial license through the normal automated process

Alternatively, you can bypass this issue entirely by using Method 1 (Contact Support) to request a manual trial license issuance.

To download the license key, visit: http://www.voipmonitor.org/download-gui?version=license

The license file is located in the web root folder as key.php

Activating a License in the GUI

VoIPmonitor GUI provides two separate activation methods depending on your scenario. Using the wrong method will result in a "Bad Key Content" error.

Online Activation (Recommended)

Use this method when your server has internet access and you have a license token from the Members' Area or support:

1. Log in to the GUI
2. Navigate to Settings > License
3. Paste your license token (short text string, NOT the full key) into the "License token" field
4. Click the "get/update license key" button
5. The GUI will automatically fetch and apply the full license from the license server

Important: The "License token" field is for short tokens only. Do not paste the full multi-line license key into this field.

Offline Activation

Use this method when your server cannot connect to the license server (network restrictions, firewall, air-gapped environment):

1. Contact VoIPmonitor support to obtain the full, formatted license key
2. Log in to the GUI
3. Navigate to Settings > License
4. Paste the entire multi-line license key into the "License key" text field
5. Ensure you copy all lines (Expires, id, hwid, maxcalls, upgradeexpire, etc.)
6. Save the changes

Important: The "License key" field is for the complete multi-line key. Do not paste a short token into this field.

Troubleshooting "Bad Key Content" Error

If you receive a "Bad Key Content" error, you are likely using the wrong field:

• Pasting a full license key into the "License token" field → This will fail. Use the "License key" field instead.
• Pasting a short token into the "License key" field → This will fail. Use the "License token" field instead and click "get/update license key".
• Incomplete license key → For offline activation, ensure you copied ALL lines of the multi-line key.

Extending a Trial License

If your testing period requires more than 30 days, you can request a trial license extension:

1. Contact VoIPmonitor support to request an extension of your trial license
2. After the license is extended by support, apply the update in the GUI by clicking the "get/update license key" button
3. You do not need to change your server ID when extending the license

Full Licenses

For production use, you can purchase a full license through the VoIPmonitor customer portal. Your license is based on the maximum number of concurrent calls during your peak hours.

You can view your current license status and concurrent call usage in the GUI under Tools -> System Status -> Concurrent calls.

See the FAQ for more information about licensing, including:

• How to calculate the number of channels you need
• What happens if you temporarily exceed your license limit
• License warning and blocking behavior
• Upgrading your license via the customer portal

Retrieving a License Token from an Existing Installation

If you need to find the license token for an existing VoIPmonitor installation (for example, to set up a new development or test system), you can retrieve it using one of the following methods:

Method 1: Retrieve from the GUI

This is the recommended method for retrieving your license token:

1. Log in to your existing VoIPmonitor GUI
2. Navigate to Settings > License
3. Locate the "License token" field
4. Copy the short text string displayed there

Method 2: Retrieve from key.php File (Alternative)

If you cannot access the GUI or need to recover the license programmatically, the key.php file in your GUI installation directory contains the license information.

1. Navigate to your GUI installation directory (typically /var/www/html/voipmonitor or /var/www/voipmonitor)
2. Open the key.php file in a text editor
3. The file contains the license information including the license ID

You can use the license ID found in key.php to retrieve your full license from the GUI or by contacting VoIPmonitor support.

Using the Token on a New Development/Test System

The license token is cryptographically bound to the Hardware ID (HWID) of the server it was generated for.

• If the new test system has the SAME Hardware ID (e.g., a cloned VM or restored backup): You can paste this token directly into the "License token" field on the new system and click "get/update license key".
• If the new test system has a DIFFERENT Hardware ID (e.g., a new VM or physical server): The token from the old installation will not work automatically.

   * Solution: Contact VoIPmonitor support to have your license token reconfigured to allow multiple servers (specifically for the test/dev environment). Once support adds the new HWID to your license, you can use the same token or a new one provided by them.

See also: Can I use my license on multiple servers?

config/system_configuration.php

This file allows disabling some features

Disable Live Sniffer Menu

To completely remove the Live Sniffer functionality from the GUI (including the menu item), edit the config/system_configuration.php file:

define('DISABLE_LIVE_SNIFFER', true);

When enabled, this constant removes the entire Live Sniffer menu item from the GUI. This is different from hiding play buttons (see FAQ for DISABLE_LIVEPLAY).

Important Security Note: Even with DISABLE_LIVE_SNIFFER enabled, users with administrator privileges can override global capture settings to enable recording or listening for specific calls. For strict compliance scenarios, ensure users are not granted administrator privileges.

Other Feature Disabling Options

define('DISABLE_ISSUE_TRACKER', true);
define('DISABLE_REGISTER', true);
define('DISABLE_CDR_SHARE', true);
define('WIKI_URL', 'http://voipmonitor.org');
define('WIKI_URL', false);
define('APP_WEB', 'http://voipmonitor.org');

AI Summary for RAG

Summary: This guide covers the VoIPmonitor GUI installation process, including downloading the package, extracting files, and running the installation wizard. It provides detailed information about obtaining trial licenses (30-day) for new testing installations, including two methods: contacting support or finding license tokens in the "my services" section of the members' area. For the Members' Area method, it includes troubleshooting steps for common issues. First, if you are unable to complete the trial order process (checkout does not proceed), this is typically caused by having multiple trial products in the shopping cart - you must review the cart, ensure only one trial product exists, remove any duplicate or conflicting items, then proceed with checkout. Second, it covers email verification issues: checking spam/junk folders, contacting support to manually resend verification emails, and understanding that verification links are valid for 24 hours. Third, it includes troubleshooting for the "only one trial is allowed" error, which occurs when a previous trial was used; the solution is to contact support to manually correct the trial status in the back-end system, then return to the Members' Area to generate the trial. Alternatively, users can bypass issues by directly contacting support for manual trial issuance. The guide explains how to extend trial licenses beyond 30 days by contacting support and using the "get/update license" button in the GUI without needing to change the server ID.

CRITICAL: License activation in the GUI uses TWO SEPARATE FIELDS. For ONLINE activation (server has internet access), paste the SHORT "license token" into the "License token" field and click "get/update license key" button to automatically fetch the license. For OFFLINE activation (air-gapped or restricted networks), paste the COMPLETE multi-line LICENSE KEY (Expires, id, hwid, maxcalls, upgradeexpire, etc.) into the "License key" field and save. Common "Bad Key Content" errors are caused by using the WRONG field: pasting a full key into "License token" or a short token into "License key" will fail. Also ensure the offline key includes ALL lines, not just the first line.

To retrieve a license token from an existing installation (e.g., for setting up a new development or test system), use either Method 1: Navigate to Settings > License in the GUI and copy the token, or Method 2: Open the key.php file in the GUI installation directory (typically /var/www/html/voipmonitor) which contains the license ID that can be used to retrieve the full license. When using the retrieved token on a new development/test system, note that it is cryptographically bound to the Hardware ID (HWID). If the new system has the SAME HWID (e.g., cloned VM), the token works directly. If it has a DIFFERENT HWID (e.g., new VM), contact VoIPmonitor support to reconfigure the license for multiple servers.

It also covers full license purchasing, which is based on maximum concurrent calls during peak hours, and references the FAQ for more details on license calculation, exceeding limits, warnings, blocking behavior, and upgrading licenses. The config/system_configuration.php file allows disabling specific features like live sniffer (DISABLE_LIVE_SNIFFER to remove menu), issue tracker, registration, and CDR sharing. IMPORTANT: DISABLE_LIVE_SNIFFER removes the menu item entirely, while DISABLE_LIVEPLAY only hides play buttons. Admin users can override capture settings to enable recording, so avoid granting admin privileges for strict compliance scenarios. Keywords: gui installation, trial license, 30-day trial, license extension, my services, members area, get/update license, concurrent calls, server id, full license, customer portal, license key, license token, online activation, offline activation, bad key content, license token field, license key field, key.php, system configuration, disable features, only one trial allowed, trial status, back-end system, DISABLE_LIVE_SNIFFER, DISABLE_LIVEPLAY, disable live sniffer, disable issue tracker, disable registration, admin privileges, override capture settings, compliance, shopping cart, duplicate products, trial order, checkout, unable to complete order, retrieve license token, existing installation, development system, test system, hardware id, hwid, reconfigure license, multiple servers Key Questions:

• How do I retrieve a license token from an existing VoIPmonitor installation?
• Where can I find the license token in the GUI?
• How do I find the license information in the key.php file?
• Can I use my license token on a new development or test system?
• What happens if the new test system has a different hardware ID?
• How do I transfer my license to a new development server?
• What is the hardware ID (HWID) requirement for license tokens?
• Can I use the same license token on multiple servers?
• Where is the key.php file located in the GUI installation?
• How do I reconfigure my license for multiple servers?
• What is the difference between "license token" and "license key" fields in the GUI?
• Which field should I use for online license activation in VoIPmonitor?
• Which field should I use for offline license activation in VoIPmonitor?
• Why do I get "Bad Key Content" error when pasting my license?
• How do I activate a license online using a token?
• How do I activate a license offline using the full key?
• What should I paste into the "License token" field?
• What should I paste into the "License key" field?
• How do I obtain a trial license for VoIPmonitor?
• What is the trial license period?
• How can I get a trial license for a new VoIPmonitor installation?
• Where do I find my license token for VoIPmonitor?
• How do I extend my VoIPmonitor trial license beyond 30 days?
• Do I need to change my server ID when extending my license?
• How is the VoIPmonitor license calculated?
• What happens if I exceed my license limit?
• What is the "get/update license" button in the GUI?
• Where do I check my VoIPmonitor license status and concurrent calls?
• What should I do if I cannot complete the trial order process?
• Why does my trial order checkout fail?
• How do I fix duplicate trial products in my shopping cart?
• What should I do if I cannot receive the verification email for a trial license?
• How long is the trial license verification link valid?
• Can support resend the verification email if I made a typo in my email address?
• What should I do if I get an "only one trial is allowed" error?
• How can I fix the trial license status to generate a new trial?
• Why does the automated portal block my trial request?