Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
kamailio(8)		       Kamailio SIP Server		     kamailio(8)

NAME
     kamailio - a very fast and configurable SIP server

SYNOPSIS
     kamailio [ -hfcmMdVIhEebBlLnvKrRDTNWwtugPGSQOaAxXY ] [ -a auto-aliases-mode
     ] [ -A pre-processor-define ] [ -b max_rcv_buf_size ] [ -B max_snd_buf_size
     ]	[  -f config-file ] [ -g gid ] [ -G pgid-file ] [ -l address ] [ -L mod-
     ules-dir ] [ -M private_mem_size ] [ -m shared_mem_size ] [ -n processes-no
     ] [ -N tcp processes-no ] [ -P pid-file ] [ -t chroot-dir ] [ -u uid ] [ -w
     working-dir ]

DESCRIPTION
     kamailio is a very fast and configurable SIP (RFC3261) server.

OPTIONS
     -a auto-aliases-mode
		 Enable auto-aliases with 'yes' or 'on', disable  with	'no'  or
		 'off

     --alias=val
		 Add  an  alias,  the  value has to be '[proto:]hostname[:port]'
		 (like for 'alias' global parameter)

     --atexit=val
		 Control atexit  callbacks  execution  from  external  libraries
		 which	may  access  destroyed shm memory causing crash on shut-
		 down.	Can be y[es] or 1 to enable atexit callbacks, n[o] or  0
		 to disable, default is yes.

     -A pre-processor-define
		 Add config pre-processor define (e.g., -A WITH_AUTH, -A N=1, -A
		 X='"Y"')

     -b max_rcv_buf_size
		 Maximum  OS  UDP receive buffer size which will not be exceeded
		 by auto-probing-and-increase procedure even if OS allows.

     -B max_snd_buf_size
		 Maximum OS UDP send buffer size which will not be  exceeded  by
		 auto-probing-and-increase procedure even if OS allows.

     -c 	 Checks  the config file and displays the aliases and listen in-
		 terface list.

     --cfg-print
		 Print configuration file evaluating includes and ifdefs

     -d 	 Turns on debugging, multiple -d increase the debug level.

     --debug=val
		 Debugging level value

     -D 	 Control how daemonize is done:
		 -D - do not fork (almost) anyway (run	in  foreground,  doesn't
		 fork into daemon mode);
		 -DD  -  do  not  daemonize  creator (main process is not daemo-
		 nized);
		 -DDD - daemonize (default)

     -e 	 Log messages printed in terminal colors (requires -E)

     -E 	 Sends all the log messages to stderr.

     -f config-file
		 Reads the configuration from	 config-file  (default	/usr/lo-
		 cal/etc/kamailio/kamailio.cfg ).

     -g gid	 Changes the group id under which kamailio runs.

     -G pgid-file
		 Creates  a  file  containing  the  pgid  of  the  main kamailio
		 process.

     -h --help	 Displays a short usage description, including all available op-
		 tions.

     -I 	 Displays details of internal constants and attributes.

     -K 	 Turns on via host checking when forwarding replies.

     -l address  Listens on the specified address/interface.  Multiple	-l  mean
		 listening   on   multiple  addresses.	The  address  format  is
		 [proto:]addr_lst[:port][/advaddr][/socket_name],	   where
		 proto=udp|tcp|tls|sctp,   addr_list  =  addr|(addr,  addrress),
		 addr=host|ip_address|interface_name,  advaddr=addr[:port]  (ad-
		 vertised  address)  and  socket_name=identifying name.  E.g: -l
		 localhost,   -l   udp:127.0.0.1:5080,	  -l	eth0:5062,    -l
		 udp:127.0.0.1:5080/1.2.3.4:5060,  -l udp:127.0.0.1:5080//local,
		 -l udp:127.0.0.1:5080/1.2.3.4:5060/local, -l The default behav-
		 iour is to listen on all the interfaces.

     --loadmodule=name
		 load the module specified by name

     --log-engine=name
		 log engine name and data

     -L modules-dir
		 Specifies the directory where to look for kamailio modules (de-
		 fault:   /usr/local/lib/kamailio/modules   or	  /usr/lib64/ka-
		 mailio/modules)

     -m shared_mem_size
		 Size	of  the  shared  memory  which	will  be  allocated  (in
		 Megabytes).

     --modparam=modname:paramname:type:value
		 set the module parameter type has to be 's'  for  string  value
		 and  'i'  for int value, example: --modparam=corex:alias_subdo-
		 mains:s:" NAME ".org

     -M private_mem_size
		 Size of the private memory which will be allocated per  process
		 (in Megabytes).

     -n processes-no
		 Specifies the number of children processes forked per interface
		 (default 8).

     -N tcp processes-no
		 Specifies the number of children processes forked to handle tcp
		 incoming connections (by default is equal to -n ).

     -O optimization-level
		 Script optimization level (debugging option).

     -P pid-file
		 Creates a file containing the pid of the main kamailio process.

     -Q 	 Number of sctp child processes (default: equal to -n ).

     -r 	 Uses dns to check if it is necessary to add a "received=" field
		 to a via.

     -R 	 Same as -r but uses reverse dns (to use both: -rR ).

     --server-id=num
		 Set the value for server_id

     --subst=exp
		 Set a subst preprocessor directive

     --substdef=exp
		 Set a substdef preprocessor directive

     --substdefs=exp
		 Set a substdefs preprocessor directive.

     -S 	 Disables SCTP support.

     -t chroot-dir
		 Forces kamailio to chroot after reading the config file.

     -T 	 Disables TCP support.

     -u uid	 Changes the user id under which kamailio runs.

     -v -V --version
		 Displays the version number.

     -x name	 Specify internal manager for shared memory (shm) can be: fm, qm
		 or tlsf

     -X name	 Specify  internal  manager for private memory (pkg) if omitted,
		 the one for shm is used

     -Y dir	 Runtime dir path

     -w working-dir
		 Specifies the working directory. In the very  improbable  event
		 that kamailio will crash, the core file will be generated here.

     -W type	 poll  method  (depending  on  support	in  OS, it can be: poll,
		 epoll_lt, epoll_et, sigio_rt, select, kqueue, /dev/poll).

     FILES
	    /usr/local/sbin/kamailio
	    /usr/local/etc/kamailio/kamailio.cfg
	    /usr/local/lib/kamailio/modules/*

AUTHORS
     see /usr/local/share/doc/kamailio/AUTHORS

SEE ALSO
     kamailio.cfg(5)

     Full documentation on kamailio, including	configuration  guidelines,  FAQs
     and licensing conditions, is available at https://www.kamailio.org/

     For reporting  bugs see https://github.com/kamailio/kamailio/issues.

     Mailing lists:
     sr-users@lists.kamailio.org - kamailio user community
     sr-dev@lists.kamailio.org - kamailio development, new features and unstable version

kamailio			   03.02.2021			     kamailio(8)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=kamailio&sektion=8&manpath=FreeBSD+Ports+15.1.quarterly>

home | help