Home
· Download
· Support
· Success Stories
· Blog
· Contact
· Imprint
· Privacy Policy

Documentation
• English Manual
· Chinese Manual
· French Manual
· Spanish Manual
· Persian Manual
· Portuguese Manual
· FAQ
· Interoperability
· Usage Examples
· Configuration Notes
· GnuGk and SIP

Tools & Addons
· GUI
· ISDN Gateway
· CTI / ACD
· GnuGk Addons
· Endpoints
· Gateways
· MCUs
· IVRs
· Billing

Development
· Compiling
· Development
· Tools

Misc
· Events
· Recommended Books
· Site Map

This is the manual for GNU Gatekeeper 5.13.
A manual for your version is in your GnuGk download archive.
A PDF version can be found in the download section.

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

The GNU Gatekeeper Manual

Maintainer of this manual: Jan Willamowius <[email protected]>

1. Introduction

• 1.1 About
• 1.2 Copyright
• 1.3 Name
• 1.4 Download
• 1.5 Mailing Lists
• 1.6 Contributors

2. Compiling and Installing

• 2.1 Pre-requisites for Compiling
• 2.2 Installing on Unix
• 2.3 Installing on Windows
• 2.4 The addpasswd utility

3. Getting Started (Tutorial)

• 3.1 A simple first call
• 3.2 Using the Status interface to monitor the gatekeeper
• 3.3 Running the gatekeeper in routed mode
• 3.4 Routing calls to a gateway to reach external users
• 3.5 Rewriting E.164 numbers
• 3.6 Firewalls and NAT
• 3.7 A virtual PBX: Disconnecting calls
• 3.8 Using IPv6
• 3.9 Using servers with multiple IPs
• 3.10 Enabling Audio and Video Encryption

4. Basic Gatekeeper Configuration

• 4.1 Command Line Options
• 4.2 Configuration File
• 4.3 Database Configuration
• 4.4 LUA Scripting
• 4.5 Regular Expressions
• 4.6 Section [Gatekeeper::Main]
• 4.7 Section [GkStatus::Auth]
• 4.8 Section [GkStatus::Filtering]
• 4.9 Section [LogFile]

5. Routed Mode and Proxy Configuration

• 5.1 Section [RoutedMode]
• 5.2 Section [Proxy]
• 5.3 Section [ModeSelection]
• 5.4 Section [ModeVendorSelection]

6. Routing Configuration

• 6.1 Section [RoutingPolicy]
• 6.2 Section [RasSrv::RewriteE164]
• 6.3 Section [RasSrv::RewriteAlias]
• 6.4 Section [RasSrv::GWRewriteE164]
• 6.5 Section [Endpoint::RewriteE164]
• 6.6 Section [Routing::DNS]
• 6.7 Section [Routing::ENUM]
• 6.8 Section [Routing::SRV]
• 6.9 Section [Routing::RDS]
• 6.10 Section [Routing::Explicit]
• 6.11 Section [Routing::Sql]
• 6.12 Section [Routing::Http]
• 6.13 Section [Routing::NeighborSql]
• 6.14 Section [Routing::NumberAnalysis]
• 6.15 Section [Routing::Forwarding]
• 6.16 Section [Routing::CatchAll]
• 6.17 Section [Routing::Lua]
• 6.18 Section [Routing::URIService]
• 6.19 Section [RewriteCLI]
• 6.20 Section [RewriteCLI::SQL]
• 6.21 Section [RewriteSourceAddress]

7. RAS Configuration

• 7.1 Section [ReplyToRasAddress]
• 7.2 Section [RasSrv::GWPrefixes]
• 7.3 Section [RasSrv::PermanentEndpoints]
• 7.4 Section [RasSrv::RRQFeatures]
• 7.5 Section [RasSrv::ARQFeatures]
• 7.6 Section [RasSrv::AssignedAlias]
• 7.7 Section [AssignedAliases::SQL]
• 7.8 Section [RasSrv::AlternateGatekeeper]
• 7.9 Section [AlternateGatekeepers::SQL]
• 7.10 Section [RasSrv::AssignedGatekeeper]
• 7.11 Section [AssignedGatekeepers::SQL]
• 7.12 Section [GnuGkAssignedGatekeepers::SQL]
• 7.13 Section [AssignedLanguage::SQL]
• 7.14 Section [NATedEndpoints]
• 7.15 Section [GkPresence::SQL]

8. Authentication Configuration

• 8.1 Section [Gatekeeper::Auth]
• 8.2 Section [FileIPAuth]
• 8.3 Section [H235]
• 8.4 Section [SimplePasswordAuth]
• 8.5 Section [SQLPasswordAuth]
• 8.6 Section [H350PasswordAuth]
• 8.7 Section [RasSrv::RRQAuth]
• 8.8 Section [SQLAliasAuth]
• 8.9 Section [SQLAuth]
• 8.10 Section [PrefixAuth]
• 8.11 Section [RadAuth]
• 8.12 Section [RadAliasAuth]
• 8.13 Section [CapacityControl]
• 8.14 Section [GkH350::Settings]
• 8.15 Section [GkLDAP::Settings]
• 8.16 Section [GkLDAP::LDAPAttributes]
• 8.17 Section [LuaAuth]
• 8.18 Section [LuaPasswordAuth]
• 8.19 Section [HttpPasswordAuth]
• 8.20 Section [GeoIPAuth]
• 8.21 Section [TwoAliasAuth]

9. Accounting Configuration

• 9.1 Section [Gatekeeper::Acct]
• 9.2 Customizing CDR strings and accounting data
• 9.3 Section [FileAcct]
• 9.4 Section [RadAcct]
• 9.5 Section [SQLAcct]
• 9.6 Section [StatusAcct]
• 9.7 Section [SyslogAcct]
• 9.8 Section [LuaAcct]
• 9.9 Section [HttpAcct]
• 9.10 Section [AMQPAcct]
• 9.11 Section [MQTTAcct]
• 9.12 Section [RequireOneNet]

10. Neighbor Configuration

• 10.1 Section [RasSrv::Neighbors]
• 10.2 Section [RasSrv::LRQFeatures]
• 10.3 Section [Neighbor::...]
• 10.4 Configuring a Traversal Zone with GnuGk as Traversal Server
• 10.5 Configuring a Traversal Zone with GnuGk as Traversal Client

11. Per-Endpoint Configuration

• 11.1 Section [EP::...]

12. Advanced Configuration

• 12.1 Section [CallTable]
• 12.2 Section [H225toQ931]
• 12.3 Section [GkQoSMonitor]
• 12.4 Section [GkQoSMonitor::SQL]
• 12.5 Section [Endpoint]
• 12.6 Section [CTI::Agents]
• 12.7 Section [CTI::MakeCall]
• 12.8 Section [SQLConfig]
• 12.9 Section [PortNotifications]
• 12.10 Section [SNMP]
• 12.11 Section [TLS]

13. Monitoring the Gatekeeper

• 13.1 Status Port
• 13.2 Commands (Reference)
• 13.3 Messages / Events (Reference)
• 13.4 Status Port Filtering
• 13.5 Status Port Message Format

14. Advanced Topics

• 14.1 Compiling GnuGk from Github
• 14.2 Tracing GnuGk
• 14.3 Debugging GnuGk (on Linux)

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