Home
· Contact
· Events
· Logos
· Site Map

Download
· Gatekeeper
· Java GUI
· ISDN Gateway
· CTI / ACD

Documentation
· English Manual
· French Manual
· Spanish Manual
· Persian Manual
· Portuguese Manual
· Chinese Manual
· FAQ
· Interoperability
· Intro to H.323
· Usage Examples
· Configuration Notes
· GnuGk and SIP
· Recommended Books
· Success Stories

Tools & Addons
· GnuGk Addons
· Endpoints
· Gateways
· MCUs
· IVRs
· Billing
· Commercial Addons

Development
· Development Version
· Compiling
· NAT Traversal
· Tools
· Authors

This is the manual for GNU Gatekeeper 2.2.7.
A manual for your version is in your GnuGk download archive.

Chapters: Contents · Introduction · Installation · Getting started · Basic Config · Routed Mode & Proxy · Routing · RAS Config · Authentication · Accounting · Neighbors · Per Endpoint Config · Advanced Config · Monitoring

2. Compiling and Installing

2.1 Compiling the Gatekeeper

To build the gatekeeper you need at least PWLib 1.7.5.2 and OpenH323 1.14.4.2 or later. The development version of the gatekeeper usually needs the most recent OpenH323 version available. These libraries are available at OpenH323 Download Page. See the instructions on how to compile the OpenH323 code.

Order of compiling:

1. PWLib (release + debug version)
2. OpenH323
3. OpenH323 test application (not needed, just to make sure everything works so far)
4. The Gatekeeper

On Unix do a configure and make debug or make opt in the gatekeeper directory to build debug or release version, respectively. Use make both to build both versions. Note you have to use GCC 3.3.x or later. The older version may not work. Good practice is to do a make debugdepend or make optdepend in the gatekeeper directory before starting actual compilation (make debug or make opt) - these commands build appropriate dependency lists, so after you will update your sources from CVS, all affected files will get recompiled. Otherwise you can finish with the Gatekeeper partially compiled with the older headers and partially with the updated headers - a very bad thing.

On Windows just open and compile the provided solution (gk.sln) for Microsoft Visual Studio .NET 2003 or the workspace (gk.dsw) for Microsoft Visual Studio 6.0 SP6. Of course, you need to have PWLib and OpenH323 already compiled and appropriate include/library paths set up. If you want to get MySQL or PostgreSQL support, install/compile appropriate client libraries and add HAS_MYSQL=1 and/or HAS_PGSQL=1 to preprocessor macros of the gatekeeper project. You also need to tell the compiler where to find include files/libraries and instruct the linker to link with these client libraries.

Type configure --help to see a detailed list of all compile time options. You can use them to enable or disable some features of the gatekeeper. For example, if you do not need RADIUS just type: configure --disable-radius.

To build the gatekeeper statically linked with the OpenH323 libraries, use make optnoshared.

In order to use the gatekeeper under heavy load, enabling LARGE_FDSET feature (ONLY FOR UNIX VERSION) is recommended (configure --with-large-fdset=4096). Some systems also need to use ulimit in order to allow more than 1024 sockets to be allocated for a single process. Note that the PWLib library starting from version 1.5.3 supports a similar feature too, so you can choose between LARGE_FDSET GnuGk and PWLib implementation. GnuGk native implementation gives better performance results. Maximum LARGE_FDSET value should be calculated based upon predicted maximum sockets usage. A rule of thumb may be:

MAX_NUMBER_OF_CONCURRENT_CALLS * 10 * 120%

Where:
10 = 2 sockets for Q.931 + 2 sockets for H.245 + 6 sockets for RTP and other stuff

2.2 The addpasswd Utility

Status line access authentication and SimplePasswordAuth module require encrypted passwords to be stored in the gatekeeper configuration file. Also since 2.2.2 version, the gatekeeper supports encryption of all passwords in the config. addpasswd utility is required to generate and store these encrypted passwords. This utility is included with the gatekeeper and can be compiled using:

$ make addpasswd

The usage is as follows:

$ addpasswd CONFIG SECTION KEYNAME PASSWORD

Example 1: 'gkadmin' user with 'secret' password has to be added to [GkStatus::Auth] config section to enable status line interface authentication:

$ addpasswd gnugk.ini GkStatus::Auth gkadmin secret

Example 2: 'joe' user with 'secret' password has to be added to [Password] config section to enable endpoint authentication:

$ addpasswd gnugk.ini Password joe secret

Example 3: An encrypted shared secret is added to a RadAuth config section:

$ addpasswd gnugk.ini RadAuth SharedSecret VerySecretPassword

IMPORTANT: KeyFilled variable defines a default initializer for password encryption keys. It can be omitted in the config (it is defined to 0 then), but if it is specified, each time it changes, encrypted passwords have to be regenerated (encrypted again using the addpasswd utility).

2.3 Installing the Gatekeeper

There is no special installation procedure needed. Just copy the executable to the directory you like and create a config file for it. There are several config examples in the etc/ subdirectory of source tree. See section Configuration File for detailed explanations.

For example, in Linux x86 platform, the optimized executable gnugk is produced in obj_linux_x86_r/ subdirectory. You may copy it to /usr/sbin/, create a config in /etc/gnugk.ini and start it by

$ /usr/sbin/gnugk -c /etc/gnugk.ini -o /var/log/gnugk.log -ttt

2.4 Pre-Built Binaries

If you do not wish to compile the gatekeeper from source, there are several pre-built `packages' available from SourceForge. Not all versions will be made available as binaries - check what is available.

Tar packages (.tgz or .tar.gz)

Download the tar file and enter the following command as root, substitute in the name of the file you downloaded.

$ tar xvzf gnugk-x.x.x.tar

Debian packages (.deb)

Debian includes the gatekeeper as gnugk package. You can install it by using the following command as root:

$ apt-get install gnugk

Chapters: Contents · Introduction · Installation · Getting started · Basic Config · Routed Mode & Proxy · Routing · RAS Config · Authentication · Accounting · Neighbors · Per Endpoint Config · Advanced Config · Monitoring