The configuration file is a standard text file. The basic format is: [Section String] Key Name=Value String Comments are marked with a hash ( kill -HUP `cat /var/run/gnugk.pid` Section [Gatekeeper::Main]

Default: N/A

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. Default:

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. Default:

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 (,). NetworkInterfaces=192.168.1.1/24,10.0.0.1/0 Default: N/A

Specify the network interfaces of the gatekeeper. By default the gatekeeper will detect the interfaces of your host automatically. There are two situations that you may want to use this option. One is automatically detection failed, another is the gatekeeper is behind a NAT box and allow endpoints with public IPs to register with. In this case you should set the option just as the gatekeeper is running on the NAT box. Default:

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. Default:

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 Default:

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. 100 || Calls > 50/ Default: N/A

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. Furthermore, you may explicitly redirect all endpoints by setting this option to Default: N/A

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. 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. Default: N/A

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). Default: N/A

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. Default:

Status port to monitor the gatekeeper. See for details. Default:

Signal call IDs in ACF/ARJ/DCF/DRJ/RouteRequest messages on the status port. See for details. Default:

Default output trace level for new status interface clients. See for details. Default:

Control default format of timestamp strings generated by the gatekeeper. This option affects , , and other modules, except . You can further customize timestamp formatting per-module by configuring per-module There are four predefined formats:

If you need another format, you can build your own format string, using rules known from Default:

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 Default: N/A

Define a global padding byte to be used during password encryption/decryption. It can be overridden by setting Most users will never need to change any of the following values. They are mainly used for testing or very sophisticated applications. Default:

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. Default:

The RAS channel TSAP identifier for unicast. Default:

The RAS channel TSAP identifier for multicast. Default:

The multicast group for the RAS channel. Default:

Default port for call signaling channel of endpoints. Default:

Queue length for incoming TCP connection. Default:

Time in milliseconds for read timeout on call signaling channels (Q931). Default:

Time in milliseconds for read timeout on status channel. Default:

Time in milliseconds for write timeout on status channel. Section [GkStatus::Auth]

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. Default:

Possible values are ip=value where regex=^195\.71\.(129|131)\.[0-9]+$ section. Moreover, these rules can be combined by "|" or "&". For example, rule=explicit | regex The IP of client must match rule=regex & password The IP of client must match Default:

Only used when Default:

Whether to allow shutdown the gatekeeper via status port. Default:

How long (in seconds) to wait before rejecting invalid username/password for the status line access. Section [LogFile]

This section defines log file related parameters. Currently it allows users to specify log file rotation options. Default: N/A

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 Rotate=Hourly RotateTime=45 Rotate=Daily RotateTime=23:00 Rotate=Weekly RotateDay=Sun RotateTime=00:59 Rotate=Monthly RotateDay=31 RotateTime=23:00