resiprocate/apps/reConServer/reConServer.8

.TH reConServer 8 "August 2013"
.SH NAME
reConServer \- reConServer SIP conferencing server
.SH SYNOPSIS
.B
reConServer [OPTIONS...]

.SH DESCRIPTION
.B reConServer
is an open-source, free SIP conferencing server. SIP is changing the way
people communicate using the Internet. It is not only about making phone
calls over the Net. The SIP protocol and its extensions defines the way of
establishing, modifying and ending interactive sessions, no matter if they
are voice, video, IM or a combination of them. At the heart of SIP
architecture, there are certain services which needs to be provided at some
place of the network.
.B reConServer
provides SIP conferencing services. These services enable audio conferencing
between multiple participants.

.SH OPTIONS
.TP
\fB\-l\fR, \fB\-\-log\-type\fR=\fBcout\fR|\fBsyslog\fR|\fBcerr\fR
Set where to send logging messages. The default \fBcout\fR sends the
messages to standard output, \fBcerr\fR uses the standard error pipe.
With \fBsyslog\fR the messages are send to the system log using the logging
facility \fBlocal6\fR. See
.BR syslogd (8)
or
.BR syslog.conf (5)
for more information.
.TP
\fB\-v\fR, \fB\-\-log\-level\fR=\fBSTACK\fR|\fBDEBUG\fR|\fBINFO\fR|\fBWARNING\fR|\fBALERT\fR
Set the minimum level a logging message needs to have in order to by
written. The severity rises from left to right in the above order. The
default is to log messages with level \fBINFO\fR or above.
.TP
\fB\-r\fR, \fB\-\-record\-route\fR=\fIsip:example.com\fR
Activate record routing. The argument is the URI used in the Record-Route
header field.
.TP
\fB\-\-udp\fR=\fI5060\fR
Specify the port to use for the UDP transport. Set to 0 to turn
UDP off. Defaults to port 5060.
.TP
\fB\-\-tcp\fR=\fI5060\fR
Specify the port to use for the TCP transport. Set to 0 to turn TCP
off. Defaults to port 5060.
.TP
\fB\-t\fR, \fB\-\-tls\-domain\fR=\fIexample.com\fR
Act as a TLS server for specified domain.
.TP
\fB\-\-tls\fR=\fI5061\fR
Set the port to use for the TLS transport. Set to 0 to turn TLS off.
Defaults to port 5061.
.TP
\fB\-\-dtls\fR=\fI0\fR
Set the port to use for the DTLS transport. Set to 0 to turn DTLS off
which is the default.
.TP
\fB\-\-enable\-cert\-server
Run a cert server.
.TP
\fB\-c\fR, \fB\-\-cert\-path\fR=\fISTRING\fR
Set the path for certificates. Defaults to \fB~/.sipCerts\fR.
.TP
\fB\-\-enable\-v6\fR
Enable IPv6.
.TP
\fB\-\-disable\-v4\fR
Disable IPv4.
.TP
\fB\-\-disable\-auth\fR
Disable DIGEST challenges for certain SIP requests.
.TP
\fB\-\-disable\-web\-auth\fR
Disable authentication for the web administration server.
.TP
\fB\-\-disable\-reg\fR
Disable the registrar.
.TP
\fB\-i\fR, \fB\-\-interfaces\fR=\fIsip:10.1.1.1:5065;transport=tls\fR
Specify interfaces to add transports to. Each transport is given as a
SIP-URI with the IP address and port of the local interface as the
hostport part and the transport protocol as a \fBtransport\fR parameter.
Several transports are separated by a comma.

For example, to set up two transports, one for TLS and one for UDP use
.B sip:192.168.1.200:5060;transport=tls,sip:192.168.1.200:5060;transport=udp
.TP
\fB\-d\fR, \fB\-\-domains\fR=\fIexample.com,foo.com\fR
Specify the list of domains this proxy is authorative for separated by
comma.
.TP
\fB\-R\fR, \fB\-\-route\fR=\fIsip:p1.example.com,sip:p2.example.com\fR
Specify a route set where all requests this proxy is authorative for are
sent to. Using this option overides the routes set through the web
interface.
.TP
\fB\-\-reqChainName\fR=\fISTRING\fR
Name of request chain used for processing requests. Currently, the only
chain available is \fBdefault\fR.
.TP
\fB\-\-http\fR=\fI5080\fR
Specify the port used by the HTTP server. Defaults to 5080.
.TP
\fB\-\-recursive\-redirect\fR
Enable to handle of 3xx responses in the proxy.
.TP
\fB\-\-q\-value\fR
Enable q-value processing. The q-value can be given in registrations and is
used by the location server to order forwarding for multiple registrations.
Without this option a request is forked to all registrations.
.TP
\fB\-\-q\-value\-behavior\fR=\fBFULL_SEQUENTIAL\fR|\fBEQUAL_Q_PARALLEL\fR|\fBFULL_PARALLEL\fR
Specify forking behavior if \fB\-\-q\-value\fR is given.
With \fBFULL_SEQUENTIAL\fR one target is called after another in the order
of their q values. Using \fBEQUAL_Q_PARALLEL\fR (the default), the request
is sent in
batches of all registrations with the same q value. The batches are again
ordered by the q value.
\fBFULL_PARALLEL\fR causes the request to be sent in parallel to all
registrations.
.TP
\fB\-\-q\-value\-cancel\-btw\-fork\-groups\fR
If given, groups of parallel forks are canceled after the period specified
by the \fB\-\-q\-value\-ms\-before\-cancel\fR option if no response was
received.
.TP
\fB\-\-q\-value\-wait\-for\-terminate\-btw\-fork\-groups\fR
If given, the proxy waits for groups of parallel forks to terminate before
a new group is started. Otherwise, the next group is started once the
waiting time has passed.
.TP
\fB\-\-q\-value\-ms\-between\-fork\-groups\fR=\fIINT\fR
Specify the number of milliseconds to wait for a response from a group of
parallel forks before starting another group.
.TP
\fB\-\-q\-value\-ms\-before\-cancel\fR=\fIINT\fR
Specify the number of milliseconds to wait before cancelling a group of
parallel forks if the \fB\-\-q\-value\-cancel\-btw\-fork\-groups\fR option
is given.
.TP
\fB\-e\fR, \fB\-\-enum\-suffix\fR=\fIe164.arpa\fR
Specify enum suffix to search.
.TP
\fB\-b\fR, \fB\-\-allow\-bad\-reg\fR
Allow To tag in registrations.
.TP
\fB\-\-timer\-C\fR=\fI180\fR
Specify the length of timer C in sec which specifies the time a proxy
waits before generating a timeout response. Set to 0 or a negative value
to turn timer C of completely.
.TP
\fB\-\-admin\-password\fR=\fISTRING\fR
Set the web administrator password.
.PP
Help options:
.TP
\fB\-?\fR, \fB\-\-help\fR
Show a help message.
.TP
\fB\-\-usage
Display brief usage message.
.TP
\fB\-\-version\fR
Display the version information.

.SH SEE ALSO
Repro web site at
.B https://https://github.com/resiprocate/reConServer

.\".SH AUTHORS

.\".SH BUGS