Settings: Difference between revisions

From VoIPmonitor.org
Jump to navigation Jump to search
No edit summary
 
Line 1: Line 1:
= Sensors =
== Sensors ==


If you set id_sensor in /etc/voipmonitor.conf (default is blank) you must create sensor here if you want to download files from sensor like pcap graph wav etc.  
If id_sensor is set in /etc/voipmonitor.conf (default blank), create sensors here to download files like PCAP, graphs, WAV.


*Sensor ID: number defined in /etc/voipmonitor.conf id_sensor = N
* Sensor ID: Number from /etc/voipmonitor.conf id_sensor = N
*Name: name of the sensor
* Name: Sensor name
*Manager IP, Port: used for fetching data, such as pcap / graph files. Default port is 5029
* Manager IP, Port: For fetching data (PCAP/graph files). Default port: 5029
*Remote database parameter: this is useful only in case each sensor writes to different database and you want to find relevant legs in the “Legs by [CID|header]” CDR detail tab. If your sensors writes to the same database leave it blank.  
* Remote database parameter: For finding legs in "Legs by [CID|header]" CDR tab if sensors use different databases. Leave blank if same database.


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


= CDR charts =
== CDR Charts ==


Predefined charts used in [[Call_Detail_Record_-_CDR#Charts|CDR detail charts section]]
Predefined charts for [[Call_Detail_Record_-_CDR#Charts|CDR detail charts section]].


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


== CDR Custom Headers ==


= CDR Custom header =
From sniffer version 7.0RC7, store custom SIP headers to database for viewing/searching: [[Sniffer_configuration#custom_headers]].
 
Since VoIPmonitor sniffer version 7.0RC7 there is new feature [[Sniffer_configuration#custom_headers]] allowing storing custom SIP headers to database - view it and search by it.  


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


== header field ==
=== Header Field ===
This combo box shows all custom headers which are defined in cdr_next.custome_header*. Those columns are created automatically once you set custom_headers in sniffer voipmonitor.conf [[Sniffer_configuration#custom_headers]] and voipmonitor restarts.
 
== name ==
The name of header used in the WEB GUI CDR header panel.
 


== match in sip by header ==
Combo box lists headers from cdr_next.custom_header*. Created automatically on custom_headers in voipmonitor.conf and restart.


Use this header for matching CDR with the same content in CDR section [[Call_Detail_Record_-_CDR#Legs_by_header]]. Practical example is when you have two legs for one call - from your phone to SBC and from SBC to sip provider and you decide that you will put for both legs one unique identifier so both legs will have same string in some custom named header. Please note that you can achieve this also by using [[Sniffer_configuration#match_header]].
=== Name ===


Header name in WEB GUI CDR header panel.


== show as column ==
=== Match in SIP by Header ===


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]].


Show this header in CDR column.
=== Show as Column ===


Display header in CDR column.


[[File:customheaderscdrpanel.png]]
[[File:customheaderscdrpanel.png]]


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


Loads GeoIP data into internal database which is then used for [[Call_Detail_Record_-_CDR#map|CDR detail map]].  
Loads GeoIP data to internal database for [[Call_Detail_Record_-_CDR#map|CDR detail map]].


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


= System configuration =
== System Configuration ==


== Basic ==
=== Basic ===


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


*WEB URL - URL which will be used for hypertext links. For example in email alerts
* WEB URL: For hypertext links (e.g., email alerts)
*sniffer data path - Directory path to the sniffer data (default /var/spool/voipmonitor)
* Sniffer data path: Directory to sniffer data (default: /var/spool/voipmonitor)
*default sensor hostname - default sniffer sensor hostname (localhost). If you have more sensors define it in settings -> sensors
* Default sensor hostname: Default sniffer hostname (localhost). Define multiple in Settings > Sensors
*default sensor TCP port - default sniffer sensor port (5029)
* Default sensor TCP port: Default port (5029)


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


Databse settings
Database settings.


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


== National ==
=== National ===


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


*Timezone - set correct timezone according to your Country / Town
* Timezone: Set to your Country/Town
*National prefix,2,3 - This is for classifying calls to national and international calls. This classification is used in Active calls section.
* National prefix,2,3: Classify national/international calls (used in Active calls)
*Max national number length - Calls with more digits will be international regardless on prefix
* Max national number length: Longer calls are international regardless of prefix
*Date format - Date format with default Y-m-d. http://www.php.net/manual/en/function.date.php
* Date format: Default Y-m-d[](http://www.php.net/manual/en/function.date.php)
*Time format - Time format with default G:i:s. http://www.php.net/manual/en/function.date.php
* Time format: Default G:i:s[](http://www.php.net/manual/en/function.date.php)
*Week start
* Week start
== Intervals ==
 
=== Intervals ===
 
[[File:settings-sysintervals.png]]
[[File:settings-sysintervals.png]]
*Default CDR interval - choose default time interval which is used to filter CDR when you enter CDR section. If you set "specified number of days" you can set custom number of days in following config option:
*Default CDR interval in days - this is possible to edit only when you choose "specified number of days" in Default CDR interval
*Default dashboard interval - choose default time interval which is used to filter CDR when you enter dashboard section
*Default Legs by CID interval - Find all related calls which starts +- internal - default 5 seconds
*Default Legs by header interval - Find all related calls which starts +- internal - default 5 seconds


== EMAIL HTTP REFERER ==
* Default CDR interval: Filter interval on entering CDR section. If "specified number of days", set in next option
* Default CDR interval in days: Editable only if "specified number of days" selected
* Default dashboard interval: Filter interval on entering dashboard
* Default Legs by CID interval: Related calls +- interval (default: 5 seconds)
* Default Legs by header interval: Related calls +- interval (default: 5 seconds)
 
=== EMAIL HTTP REFERER ===
 
[[File:settings-sysemailhttpreferer.png]]
[[File:settings-sysemailhttpreferer.png]]


*DEFAULT_EMAIL_FROM - Default email in From header
* DEFAULT_EMAIL_FROM: Default From header
*Disable email plain text - Some mailers (outlook 2003) does not like plain text and show only plain text part of email messages. If you do not see HTML part enable this option
* Disable email plain text: For mailers showing only plain text (e.g., Outlook 2003); enable to force HTML
== GEOIP ==
 
=== GEOIP ===
 
[[File:settings-sysgeoip.png]]
[[File:settings-sysgeoip.png]]
*Use GEOIP local database - Enable or disable use of internal GEOIP database (if loaded)
 
*GEOIP maxmind.com KEY - Personal key for maxmind.com geoip service
* Use GEOIP local database: Enable/disable internal GEOIP (if loaded)
*GEOIP ipinfodb.com KEY - Personal key for ipinfodb.com
* GEOIP maxmind.com KEY: Personal key for maxmind.com
== Advanced ==
* GEOIP ipinfodb.com KEY: Personal key for ipinfodb.com
 
=== Advanced ===
 
[[File:settings-sysadvanced.png]]
[[File:settings-sysadvanced.png]]


*Enable CDR group panel - Enable/Disable CDR group bottom panel
* Enable CDR group panel: Enable/disable CDR bottom panel
*ENABLE_CDR_FORCE_INDEX_CALLDATE - force index all queries by calldate column which can help on unoptimized mysql installations. Enable it only in case you know exactly what you are doing.
* ENABLE_CDR_FORCE_INDEX_CALLDATE: Force calldate index on queries; for unoptimized MySQL. Enable only if needed.
*Enable database IP reverse lookup - If enabled in CDR IP addresses will be named by internal IP database lookup table
* Enable database IP reverse lookup: Name IPs via internal IP lookup table
*Enable DNS reverse lookup - If enabled in CDR IP address will be named by DNS
* Enable DNS reverse lookup: Name IPs via DNS
*Enable database number lookup - If enabled in CDR tel. numbers will be named by internal prefix database lookup table
* Enable database number lookup: Name numbers via internal prefix lookup table
*Disable rtpfirstleg param - Disable --rtp-firstleg when decoding audio from pcap. - disable only in case you know what you are doing.
* Disable rtpfirstleg param: Disable --rtp-firstleg for PCAP audio decoding; only if needed
*Disable URL wav protection - if true, user is not checked against valid session when downloading WAV. Suitable for downloading WAV outside voipmonitor GUI. If you need to secure it, you can set WAV key
* Disable URL wav protection: Skip session check for WAV download; for external access. Secure with WAV key
*WAV download key - KEY used to download WAV files without user/pass authentication
* WAV download key: Key for WAV download without auth
*Hide SIP domain in CDR - Hide SIP domain in CDR
* Hide SIP domain in CDR: Hide domains
*Hide live play - Hide live play in active calls
* Hide live play: Hide in active calls
*Hide WAV play - Hide play buttons in CDR
* Hide WAV play: Hide play buttons in CDR
*Upload sniffer conf path - Path to sniffer voipmonitor.conf which is used when uploading pcap files.
* Upload sniffer conf path: Path to voipmonitor.conf for PCAP uploads
*CDR share key - String used to generate unique hashes in URL for sharing cdr
* CDR share key: String for unique hashes in CDR share URLs


= Localization =
== Localization ==


Localization allows creates national localizations for the whole GUI. It is not yet 100% complete. If you find some words you need to localize and it is not possible, please let us know.  
Create national localizations for GUI (not 100% complete; report missing items).


There can be unlimited localizations and here is form which creates it:  
Unlimited localizations; form to create:


[[File:settings-localisationform.png]]
[[File:settings-localisationform.png]]
Line 121: Line 127:
[[File:settings-localisationgrid.png]]
[[File:settings-localisationgrid.png]]


The red number items signalize how many items are not localized yet - this is useful in case you upgrade the GUI which has some more features which needs to localize.  
Red numbers indicate untranslated items; useful post-upgrade.


Changes are effective after you logout/login again.
Changes effective after logout/login.


= Cdr view custom url =
== CDR View Custom URL ==


* possibility to add custom link into CDR view (e.g. to the monitoring)
Add custom link to CDR view (e.g., monitoring).


== setting ==
=== Setting ===


* set URL links in GUI->Settings->Cdr view custom URL
Set in '''GUI > Settings > Cdr view custom URL'''.


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


Add parameters/custom headers:
# Via Parameters and Custom headers items: Added as param1Name=value1
# Directly in URL as <nowiki>{{param1Name}}</nowiki>: Replaced with value
=== View ===
Links in Commands column of CDR view.
=== AI Summary for RAG ===


Variable parameters/custom headers can be added in two ways:
'''Summary:''' This article details VoIPmonitor GUI settings: sensors for file downloads, CDR charts/custom headers, GeoIP loading, system configs (basic, database, national, intervals, email, GEOIP, advanced), localization, and custom CDR URLs.
# to add parameters/custom headers with Parameters and Custom headers items. Then these parameters/custom headers will be added to the URL in format param1Name=value1
# to add parameters/custom headers directly into URL in format <nowiki>{{param1Name}}</nowiki>. This string will be replaced with value.


== view ==
'''Keywords:''' GeoIP, system configuration, timezone, email, advanced settings, localization, custom URL


* You can see the URL links in the Commands column in the CDR view
'''Key Questions:'''
* What are CDR custom headers and how to set them?
* How to load GeoIP data?
* What basic system configurations are available?
* How to set national prefixes and time formats?
* What interval settings control CDR and dashboard filters?
* How to configure GEOIP services?
* What advanced options like reverse lookups exist?
* How to create GUI localizations?
* How to add custom URLs to CDR views?

Latest revision as of 14:36, 10 November 2025

Sensors

If id_sensor is set in /etc/voipmonitor.conf (default blank), create sensors here to download files like PCAP, graphs, WAV.

  • Sensor ID: Number from /etc/voipmonitor.conf id_sensor = N
  • Name: Sensor name
  • Manager IP, Port: For fetching data (PCAP/graph files). Default port: 5029
  • Remote database parameter: For finding legs in "Legs by [CID|header]" CDR tab if sensors use different databases. Leave blank if same database.

CDR Charts

Predefined charts for CDR detail charts section.

CDR Custom Headers

From sniffer version 7.0RC7, store custom SIP headers to database for viewing/searching: Sniffer_configuration#custom_headers.

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

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.

Show as Column

Display header in CDR column.

Load GeoIP Data

Loads GeoIP data to internal database for CDR detail map.

System Configuration

Basic

  • WEB URL: For hypertext links (e.g., email alerts)
  • Sniffer data path: Directory to sniffer data (default: /var/spool/voipmonitor)
  • Default sensor hostname: Default sniffer hostname (localhost). Define multiple in Settings > Sensors
  • Default sensor TCP port: Default port (5029)

Database

Database settings.

National

Intervals

  • Default CDR interval: Filter interval on entering CDR section. If "specified number of days", set in next option
  • Default CDR interval in days: Editable only if "specified number of days" selected
  • Default dashboard interval: Filter interval on entering dashboard
  • Default Legs by CID interval: Related calls +- interval (default: 5 seconds)
  • Default Legs by header interval: Related calls +- interval (default: 5 seconds)

EMAIL HTTP REFERER

  • DEFAULT_EMAIL_FROM: Default From header
  • Disable email plain text: For mailers showing only plain text (e.g., Outlook 2003); enable to force HTML

GEOIP

  • Use GEOIP local database: Enable/disable internal GEOIP (if loaded)
  • GEOIP maxmind.com KEY: Personal key for maxmind.com
  • GEOIP ipinfodb.com KEY: Personal key for ipinfodb.com

Advanced

  • Enable CDR group panel: Enable/disable CDR bottom panel
  • 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
  • Enable DNS reverse lookup: Name IPs via DNS
  • Enable database number lookup: Name numbers via internal prefix lookup table
  • 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
  • WAV download key: Key for WAV download without auth
  • Hide SIP domain in CDR: Hide domains
  • Hide live play: Hide in active calls
  • Hide WAV play: Hide play buttons in CDR
  • Upload sniffer conf path: Path to voipmonitor.conf for PCAP uploads
  • CDR share key: String for unique hashes in CDR share URLs

Localization

Create national localizations for GUI (not 100% complete; report missing items).

Unlimited localizations; form to create:

Red numbers indicate untranslated items; useful post-upgrade.

Changes effective after logout/login.

CDR View Custom URL

Add custom link to CDR view (e.g., monitoring).

Setting

Set in GUI > Settings > Cdr view custom URL.

Add parameters/custom headers:

  1. Via Parameters and Custom headers items: Added as param1Name=value1
  2. Directly in URL as {{param1Name}}: Replaced with value

View

Links in Commands column of CDR view.

AI Summary for RAG

Summary: This article details VoIPmonitor GUI settings: sensors for file downloads, CDR charts/custom headers, GeoIP loading, system configs (basic, database, national, intervals, email, GEOIP, advanced), localization, and custom CDR URLs.

Keywords: GeoIP, system configuration, timezone, email, advanced settings, localization, custom URL

Key Questions:

  • What are CDR custom headers and how to set them?
  • How to load GeoIP data?
  • What basic system configurations are available?
  • How to set national prefixes and time formats?
  • What interval settings control CDR and dashboard filters?
  • How to configure GEOIP services?
  • What advanced options like reverse lookups exist?
  • How to create GUI localizations?
  • How to add custom URLs to CDR views?
Retrieved from "https://www.voipmonitor.org//doc/index.php?title=Settings&oldid=5737"