Heplify

Overview

Heplify 서버 내용 정리

Installation

Create homer databases

$ homer-app -create-config-db -database-root-user=postgres -database-host=localhost -database-root-password=postgres -database-homer-user=homer_user
$ homer-app -create-data-db -database-root-user=postgres -database-host=localhost -database-root-password=postgres -database-homer-user=homer_user

Create Tables, Populate defaults, Upgrade

$ homer-app -create-table-db-config 
$ homer-app -populate-table-db-config 
$ homer-app -upgrade-table-db-config 

Start Services

$ systemctl start heplify-server
$ systemctl start homer-app

See also

• https://github.com/sipcapture/homer/wiki/Quick-Install - Quick install

Configurations

Server options

~ # ./heplify-server -version
Could not find toml config file, use flag defaults. <nil>
VERSION: heplify-server 1.19

~ # ./heplify-server -h
Usage of ./heplify-server:
  -alegids
        Change value of AlegIDs. (default [])
  -config
        Change value of Config. (default ./heplify-server.toml)
  -confighttpaddr
        Change value of ConfigHTTPAddr.
  -confighttppw
        Change value of ConfigHTTPPW.
  -customheader
        Change value of CustomHeader. (default [])
  -dbaddr
        Change value of DBAddr. (default localhost:3306)
  -dbbuffer
        Change value of DBBuffer. (default 400000)
  -dbbulk
        Change value of DBBulk. (default 400)
  -dbconftable
        Change value of DBConfTable. (default homer_configuration)
  -dbdatatable
        Change value of DBDataTable. (default homer_data)
  -dbdriver
        Change value of DBDriver. (default mysql)
  -dbdropdays
        Change value of DBDropDays. (default 14)
  -dbdropdayscall
        Change value of DBDropDaysCall. (default 0)
  -dbdropdaysdefault
        Change value of DBDropDaysDefault. (default 0)
  -dbdropdaysregister
        Change value of DBDropDaysRegister. (default 0)
  -dbdroponstart
        Change value of DBDropOnStart. (default false)
  -dbpartisup
        Change value of DBPartIsup. (default 6h)
  -dbpartlog
        Change value of DBPartLog. (default 2h)
  -dbpartqos
        Change value of DBPartQos. (default 6h)
  -dbpartsip
        Change value of DBPartSip. (default 2h)
  -dbpass
        Change value of DBPass.
  -dbrotate
        Change value of DBRotate. (default true)
  -dbshema
        Change value of DBShema. (default homer5)
  -dbtimer
        Change value of DBTimer. (default 4)
  -dbuser
        Change value of DBUser. (default root)
  -dbworker
        Change value of DBWorker. (default 8)
  -dedup
        Change value of Dedup. (default false)
  -discardmethod
        Change value of DiscardMethod. (default [])
  -esaddr
        Change value of ESAddr.
  -esdiscovery
        Change value of ESDiscovery. (default true)
  -espass
        Change value of ESPass.
  -esuser
        Change value of ESUser.
  -forceheppayload
        Change value of ForceHEPPayload. (default [])
  -hepaddr
        Change value of HEPAddr. (default 0.0.0.0:9060)
  -heptcpaddr
        Change value of HEPTCPAddr.
  -heptlsaddr
        Change value of HEPTLSAddr. (default 0.0.0.0:9060)
  -logdbg
        Change value of LogDbg.
  -loglvl
        Change value of LogLvl. (default info)
  -logstd
        Change value of LogStd. (default false)
  -logsys
        Change value of LogSys. (default false)
  -lokibuffer
        Change value of LokiBuffer. (default 100000)
  -lokibulk
        Change value of LokiBulk. (default 400)
  -lokihepfilter
        Change value of LokiHEPFilter. (default [1 5 100])
  -lokitimer
        Change value of LokiTimer. (default 4)
  -lokiurl
        Change value of LokiURL.
  -promaddr
        Change value of PromAddr. (default :9096)
  -promtargetip
        Change value of PromTargetIP.
  -promtargetname
        Change value of PromTargetName.
  -sipheader
        Change value of SIPHeader. (default [ruri_user ruri_domain from_user from_domain to_user callid method user_agent])
  -version
        Change value of Version. (default false)

Generated environment variables:
   HEPLIFYSERVER_ALEGIDS
   HEPLIFYSERVER_CONFIG
   HEPLIFYSERVER_CONFIGHTTPADDR
   HEPLIFYSERVER_CONFIGHTTPPW
   HEPLIFYSERVER_CUSTOMHEADER
   HEPLIFYSERVER_DBADDR
   HEPLIFYSERVER_DBBUFFER
   HEPLIFYSERVER_DBBULK
   HEPLIFYSERVER_DBCONFTABLE
   HEPLIFYSERVER_DBDATATABLE
   HEPLIFYSERVER_DBDRIVER
   HEPLIFYSERVER_DBDROPDAYS
   HEPLIFYSERVER_DBDROPDAYSCALL
   HEPLIFYSERVER_DBDROPDAYSDEFAULT
   HEPLIFYSERVER_DBDROPDAYSREGISTER
   HEPLIFYSERVER_DBDROPONSTART
   HEPLIFYSERVER_DBPARTISUP
   HEPLIFYSERVER_DBPARTLOG
   HEPLIFYSERVER_DBPARTQOS
   HEPLIFYSERVER_DBPARTSIP
   HEPLIFYSERVER_DBPASS
   HEPLIFYSERVER_DBROTATE
   HEPLIFYSERVER_DBSHEMA
   HEPLIFYSERVER_DBTIMER
   HEPLIFYSERVER_DBUSER
   HEPLIFYSERVER_DBWORKER
   HEPLIFYSERVER_DEDUP
   HEPLIFYSERVER_DISCARDMETHOD
   HEPLIFYSERVER_ESADDR
   HEPLIFYSERVER_ESDISCOVERY
   HEPLIFYSERVER_ESPASS
   HEPLIFYSERVER_ESUSER
   HEPLIFYSERVER_FORCEHEPPAYLOAD
   HEPLIFYSERVER_HEPADDR
   HEPLIFYSERVER_HEPTCPADDR
   HEPLIFYSERVER_HEPTLSADDR
   HEPLIFYSERVER_LOGDBG
   HEPLIFYSERVER_LOGLVL
   HEPLIFYSERVER_LOGSTD
   HEPLIFYSERVER_LOGSYS
   HEPLIFYSERVER_LOKIBUFFER
   HEPLIFYSERVER_LOKIBULK
   HEPLIFYSERVER_LOKIHEPFILTER
   HEPLIFYSERVER_LOKITIMER
   HEPLIFYSERVER_LOKIURL
   HEPLIFYSERVER_PROMADDR
   HEPLIFYSERVER_PROMTARGETIP
   HEPLIFYSERVER_PROMTARGETNAME
   HEPLIFYSERVER_SIPHEADER
   HEPLIFYSERVER_VERSION

flag: help requested

만약 HEPLIFYSERVER_CONFIGHTTPADDR 및 -confighttpaddr 옵션을 지정했다면 지정한 주소로 접속해 서버 설정을 수정할 수 있다.

Client options

Use heplify 1.56 like: ./heplify [option]
  -assembly_debug_log
        If true, the github.com/google/gopacket/tcpassembly library will log verbose debugging information (at least one line per packet)
  -assembly_memuse_log
        If true, the github.com/google/gopacket/tcpassembly library will log information regarding its memory use every once in a while.
  -b int
        Interface buffersize (MB) (default 32)
  -d string
        Enable certain debug selectors [fragment,layer,payload,rtp,rtcp,sdp]
  -dd
        Deduplicate packets
  -di string
        Discard uninteresting packets by any string
  -dim string
        Discard uninteresting SIP packets by CSeq [OPTIONS,NOTIFY]
  -e    Log to stderr and disable syslog/file output
  -erspan
        erspan
  -fi string
        Filter interesting packets by any string
  -hi uint
        HEP node ID (default 2002)
  -hn string
        HEP node Name
  -hp string
        HEP node PW
  -hs string
        HEP server address (default "127.0.0.1:9060")
  -i string
        Listen on interface (default "any")
  -l string
        Log level [debug, info, warning, error] (default "info")
  -lp int
        Loop count over ReadFile. Use 0 to loop forever (default 1)
  -m string
        Capture modes [SIP, SIPDNS, SIPLOG, SIPRTCP] (default "SIPRTCP")
  -n string
        Log filename (default "heplify.log")
  -nt string
        Network types are [udp, tcp, tls] (default "udp")
  -o    Read packet for packet
  -p string
        Log filepath (default "./")
  -pr string
        Portrange to capture SIP (default "5060-5090")
  -protobuf
        Use Protobuf on wire
  -rf string
        Read pcap file
  -rs
        Use packet timestamps with maximum pcap read speed
  -rt int
        Pcap rotation time in minutes (default 60)
  -s int
        Snaplength (default 8192)
  -sl
        Log to syslog
  -t string
        Capture types are [pcap, af_packet] (default "pcap")
  -tcpassembly
        If true, tcpassembly will be enabled
  -version
        Show heplify version
  -vlan
        vlan
  -wf string
        Path to write pcap file
  -zf