<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> <HTML> <HEAD> <META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.21"> <TITLE>OpenH323 Gatekeeper - The GNU Gatekeeper: Basic Gatekeeper Configuration</TITLE> <LINK HREF="manual-5.html" REL=next> <LINK HREF="manual-3.html" REL=previous> <LINK HREF="manual.html#toc4" REL=contents> </HEAD> <BODY> <A HREF="manual-5.html">Next</A> <A HREF="manual-3.html">Previous</A> <A HREF="manual.html#toc4">Contents</A> <HR> <H2><A NAME="s4">4.</A> <A HREF="manual.html#toc4">Basic Gatekeeper Configuration</A></H2> <P>The behavior of the gatekeeper is completely determined by the command line options and configuration file. Some command line options may override the setting of the configuration file. For example, the option <CODE>-l</CODE> overrides the setting <CODE>TimeToLive</CODE> in the configuration file.</P> <H2><A NAME="commandline"></A> <A NAME="ss4.1">4.1</A> <A HREF="manual.html#toc4.1">Command Line Options</A> </H2> <P>Almost every option has a short and a long format, e.g., <CODE>-c</CODE> is the same as <CODE>--config</CODE>.</P> <H3>Basic</H3> <P> <DL> <DT><B><CODE>-h --help</CODE></B><DD><P>Show all available options and quit the program.</P> <DT><B><CODE>-c --config filename</CODE></B><DD><P>Specify the configuration file to use.</P> <DT><B><CODE>-s --section section</CODE></B><DD><P>Specify which main section to use in the configuration file. The default is [Gatekeeper::Main].</P> <DT><B><CODE>-i --interface IP</CODE></B><DD><P>Specify the interface (IP number) that the gatekeeper listens to. You should leave out this option to let the gatekeeper automatically determine the IP it listens to, unless you want the gatekeeper only binds to a specified IP.</P> <DT><B><CODE>-l --timetolive n</CODE></B><DD><P>Specify the time-to-live timer (in seconds) for endpoint registration. It overrides the setting <CODE>TimeToLive</CODE> in the configuration file. See <A HREF="#ttl">there</A> for detailed explanations.</P> <DT><B><CODE>-b --bandwidth n</CODE></B><DD><P>Specify the total bandwidth available for the gatekeeper. Without specifying this option, the bandwidth management is disable by default.</P> <DT><B><CODE>--pid filename</CODE></B><DD><P>Specify the pid file, only valid for Unix version.</P> <DT><B><CODE>-u --user name</CODE></B><DD><P>Run the gatekeeper process as this user. Only valid for Unix versions.</P> <DT><B><CODE>--core n</CODE></B><DD><P>(Unix only) Enable writing core dump files when the application crashes. A core dump file will not exceed n bytes in size. A special constant "unlimited" may be used to not enforce any particular limit.</P> </DL> </P> <H3>Gatekeeper Mode</H3> <P>The options in this subsection override the settings in the <A HREF="manual-5.html#routed">[RoutedMode] section</A> of the configuration file. <DL> <DT><B><CODE>-d --direct</CODE></B><DD><P>Use direct endpoint call signaling.</P> <DT><B><CODE>-r --routed</CODE></B><DD><P>Use gatekeeper routed call signaling.</P> <DT><B><CODE>-rr --h245routed</CODE></B><DD><P>Use gatekeeper routed call signaling and H.245 control channel.</P> </DL> </P> <H3>Debug Information</H3> <P> <DL> <DT><B><CODE>-o --output filename</CODE></B><DD><P>Write trace log to the specified file.</P> <DT><B><CODE>-t --trace</CODE></B><DD><P>Set trace verbosity. The more <CODE>-t</CODE> you add, the more verbose to output. For example, use <CODE>-ttttt</CODE> to set the trace level to 5.</P> </DL> </P> <H2><A NAME="config"></A> <A NAME="ss4.2">4.2</A> <A HREF="manual.html#toc4.2">Configuration File</A> </H2> <P>The configuration file is a standard text file. The basic format is:</P> <P> <BLOCKQUOTE><CODE> <PRE> [Section String] Key Name=Value String </PRE> </CODE></BLOCKQUOTE> </P> <P>Comments are marked with a hash (<CODE>#</CODE>) or a semicolon (<CODE>;</CODE>) at the beginning of a line.</P> <P>The file <CODE>complete.ini</CODE> contains all available sections for the GnuGk. In most cases it doesn't make sense to use them all at once. The file is just meant as a collection of examples for many settings.</P> <P>The configuration file can be changed at runtime. Once you modify the configuration file, you may issue <CODE>reload</CODE> command via status port, or send a signal <CODE>HUP</CODE> to the gatekeeper process on Unix. For example, <BLOCKQUOTE><CODE> <PRE> kill -HUP `cat /var/run/gnugk.pid` </PRE> </CODE></BLOCKQUOTE> </P> <H3>Section [Gatekeeper::Main]</H3> <P> <UL> <LI><CODE>Fortytwo=42</CODE><BR> Default: <CODE>N/A</CODE><BR> <P>This setting is used to test the presence of the config file. If it is not found, a warning is issued. Make sure it's in all your config files.</P> </LI> <LI><CODE>Name=OpenH323GK</CODE><BR> Default: <CODE>OpenH323GK</CODE><BR> <P>Gatekeeper identifier of this gatekeeper. The gatekeeper will only respond to GRQs for this ID and will use it in a number of messages to its endpoints.</P> </LI> <LI><CODE>Home=192.168.1.1</CODE><BR> Default: <CODE>0.0.0.0</CODE><BR> <P>The gatekeeper will listen for requests on this IP number. By default, the gatekeeper listens on all interfaces of your host. You should leave out this option, unless you want the gatekeeper only to bind to a specified IP. Multiple Home addresses can be used and have to be separated with a semicolon (;) or comma (,).</P> </LI> <LI><CODE>NetworkInterfaces=192.168.1.1/24,10.0.0.1/0</CODE><BR> Default: <CODE>N/A</CODE><BR> <P>Specify the network interfaces of the gatekeeper. By default the gatekeeper will detect the interfaces of your host automatically. There is situations that you may want to use this option. One is automatic detection fails. If you are using GnuGk behind a NAT box then you should use the ExternalIP setting which will automatically configure GnuGK to operate as if it was on the NAT box and superceded using this entry.</P> </LI> <LI><CODE>EndpointIDSuffix=_gk1</CODE><BR> Default: <CODE>_endp</CODE><BR> <P>The gatekeeper will assign a unique identifier to each registered endpoint. This option can be used to specify a suffix to append to the endpoint identifier. This is only useful when using more than one gatekeeper.</P> </LI> <LI> <A NAME="ttl"></A> <CODE>TimeToLive=300</CODE><BR> Default: <CODE>-1</CODE><BR> <P>An endpoint's registration with a gatekeeper may have a limited life span. The gatekeeper specifies the registration duration of an endpoint by including a <B>timeToLive</B> field in the RCF message. After the specified time, the registration has expired. The endpoint shall periodically send an RRQ having the <B>keepAlive</B> bit set prior to the expiration time. Such a message may include a minimum amount of information as described in H.225.0. This is called a lightweight RRQ.</P> <P>This configuration setting specifies the time-to-live timer in seconds until the registration expires. Note the endpoint may request a shorter <B>timeToLive</B> in the RRQ message to the gatekeeper. To avoid an overload of RRQ messages, the gatekeeper automatically adjusts this timer to 60 seconds if you give a lesser value!</P> <P>After the expiration time, the gatekeeper will subsequently send two IRQ messages to query if the endpoint is still alive. If the endpoint responds with an IRR, the registration will be extended. Otherwise the gatekeeper will send a URQ with reason <B>ttlExpired</B> to the endpoint. The endpoint must then re-register with the gatekeeper using a full RRQ message.</P> <P>To disable this feature, set it to <CODE>-1</CODE>.</P> </LI> <LI><CODE>TotalBandwidth=100000</CODE><BR> Default: <CODE>-1</CODE><BR> <P>Total bandwidth available to be given to endpoints. By default this feature is off. Be careful when using it, because many endpoints have buggy implementations.</P> </LI> <LI><CODE>RedirectGK=Endpoints > 100 || Calls > 50</CODE><BR> Default: <CODE>N/A</CODE><BR> <P>This option allow you to redirect endpoints to alternate gatekeepers when the gatekeeper overloaded. For example, with the above setting the gatekeeper will reject an RRQ if registered endpoints exceed 100, or reject an ARQ if concurrent calls exceed 50.</P> <P>Furthermore, you may explicitly redirect all endpoints by setting this option to <CODE>temporary</CODE> or <CODE>permanent</CODE>. The gatekeeper will return an RAS rejection message with a list of alternate gatekeepers defined in <CODE>AlternateGKs</CODE>. Note that a <CODE>permanent</CODE> redirection means that the redirected endpoints will not register with this gatekeeper again. Please also note the function only takes effect to H.323 version 4 compliant endpoints.</P> </LI> <LI><CODE>AlternateGKs=1.2.3.4:1719:false:120:OpenH323GK</CODE><BR> Default: <CODE>N/A</CODE><BR> <P>We allow for existence of another gatekeeper to provide redundancy. This is implemented in a active-active manner. Actually, you might get into a (valid !) situation where some endpoints are registered with the first and some are registered with the second gatekeeper. You should even be able use the two gatekeepers in a round_robin fashion for load-sharing (that's untested, though :-)). If you read on, "primary GK" refers to the gatekeeper you're currently configuring and "alternate GK" means the other one. The primary GK includes a field in the RCF to tell endpoints which alternate IP and gatekeeper identifier to use. But the alternate GK needs to know about every registration with the primary GK or else it would reject calls. Therefore our gatekeeper can forward every RRQ to an alternate IP address.</P> <P>The AlternateGKs config option specifies the fields contained in the primary GK's RCF. The first and second fields of this string define where (IP, port) to forward to. The third tells endpoints whether they need to register with the alternate GK before placing calls. They usually don't because we forward their RRQs, so they get registered with the alternate GK, too. The fourth field specified the priority for this GK. Lower is better, usually the primary GK is considered to have priority 1. The last field specifies the alternate gatekeeper's identifier.</P> </LI> <LI><CODE>SendTo=1.2.3.4:1719</CODE><BR> Default: <CODE>N/A</CODE><BR> <P>Although this information is contained in AlternateGKs, you must still specify which address to forward RRQs to. This might differ from AlternateGK's address, so it's a separate config option (think of multihomed machines).</P> </LI> <LI><CODE>SkipForwards=1.2.3.4,5.6.7.8</CODE><BR> Default: <CODE>N/A</CODE><BR> <P>To avoid circular forwarding, you shouldn't forward RRQs you get from the other GK (this statement is true for both, primary and alternate GK). Two mechanisms are used to identify whether a request should be forwarded. The first one looks for a flag in RRQ. Since few endpoints implement this, we need a second, more reliable way. Specify the other gatekeeper's IP in this list.</P> </LI> <LI><CODE>StatusPort=7000</CODE><BR> Default: <CODE>7000</CODE><BR> <P>Status port to monitor the gatekeeper. See <A HREF="manual-13.html#monitor">this section</A> for details.</P> </LI> <LI><CODE>SignalCallId=1</CODE><BR> Default: <CODE>0</CODE><BR> <P>Signal call IDs in ACF/ARJ/DCF/DRJ/RouteRequest messages on the status port. See <A HREF="manual-13.html#monitor">this section</A> for details.</P> </LI> <LI><CODE>StatusTraceLevel=2</CODE><BR> Default: <CODE>2</CODE><BR> <P>Default output trace level for new status interface clients. See <A HREF="manual-13.html#monitor">this section</A> for details.</P> </LI> <LI><CODE>TimestampFormat=ISO8601</CODE><BR> Default: <CODE>Cisco</CODE><BR> <P>Control default format of timestamp strings generated by the gatekeeper. This option affects <A HREF="manual-9.html#sqlacct">[SqlAcct]</A>, <A HREF="manual-9.html#radacct">[RadAcct]</A>, <A HREF="manual-9.html#fileacct">[FileAcct]</A> and other modules, except <A HREF="manual-12.html#calltable">[CallTable]</A>. You can further customize timestamp formatting per-module by configuring per-module <CODE>TimestampFormat</CODE> setting.</P> <P>There are four predefined formats: <UL> <LI><CODE>RFC822</CODE> - a default format used by the gatekeeper (example: Wed, 10 Nov 2004 16:02:01 +0100)</LI> <LI><CODE>ISO8601</CODE> - standard ISO format (example: 2004-11-10 T 16:02:01 +0100)</LI> <LI><CODE>Cisco</CODE> - format used by Cisco equipment (example: 16:02:01.534 CET Wed Nov 10 2004)</LI> <LI><CODE>MySQL</CODE> - simple format that MySQL can understand (example: 2004-11-10 16:02:01)</LI> </UL> </P> <P>If you need another format, you can build your own format string, using rules known from <CODE>strftime</CODE> C function (see man strftime or search MSDN for strftime). In general, the format string consists of regular character and format codes, preceded by a percent sign. Example: "%Y-%m-%d and percent %%" will result in "2004-11-10 and percent %". Some common format codes: <UL> <LI><CODE>%a</CODE> - abbreviated weekday name</LI> <LI><CODE>%A</CODE> - full weekday name</LI> <LI><CODE>%b</CODE> - abbreviated month name</LI> <LI><CODE>%B</CODE> - full month name</LI> <LI><CODE>%d</CODE> - day of month as decimal number</LI> <LI><CODE>%H</CODE> - hour in 24-hour format</LI> <LI><CODE>%I</CODE> - hour in 12-hour format</LI> <LI><CODE>%m</CODE> - month as decimal number</LI> <LI><CODE>%M</CODE> - minute as decimal number</LI> <LI><CODE>%S</CODE> - second as decimal number</LI> <LI><CODE>%y</CODE> - year without century</LI> <LI><CODE>%Y</CODE> - year with century</LI> <LI><CODE>%u</CODE> - microseconds as decimal number (<B>this is a GnuGk extension</B>)</LI> <LI><CODE>%z</CODE> - time zone abbreviation (+0100)</LI> <LI><CODE>%Z</CODE> - time zone name</LI> <LI><CODE>%%</CODE> - percent sign</LI> </UL> </P> </LI> <LI><CODE>EncryptAllPasswords=1</CODE><BR> Default: <CODE>0</CODE><BR> <P>Enable encryption of all passwords in the config (SQL passwords, RADIUS passwords, [Password] passwords, [GkStatus::Auth] passwords). If enabled, all passwords have to be encrypted using <CODE>addpasswd</CODE> utility. Otherwise only [Password] and [GkStatus::Auth] passwords are encrypted (old behavior).</P> </LI> <LI><CODE>KeyFilled=0</CODE><BR> Default: <CODE>N/A</CODE><BR> <P>Define a global padding byte to be used during password encryption/decryption. It can be overridden by setting <CODE>KeyFilled</CODE> inside a particular config section. Usually, you do not need to change this option.</P> </LI> </UL> </P> <P>Most users will never need to change any of the following values. They are mainly used for testing or very sophisticated applications.</P> <P> <UL> <LI><CODE>UseBroadcastListener=0</CODE><BR> Default: <CODE>1</CODE><BR> <P>Defines whether to listen to broadcast RAS requests. This requires binding to all interfaces on a machine so if you want to run multiple instances of gatekeepers on the same machine you should turn this off.</P> </LI> <LI><CODE>UnicastRasPort=1719</CODE><BR> Default: <CODE>1719</CODE><BR> <P>The RAS channel TSAP identifier for unicast.</P> </LI> <LI><CODE>MulticastPort=1718</CODE><BR> Default: <CODE>1718</CODE><BR> <P>The RAS channel TSAP identifier for multicast.</P> </LI> <LI><CODE>MulticastGroup=224.0.1.41</CODE><BR> Default: <CODE>224.0.1.41</CODE><BR> <P>The multicast group for the RAS channel.</P> </LI> <LI><CODE>EndpointSignalPort=1720</CODE><BR> Default: <CODE>1720</CODE><BR> <P>Default port for call signaling channel of endpoints.</P> </LI> <LI><CODE>ListenQueueLength=1024</CODE><BR> Default: <CODE>1024</CODE><BR> <P>Queue length for incoming TCP connection.</P> </LI> <LI><CODE>SignalReadTimeout=1000</CODE><BR> Default: <CODE>1000</CODE><BR> <P>Time in milliseconds for read timeout on call signaling channels (Q931).</P> </LI> <LI><CODE>StatusReadTimeout=3000</CODE><BR> Default: <CODE>3000</CODE><BR> <P>Time in milliseconds for read timeout on status channel.</P> </LI> <LI><CODE>StatusWriteTimeout=5000</CODE><BR> Default: <CODE>5000</CODE><BR> <P>Time in milliseconds for write timeout on status channel.</P> </LI> <LI><CODE>ExternalIP=myip.no-ip.com</CODE><BR> Default: <CODE>N</CODE>A/<BR> <P>When using GnuGK behind a NAT you can set the external IP address that you wish the GK to masquarade as. This will allow external EP's and other gatekeepers to contact the NATed GK. To work you must port forward the required ports to the GK IP or put the GK in the NAT box DMZ.</P> </LI> <LI><CODE>ExternalIsDynamic=1</CODE><BR> Default: <CODE>0</CODE><BR> <P>Whether the external IP is dynamic and where queries are required to keep the external IP up to date. To work you must specify the External IP with a DNS address maintained by a DDNS service such as www.dyndns.com or www.no-ip.com. </P> </LI> <LI><CODE>DefaultDomain=gnugk.org</CODE><BR> Default: <CODE>N</CODE>A/<BR> <P>When receiving a request for an address in the format user@domain.com. This option will strip the domain from the address matching this value and process the request as the user component only. This is handy when dealing with interdomain calls placed via srv routing policy where the full URI is received. It can also be used in conjunction with the [RasSrv::RewriteAlias] section to convert the received URI into a E164 number for routing. </P> </LI> </UL> </P> <H3><A NAME="gkstatusauth"></A> Section [GkStatus::Auth]</H3> <P>Define a number of rules who is allowed to connect to the status port. Whoever has access to the status port has full control over your gatekeeper. Make sure this is set correctly. <UL> <LI><CODE>rule=allow</CODE><BR> Default: <CODE>forbid</CODE><BR> <P>Possible values are <UL> <LI><CODE>forbid</CODE> - disallow any connection.</LI> <LI><CODE>allow</CODE> - allow any connection</LI> <LI><CODE>explicit</CODE> - reads the parameter <CODE>ip=value</CODE> where <CODE>ip</CODE> is the IP address of the peering client, <CODE>value</CODE> is <CODE>1,0</CODE> or <CODE>allow,forbid</CODE> or <CODE>yes,no</CODE>. If <CODE>ip</CODE> is not listed the parameter <CODE>default</CODE> is used.</LI> <LI><CODE>regex</CODE> - the IP of the client is matched against the given regular expression. <P> <DL> <DT><B>Example:</B><DD><P>To allow client from 195.71.129.0/24 and 195.71.131.0/24: <BLOCKQUOTE> <CODE>regex=^195\.71\.(129|131)\.[0-9]+$</CODE> </BLOCKQUOTE> </P> </DL> </P> </LI> <LI><CODE>password</CODE> - the user has to input appropriate username and password to login. The format of username/password is the same as <A HREF="manual-8.html#password">[SimplePasswordAuth]</A> section. </LI> </UL> </P> <P>Moreover, these rules can be combined by "|" or "&". For example, <UL> <LI><CODE>rule=explicit | regex</CODE><BR> The IP of client must match <CODE>explicit</CODE> <B>or</B> <CODE>regex</CODE> rule. </LI> <LI><CODE>rule=regex & password</CODE><BR> The IP of client must match <CODE>regex</CODE> rule, <B>and</B> the user has to login by username and password.</LI> </UL> </P> </LI> <LI><CODE>default=allow</CODE><BR> Default: <CODE>forbid</CODE><BR> <P>Only used when <CODE>rule=explicit</CODE>.</P> </LI> <LI><CODE>Shutdown=forbid</CODE><BR> Default: <CODE>allow</CODE><BR> <P>Whether to allow shutdown the gatekeeper via status port.</P> </LI> <LI><CODE>DelayReject=5</CODE><BR> Default: <CODE>0</CODE><BR> <P>How long (in seconds) to wait before rejecting invalid username/password for the status line access.</P> </LI> </UL> </P> <H3><A NAME="gkstatusfilteringsect"></A> Section [GkStatus::Filtering]</H3> <P>See <A HREF="manual-13.html#statusportfiltering">Status Port Filtering</A>.</P> <H3><A NAME="logfile"></A> Section [LogFile]</H3> <P>This section defines log file related parameters. Currently it allows users to specify log file rotation options.</P> <P> <UL> <LI><CODE>Rotate=Hourly | Daily | Weekly | Monthly</CODE><BR> Default: <CODE>N/A</CODE><BR> <P>If set, the log file will be rotated based on this setting. Hourly rotation enables rotation once per hour, daily - once per day, weekly - once per week and monthly - once per month. An exact rotation moment is determined by a combination of <CODE>RotateDay</CODE> and <CODE>RotateTime</CODE> variables. During rotation, an existing file is renamed to CURRENT_FILENAME.YYYYMMDD-HHMMSS, where YYYYMMDD-HHMMSS is replaced with the current timestamp, and new lines are logged to an empty file. To disable the rotation, do not set <CODE>Rotate</CODE> parameter or set it to 0.</P> <P> <DL> <DT><B>Example 1 - rotate every hour (00:45, 01:45, ..., 23:45):</B><DD><P><CODE>[LogFile]</CODE><BR> <CODE>Rotate=Hourly</CODE><BR> <CODE>RotateTime=45</CODE><BR></P> </DL> </P> <P> <DL> <DT><B>Example 2 - rotate every day at 23:00 (11PM):</B><DD><P><CODE>[LogFile]</CODE><BR> <CODE>Rotate=Daily</CODE><BR> <CODE>RotateTime=23:00</CODE><BR></P> </DL> </P> <P> <DL> <DT><B>Example 3 - rotate every Sunday at 00:59:</B><DD><P><CODE>[LogFile]</CODE><BR> <CODE>Rotate=Weekly</CODE><BR> <CODE>RotateDay=Sun</CODE><BR> <CODE>RotateTime=00:59</CODE><BR></P> </DL> </P> <P> <DL> <DT><B>Example 4 - rotate on the last day of each month:</B><DD><P><CODE>[LogFile]</CODE><BR> <CODE>Rotate=Monthly</CODE><BR> <CODE>RotateDay=31</CODE><BR> <CODE>RotateTime=23:00</CODE><BR></P> </DL> </P> </LI> </UL> </P> <HR> <A HREF="manual-5.html">Next</A> <A HREF="manual-3.html">Previous</A> <A HREF="manual.html#toc4">Contents</A> </BODY> </HTML>
