Settings: Difference between revisions

From VoIPmonitor.org
(Add troubleshooting for non-deletable local sensor)
(Improved formatting: converted bullet lists to tables, fixed broken PHP links, added introduction, consistent code formatting, proper section naming (GeoIP, Email), moved AI RAG section to correct location)
Line 1: Line 1:
{{DISPLAYTITLE:GUI Settings Reference}}
Category:GUI manual
This page documents the configuration options available in the VoIPmonitor web GUI under the '''Settings''' menu. These settings control how the GUI interacts with sensors, displays data, and manages user preferences.
== Sensors ==
== Sensors ==


If id_sensor is set in /etc/voipmonitor.conf (default blank), create sensors here to download files like PCAP, graphs, WAV.
If <code>id_sensor</code> is set in <code>/etc/voipmonitor.conf</code> (default is blank), you must create sensor entries here to enable downloading files like PCAP, graphs, and WAV recordings from the GUI.


* Sensor ID: Number from /etc/voipmonitor.conf id_sensor = N
{| class="wikitable"
* Name: Sensor name
|-
* Manager IP, Port: For fetching data (PCAP/graph files). Default port: 5029
! Field !! Description
* Remote database parameter: For finding legs in "Legs by [CID|header]" CDR tab if sensors use different databases. Leave blank if same database.
|-
| Sensor ID || The numeric ID matching <code>id_sensor = N</code> in <code>voipmonitor.conf</code>
|-
| Name || A descriptive name for the sensor
|-
| Manager IP || IP address of the sensor for fetching data (PCAP, graph, audio files)
|-
| Manager Port || TCP port for the manager API (default: 5029)
|-
| Remote database || Database connection parameters for "Legs by CID/header" lookups when sensors use different databases. Leave blank if all sensors share the same database.
|}


[[File:settings-sensors.png]]
[[File:settings-sensors.png]]
Line 12: Line 27:
=== Troubleshooting: Non-deletable Local Sensor ===
=== Troubleshooting: Non-deletable Local Sensor ===


In server/probe deployments where the GUI server is not sniffing traffic itself, a "local sensor" may be automatically created in the sensor list. This sensor cannot be deleted through the GUI.
In server/probe deployments where the GUI server is not sniffing traffic itself, a "local sensor" may be automatically created in the sensor list. This sensor cannot be deleted through the normal GUI interface.


'''Workaround:'''
'''Workaround:'''
Line 19: Line 34:
# You can then remove the duplicate entry if both sensors appear
# You can then remove the duplicate entry if both sensors appear


This occurs because the GUI automatically creates a sensor entry when it detects it is running on a server where `id_sensor` is set but no active capture is configured.
This occurs because the GUI automatically creates a sensor entry when it detects that <code>id_sensor</code> is set in the configuration but no active capture is configured on the GUI host.


== CDR Charts ==
== CDR Charts ==


Predefined charts for [[Call_Detail_Record_-_CDR#Charts|CDR detail charts section]].
This section allows you to define predefined charts that appear in the [[Call_Detail_Record_-_CDR#Charts|CDR detail view's Charts tab]]. These charts provide quick visual analysis for specific call records based on caller/called information.


[[File:settings-cdrcharts.png]]
[[File:settings-cdrcharts.png]]
Line 29: Line 44:
== CDR Custom Headers ==
== CDR Custom Headers ==


From sniffer version 7.0RC7, store custom SIP headers to database for viewing/searching: [[Sniffer_configuration#custom_headers]].
Since sniffer version 7.0RC7, VoIPmonitor can store custom SIP headers in the database for viewing and searching in the GUI. For the sniffer configuration, see [[Sniffer_configuration#custom_headers]].


[[File:customheaderform.png]]
[[File:customheaderform.png]]


=== Available Configuration Fields ===
=== Configuration Fields ===
 
The GUI custom header configuration has the following fields:
 
==== Header Field ====
 
Combo box lists headers from cdr_next.custom_header*. Created automatically on custom_headers in voipmonitor.conf and restart.
 
==== Name ====
 
Header name in WEB GUI CDR header panel.


==== Match in SIP by Header ====
;Header Field
:Combo box listing available headers from the <code>cdr_next.custom_header*</code> database columns. These are automatically created when you add headers to <code>custom_headers</code> in <code>voipmonitor.conf</code> and restart the sniffer.


Use for matching CDRs in [[Call_Detail_Record_-_CDR#Legs_by_header]]. Example: Unique identifier in custom header for legs (phone to SBC, SBC to provider). Alternative: [[Sniffer_configuration#match_header]].
;Name
:The display name for this header in the CDR view header panel.


==== Show as Column ====
;Match in SIP by Header
:When enabled, this header is used for matching CDRs in the [[Call_Detail_Record_-_CDR#Legs_by_header|Legs by header]] tab. This is useful when you have a unique correlation identifier that links multiple call legs (e.g., from phone to SBC, and from SBC to provider). Alternative method: [[Sniffer_configuration#matchheader|matchheader]] in voipmonitor.conf.


Display header in CDR column.
;Show as Column
:When enabled, displays this header as a column in the CDR list view.


[[File:customheaderscdrpanel.png]]
[[File:customheaderscdrpanel.png]]
Line 57: Line 66:
=== Limitations ===
=== Limitations ===


'''Important:''' The GUI custom header feature has the following limitations:
The GUI custom header feature has the following limitations:


* '''No Regexp extraction:''' Custom headers store the '''complete raw header value'''. There is no option to extract portions of the header using regular expressions (e.g., extracting just an IP address from a SIP URI).
{| class="wikitable"
* '''No Delimiter aggregation:''' If a SIP header appears multiple times in a message (e.g., multiple Contact headers in a SIP 300 response), the custom header feature does '''not''' aggregate them with a delimiter. Only one value is stored (controlled by <code>custom_headers_last_value</code> in voipmonitor.conf - either first or last occurrence).
|-
* '''No per-method or response code filtering:''' Custom headers are captured from all SIP messages. There is no option to capture headers only from specific SIP methods (INVITE, BYE, etc.) or response codes (300, 200, etc.).
! Limitation !! Description
|-
| '''No Regexp extraction''' || Custom headers store the '''complete raw header value'''. There is no option to extract portions using regular expressions (e.g., extracting just an IP address from a SIP URI).
|-
| '''No Delimiter aggregation''' || If a SIP header appears multiple times in a message (e.g., multiple Contact headers in a SIP 300 response), only one value is stored. Controlled by <code>custom_headers_last_value</code> in voipmonitor.conf (first or last occurrence).
|-
| '''No per-method filtering''' || Custom headers are captured from all SIP messages. There is no option to capture only from specific SIP methods (INVITE, BYE, etc.) or response codes (200, 300, etc.).
|}


'''For advanced header extraction needs:''' Contact VoIPmonitor support to discuss if custom development or alternative approaches (such as external PCAP processing) are suitable for your use case.
For advanced header extraction needs, contact VoIPmonitor support to discuss custom development or alternative approaches such as external PCAP processing.


== Load GeoIP Data ==
== Load GeoIP Data ==


Loads GeoIP data to internal database for [[Call_Detail_Record_-_CDR#map|CDR detail map]].
Loads GeoIP data into the internal database for the [[Call_Detail_Record_-_CDR#Map|CDR detail Map tab]], which displays geographic locations of call participants.


[[File:settiongs-loadgeoip.png]]
[[File:settiongs-loadgeoip.png]]


== System Configuration ==
== System Configuration ==
The System Configuration section contains core settings that affect the overall behavior of the GUI.


=== Basic ===
=== Basic ===
Line 77: Line 95:
[[File:settings-sysbasic.png]]
[[File:settings-sysbasic.png]]


* WEB URL: For hypertext links (e.g., email alerts)
{| class="wikitable"
* Sniffer data path: Directory to sniffer data (default: /var/spool/voipmonitor)
|-
* Default sensor hostname: Default sniffer hostname (localhost). Define multiple in Settings > Sensors
! Setting !! Description
* Default sensor TCP port: Default port (5029)
|-
| WEB URL || Base URL for the GUI, used in hypertext links (e.g., in email alerts)
|-
| Sniffer data path || Directory where sniffer stores data (default: <code>/var/spool/voipmonitor</code>)
|-
| Default sensor hostname || Default hostname for connecting to the sniffer (default: localhost). For multiple sensors, configure them in Settings > Sensors
|-
| Default sensor TCP port || Default TCP port for the manager API (default: 5029)
|}


=== Database ===
=== Database ===


Database settings.
Configuration for the MySQL/MariaDB database connection used by the GUI.


[[File:settings-sysdb.png]]
[[File:settings-sysdb.png]]


=== National ===
=== National ===
Settings for localizing call classification and date/time display formats.


[[File:settings-sysnational.png]]
[[File:settings-sysnational.png]]


* Timezone: Set to your Country/Town
{| class="wikitable"
* National prefix,2,3: Classify national/international calls (used in Active calls)
|-
* Max national number length: Longer calls are international regardless of prefix
! Setting !! Description
* Date format: Default Y-m-d[](http://www.php.net/manual/en/function.date.php)
|-
* Time format: Default G:i:s[](http://www.php.net/manual/en/function.date.php)
| Timezone || Server timezone (format: Country/City, e.g., Europe/Prague)
* Week start
|-
| National prefix, 2, 3 || Prefixes used to classify calls as national vs. international (used in [[Active_calls|Active calls]] view)
|-
| Max national number length || Numbers longer than this are classified as international regardless of prefix
|-
| Date format || PHP date format string (default: <code>Y-m-d</code>). See [https://www.php.net/manual/en/datetime.format.php PHP DateTime format]
|-
| Time format || PHP time format string (default: <code>G:i:s</code>). See [https://www.php.net/manual/en/datetime.format.php PHP DateTime format]
|-
| Week start || First day of the week for calendar displays
|}


=== Intervals ===
=== Intervals ===
Default time intervals for various GUI views and filters.


[[File:settings-sysintervals.png]]
[[File:settings-sysintervals.png]]


* Default CDR interval: Filter interval on entering CDR section. If "specified number of days", set in next option
{| class="wikitable"
* Default CDR interval in days: Editable only if "specified number of days" selected
|-
* Default dashboard interval: Filter interval on entering dashboard
! Setting !! Description
* Default Legs by CID interval: Related calls +- interval (default: 5 seconds)
|-
* Default Legs by header interval: Related calls +- interval (default: 5 seconds)
| Default CDR interval || Default time filter when entering the CDR section. If set to "specified number of days", configure in the next option
|-
| Default CDR interval in days || Number of days for the CDR filter (only editable if above is set to "specified number of days")
|-
| Default dashboard interval || Default time filter when entering the dashboard
|-
| Default Legs by CID interval || Time window (+/-) for finding related calls in the Legs by CID tab (default: 5 seconds)
|-
| Default Legs by header interval || Time window (+/-) for finding related calls in the Legs by header tab (default: 5 seconds)
|}
 
=== Email / HTTP Referer ===


=== EMAIL HTTP REFERER ===
Email configuration settings.


[[File:settings-sysemailhttpreferer.png]]
[[File:settings-sysemailhttpreferer.png]]


* DEFAULT_EMAIL_FROM: Default From header
{| class="wikitable"
* Disable email plain text: For mailers showing only plain text (e.g., Outlook 2003); enable to force HTML
|-
! Setting !! Description
|-
| DEFAULT_EMAIL_FROM || Default "From" address for outgoing emails
|-
| Disable email plain text || Enable to force HTML-only emails. Useful for mail clients that display only plain text incorrectly (e.g., older Outlook versions)
|}


=== GEOIP ===
=== GeoIP ===
 
Configuration for GeoIP services used in the CDR Map view.


[[File:settings-sysgeoip.png]]
[[File:settings-sysgeoip.png]]


* Use GEOIP local database: Enable/disable internal GEOIP (if loaded)
{| class="wikitable"
* GEOIP maxmind.com KEY: Personal key for maxmind.com
|-
* GEOIP ipinfodb.com KEY: Personal key for ipinfodb.com
! Setting !! Description
|-
| Use GeoIP local database || Enable/disable the internal GeoIP database (if loaded via [[#Load_GeoIP_Data|Load GeoIP Data]])
|-
| GeoIP maxmind.com KEY || API key for MaxMind GeoIP service
|-
| GeoIP ipinfodb.com KEY || API key for IPInfoDB service
|}


=== Advanced ===
=== Advanced ===
Advanced configuration options for power users and specific use cases.


[[File:settings-sysadvanced.png]]
[[File:settings-sysadvanced.png]]


* Enable CDR group panel: Enable/disable CDR bottom panel
{| class="wikitable"
* ENABLE_CDR_FORCE_INDEX_CALLDATE: Force calldate index on queries; for unoptimized MySQL. Enable only if needed.
|-
* Enable database IP reverse lookup: Name IPs via internal IP lookup table
! Setting !! Description
* Enable DNS reverse lookup: Name IPs via DNS
|-
* Enable database number lookup: Name numbers via internal prefix lookup table
| Enable CDR group panel || Show/hide the group panel at the bottom of the CDR view
* Disable rtpfirstleg param: Disable --rtp-firstleg for PCAP audio decoding; only if needed
|-
* Disable URL wav protection: Skip session check for WAV download; for external access. Secure with WAV key
| ENABLE_CDR_FORCE_INDEX_CALLDATE || Force use of the calldate index on CDR queries. Enable only for unoptimized MySQL installations experiencing slow queries
* WAV download key: Key for WAV download without auth
|-
* Hide SIP domain in CDR: Hide domains
| Enable database IP reverse lookup || Resolve IP addresses to names using the internal IP lookup table
* Hide live play: Hide in active calls
|-
* Hide WAV play: Hide play buttons in CDR
| Enable DNS reverse lookup || Resolve IP addresses to names using DNS
* Upload sniffer conf path: Path to voipmonitor.conf for PCAP uploads
|-
* CDR share key: String for unique hashes in CDR share URLs
| Enable database number lookup || Resolve phone numbers to names using the internal prefix lookup table
* '''Folder for export CSV:''' Directory path where CSV files generated by crontab scheduler tasks will be saved. When configured, crontab scheduler tasks can export CDR data to this folder instead of (or in addition to) sending via email. See [[Reports#CSV_Export_via_Crontab_Scheduler|Reports - CSV Export via Crontab Scheduler]] for details.
|-
* '''CSV name prefix:''' Optional prefix for CSV filenames generated by crontab scheduler tasks.
| Disable rtpfirstleg param || Disable the <code>--rtp-firstleg</code> parameter for PCAP audio decoding. Enable only if experiencing audio issues
* '''Delete CSV after X days:''' Optional automatic cleanup - CSV files older than this many days will be automatically deleted.
|-
| Disable URL wav protection || Skip session authentication for WAV file downloads. Use with '''WAV download key''' for secure external access
|-
| WAV download key || Secret key required for WAV downloads when URL protection is disabled
|-
| Hide SIP domain in CDR || Hide SIP domains in the CDR display
|-
| Hide live play || Hide live playback buttons in [[Active_calls|Active calls]]
|-
| Hide WAV play || Hide WAV playback buttons in CDR view
|-
| Upload sniffer conf path || Path to voipmonitor.conf for PCAP upload functionality
|-
| CDR share key || Secret string used to generate unique hashes for CDR share URLs
|-
| Folder for export CSV || Directory where CSV files from [[Reports#CSV_Export_via_Crontab_Scheduler|crontab scheduler tasks]] are saved
|-
| CSV name prefix || Optional prefix for CSV filenames generated by crontab tasks
|-
| Delete CSV after X days || Auto-delete CSV files older than specified days
|}


== Localization ==
== Localization ==


Create national localizations for GUI (not 100% complete; report missing items).
Create custom translations for the GUI interface. Localizations are not 100% complete; please report missing translation items.
 
Unlimited localizations; form to create:


[[File:settings-localisationform.png]]
[[File:settings-localisationform.png]]
Line 155: Line 241:
[[File:settings-localisationgrid.png]]
[[File:settings-localisationgrid.png]]


Red numbers indicate untranslated items; useful post-upgrade.
* Red numbers indicate untranslated items, which is useful after upgrading to identify new strings
 
* Changes take effect after logout/login
Changes effective after logout/login.


== CDR View Custom URL ==
== CDR View Custom URL ==


Add custom link to CDR view (e.g., monitoring).
Add custom hyperlinks to the CDR view Commands column. This is useful for integrating external monitoring or CRM systems.


=== Setting ===
=== Configuration ===


Set in '''GUI > Settings > Cdr view custom URL'''.
Navigate to '''GUI > Settings > CDR view custom URL'''.


[[File:cdr_view_custom_url.png]]
[[File:cdr_view_custom_url.png]]


Add parameters/custom headers:
You can include CDR parameters in the URL using two methods:


# Via Parameters and Custom headers items: Added as param1Name=value1
# '''Via Parameters and Custom headers items:''' Values are appended as query parameters (e.g., <code>?paramName=value</code>)
# Directly in URL as <nowiki>{{param1Name}}</nowiki>: Replaced with value
# '''Directly in URL:''' Use <nowiki>{{paramName}}</nowiki> syntax, which is replaced with the actual value


=== View ===
=== Display ===


Links in Commands column of CDR view.
Configured custom URLs appear as links in the Commands column of the CDR view.


=== AI Summary for RAG ===
== AI Summary for RAG ==


'''Summary:''' This article details VoIPmonitor GUI settings including sensor configuration, CDR custom headers with their limitations, system configuration options, and troubleshooting for non-deletable local sensors. Custom headers store complete raw SIP header values without regexp extraction, delimiter aggregation, or per-method/response-code filtering. Other settings cover CDR charts, GeoIP loading, system configs (basic, database, national, intervals, email, GEOIP, advanced), localization, and custom CDR URLs.
'''Summary:''' This article documents VoIPmonitor GUI settings including sensor configuration, CDR custom headers with their limitations, GeoIP data loading, system configuration (basic, database, national, intervals, email, GeoIP, advanced), localization, and custom CDR URLs. Key topics: custom headers store raw SIP header values without regexp extraction or delimiter aggregation; sensor troubleshooting for non-deletable local sensors in server/probe deployments.


'''Keywords:''' custom headers, CDR headers, header limitations, no regexp, no delimiter, GeoIP, system configuration, timezone, email, advanced settings, localization, custom URL, sensors, non-deletable local sensor, sensor troubleshooting
'''Keywords:''' GUI settings, sensors, CDR custom headers, header limitations, GeoIP, system configuration, timezone, national prefix, date format, intervals, advanced settings, localization, custom URL, CSV export


'''Key Questions:'''
'''Key Questions:'''
* How do I configure sensors in the GUI?
* How do I configure sensors in the VoIPmonitor GUI?
* How do I delete a non-deletable local sensor in server/probe deployment?
* How do I delete a non-deletable local sensor in a server/probe deployment?
* How do I create CDR custom headers and how to set them?
* How do I create and configure CDR custom headers?
* Can I extract part of a SIP header using regexp in custom headers?
* Can I extract part of a SIP header using regexp in custom headers?
* Can I aggregate multiple Contact headers with a delimiter?
* Can I aggregate multiple occurrences of a SIP header?
* Can I capture custom headers only from specific SIP response codes?
* What are the limitations of CDR custom headers?
* What are the limitations of CDR custom headers?
* How to load GeoIP data?
* How do I load GeoIP data for the map view?
* What basic system configurations are available?
* What system configuration options are available?
* How to set national prefixes and time formats?
* How do I set national prefixes and date/time formats?
* What interval settings control CDR and dashboard filters?
* What interval settings control CDR and dashboard filters?
* How to configure GEOIP services?
* How do I configure GeoIP services?
* What advanced options like reverse lookups exist?
* How do I create GUI localizations?
* How to create GUI localizations?
* How do I add custom URLs to the CDR view?
* How to add custom URLs to CDR views?
* How do I export CDRs to CSV via crontab scheduler?
* How to export CDRs to a local CSV directory via crontab scheduler?

Revision as of 20:30, 4 January 2026

Category:GUI manual

This page documents the configuration options available in the VoIPmonitor web GUI under the Settings menu. These settings control how the GUI interacts with sensors, displays data, and manages user preferences.

Sensors

If id_sensor is set in /etc/voipmonitor.conf (default is blank), you must create sensor entries here to enable downloading files like PCAP, graphs, and WAV recordings from the GUI.

Field Description
Sensor ID The numeric ID matching id_sensor = N in voipmonitor.conf
Name A descriptive name for the sensor
Manager IP IP address of the sensor for fetching data (PCAP, graph, audio files)
Manager Port TCP port for the manager API (default: 5029)
Remote database Database connection parameters for "Legs by CID/header" lookups when sensors use different databases. Leave blank if all sensors share the same database.

Troubleshooting: Non-deletable Local Sensor

In server/probe deployments where the GUI server is not sniffing traffic itself, a "local sensor" may be automatically created in the sensor list. This sensor cannot be deleted through the normal GUI interface.

Workaround:

  1. In Settings > Sensors, add a new sensor with the same Sensor ID, name, and settings as the non-deletable local sensor
  2. After saving, the original automatically created sensor should either disappear or become deletable
  3. You can then remove the duplicate entry if both sensors appear

This occurs because the GUI automatically creates a sensor entry when it detects that id_sensor is set in the configuration but no active capture is configured on the GUI host.

CDR Charts

This section allows you to define predefined charts that appear in the CDR detail view's Charts tab. These charts provide quick visual analysis for specific call records based on caller/called information.

CDR Custom Headers

Since sniffer version 7.0RC7, VoIPmonitor can store custom SIP headers in the database for viewing and searching in the GUI. For the sniffer configuration, see Sniffer_configuration#custom_headers.

Configuration Fields

Header Field
Combo box listing available headers from the cdr_next.custom_header* database columns. These are automatically created when you add headers to custom_headers in voipmonitor.conf and restart the sniffer.
Name
The display name for this header in the CDR view header panel.
Match in SIP by Header
When enabled, this header is used for matching CDRs in the Legs by header tab. This is useful when you have a unique correlation identifier that links multiple call legs (e.g., from phone to SBC, and from SBC to provider). Alternative method: matchheader in voipmonitor.conf.
Show as Column
When enabled, displays this header as a column in the CDR list view.

Limitations

The GUI custom header feature has the following limitations:

Limitation Description
No Regexp extraction Custom headers store the complete raw header value. There is no option to extract portions using regular expressions (e.g., extracting just an IP address from a SIP URI).
No Delimiter aggregation If a SIP header appears multiple times in a message (e.g., multiple Contact headers in a SIP 300 response), only one value is stored. Controlled by custom_headers_last_value in voipmonitor.conf (first or last occurrence).
No per-method filtering Custom headers are captured from all SIP messages. There is no option to capture only from specific SIP methods (INVITE, BYE, etc.) or response codes (200, 300, etc.).

For advanced header extraction needs, contact VoIPmonitor support to discuss custom development or alternative approaches such as external PCAP processing.

Load GeoIP Data

Loads GeoIP data into the internal database for the CDR detail Map tab, which displays geographic locations of call participants.

System Configuration

The System Configuration section contains core settings that affect the overall behavior of the GUI.

Basic

Setting Description
WEB URL Base URL for the GUI, used in hypertext links (e.g., in email alerts)
Sniffer data path Directory where sniffer stores data (default: /var/spool/voipmonitor)
Default sensor hostname Default hostname for connecting to the sniffer (default: localhost). For multiple sensors, configure them in Settings > Sensors
Default sensor TCP port Default TCP port for the manager API (default: 5029)

Database

Configuration for the MySQL/MariaDB database connection used by the GUI.

National

Settings for localizing call classification and date/time display formats.

Setting Description
Timezone Server timezone (format: Country/City, e.g., Europe/Prague)
National prefix, 2, 3 Prefixes used to classify calls as national vs. international (used in Active calls view)
Max national number length Numbers longer than this are classified as international regardless of prefix
Date format PHP date format string (default: Y-m-d). See PHP DateTime format
Time format PHP time format string (default: G:i:s). See PHP DateTime format
Week start First day of the week for calendar displays

Intervals

Default time intervals for various GUI views and filters.

Setting Description
Default CDR interval Default time filter when entering the CDR section. If set to "specified number of days", configure in the next option
Default CDR interval in days Number of days for the CDR filter (only editable if above is set to "specified number of days")
Default dashboard interval Default time filter when entering the dashboard
Default Legs by CID interval Time window (+/-) for finding related calls in the Legs by CID tab (default: 5 seconds)
Default Legs by header interval Time window (+/-) for finding related calls in the Legs by header tab (default: 5 seconds)

Email / HTTP Referer

Email configuration settings.

Setting Description
DEFAULT_EMAIL_FROM Default "From" address for outgoing emails
Disable email plain text Enable to force HTML-only emails. Useful for mail clients that display only plain text incorrectly (e.g., older Outlook versions)

GeoIP

Configuration for GeoIP services used in the CDR Map view.

Setting Description
Use GeoIP local database Enable/disable the internal GeoIP database (if loaded via Load GeoIP Data)
GeoIP maxmind.com KEY API key for MaxMind GeoIP service
GeoIP ipinfodb.com KEY API key for IPInfoDB service

Advanced

Advanced configuration options for power users and specific use cases.

Setting Description
Enable CDR group panel Show/hide the group panel at the bottom of the CDR view
ENABLE_CDR_FORCE_INDEX_CALLDATE Force use of the calldate index on CDR queries. Enable only for unoptimized MySQL installations experiencing slow queries
Enable database IP reverse lookup Resolve IP addresses to names using the internal IP lookup table
Enable DNS reverse lookup Resolve IP addresses to names using DNS
Enable database number lookup Resolve phone numbers to names using the internal prefix lookup table
Disable rtpfirstleg param Disable the --rtp-firstleg parameter for PCAP audio decoding. Enable only if experiencing audio issues
Disable URL wav protection Skip session authentication for WAV file downloads. Use with WAV download key for secure external access
WAV download key Secret key required for WAV downloads when URL protection is disabled
Hide SIP domain in CDR Hide SIP domains in the CDR display
Hide live play Hide live playback buttons in Active calls
Hide WAV play Hide WAV playback buttons in CDR view
Upload sniffer conf path Path to voipmonitor.conf for PCAP upload functionality
CDR share key Secret string used to generate unique hashes for CDR share URLs
Folder for export CSV Directory where CSV files from crontab scheduler tasks are saved
CSV name prefix Optional prefix for CSV filenames generated by crontab tasks
Delete CSV after X days Auto-delete CSV files older than specified days

Localization

Create custom translations for the GUI interface. Localizations are not 100% complete; please report missing translation items.

  • Red numbers indicate untranslated items, which is useful after upgrading to identify new strings
  • Changes take effect after logout/login

CDR View Custom URL

Add custom hyperlinks to the CDR view Commands column. This is useful for integrating external monitoring or CRM systems.

Configuration

Navigate to GUI > Settings > CDR view custom URL.

You can include CDR parameters in the URL using two methods:

  1. Via Parameters and Custom headers items: Values are appended as query parameters (e.g., ?paramName=value)
  2. Directly in URL: Use {{paramName}} syntax, which is replaced with the actual value

Display

Configured custom URLs appear as links in the Commands column of the CDR view.

AI Summary for RAG

Summary: This article documents VoIPmonitor GUI settings including sensor configuration, CDR custom headers with their limitations, GeoIP data loading, system configuration (basic, database, national, intervals, email, GeoIP, advanced), localization, and custom CDR URLs. Key topics: custom headers store raw SIP header values without regexp extraction or delimiter aggregation; sensor troubleshooting for non-deletable local sensors in server/probe deployments.

Keywords: GUI settings, sensors, CDR custom headers, header limitations, GeoIP, system configuration, timezone, national prefix, date format, intervals, advanced settings, localization, custom URL, CSV export

Key Questions:

  • How do I configure sensors in the VoIPmonitor GUI?
  • How do I delete a non-deletable local sensor in a server/probe deployment?
  • How do I create and configure CDR custom headers?
  • Can I extract part of a SIP header using regexp in custom headers?
  • Can I aggregate multiple occurrences of a SIP header?
  • What are the limitations of CDR custom headers?
  • How do I load GeoIP data for the map view?
  • What system configuration options are available?
  • How do I set national prefixes and date/time formats?
  • What interval settings control CDR and dashboard filters?
  • How do I configure GeoIP services?
  • How do I create GUI localizations?
  • How do I add custom URLs to the CDR view?
  • How do I export CDRs to CSV via crontab scheduler?
Retrieved from "https://www.voipmonitor.org/doc/index.php?title=Settings&oldid=6601"