/usr/share/doc/gnugk/manual/manual-11.html is in gnugk 2:3.4-2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.69">
<TITLE>The GNU Gatekeeper: Per-Endpoint Configuration </TITLE>
<LINK HREF="manual-12.html" REL=next>
<LINK HREF="manual-10.html" REL=previous>
<LINK HREF="manual.html#toc11" REL=contents>
</HEAD>
<BODY>
<A HREF="manual-12.html">Next</A>
<A HREF="manual-10.html">Previous</A>
<A HREF="manual.html#toc11">Contents</A>
<HR>
<H2><A NAME="epconfig"></A> <A NAME="s11">11.</A> <A HREF="manual.html#toc11">Per-Endpoint Configuration </A></H2>
<P>In addition to the standard configuration file options, per-endpoint configuration
settings can be specified in the
<A HREF="http://www.gnugk.org/">GnuGk</A> config file.
The syntax is as follows:</P>
<H2><A NAME="ss11.1">11.1</A> <A HREF="manual.html#toc11.1">Section [EP::...]</A>
</H2>
<P>
<BLOCKQUOTE><CODE>
<PRE>
[EP::ALIAS]
Key Name=Value String
</PRE>
</CODE></BLOCKQUOTE>
</P>
<P><CODE>ALIAS</CODE> should be replaced with the actual alias for the endpoint the settings
should apply to. If your endpoint has multiple aliases, you can pick one of them.
GnuGk will look through all aliases and use the first [EP:..] section it finds.</P>
<P>Currently, the following options are recognized:</P>
<P>
<UL>
<LI><CODE>Capacity=10</CODE><BR>
Default: <CODE>-1</CODE><BR>
<P>Call capacity for an endpoint. No more than <CODE>Capacity</CODE> concurrent
calls will be sent to this endpoint. In case of gateways, if more than one
gateway matches a dialed number, a call will be sent to the first available
gateway which has available capacity.</P>
</LI>
<LI><CODE>PrefixCapacities=^0049:=10,^(0044|0045):=20</CODE><BR>
Default: <CODE>N/A</CODE><BR>
<P>Limit the capacity for certain prefixes. Regular expressions can be used to specify
the prefix and specify a combined capacity for a group of prefixes. For a gateway to
be considered available a.) the prefix must have capacity left and b.) the total gateway
capacity (see above) must not be exceeded.</P>
</LI>
<LI><CODE>GatewayPriority=1</CODE><BR>
Default: <CODE>1</CODE><BR>
<P>Applicable only to gateways. Allows priority based routing when more
than one gateway matches a dialed number. Lower values indicate a higher gateway priority.
A call is routed to the first available gateway
(that has available capacity) with the highest priority (the lowest
<CODE>GatewayPriority</CODE> values). In case the gateway priority contradicts prefix priority (see section
<A HREF="manual-7.html#gwprefixes">[RasSrv::GWPrefixes]</A>)
for details), prefix priority will take precedence.</P>
</LI>
<LI><CODE>GatewayPrefixes=0048,0049:=2,0044</CODE><BR>
Default: <CODE>N/A</CODE><BR>
<P>Additional prefixes for this gateway. Applies only to gateways. Special
characters <CODE>.</CODE> and <CODE>!</CODE> can be used to match any digit or to disable
the prefix. You may use the := syntax to set a prefix priority in the same
manner as in
<A HREF="manual-7.html#gwprefixes">[RasSrv::GWPrefixes]</A> section. If
no priority is explicitly configured for a prefix, then the gateway priority
is used.</P>
</LI>
<LI><CODE>AddNumbers=4212,5650-5630,6000</CODE><BR>
Default: <CODE>N/A</CODE><BR>
<P>Add E.164 numbers to this endpoint. The new aliases can either be specified
as a list of numbers or as number ranges.</P>
</LI>
<LI><CODE>CalledTypeOfNumber=1</CODE><BR>
Default: <CODE>N/A</CODE><BR>
<P>Sets Called-Party-Number type of number to the specified value
for calls sent to this endpoint
(0 - UnknownType, 1 - InternationalType, 2 - NationalType,
3 - NetworkSpecificType, 4 - SubscriberType, 6 - AbbreviatedType, 7 - ReservedType).</P>
</LI>
<LI><CODE>CallingTypeOfNumber=1</CODE><BR>
Default: <CODE>N/A</CODE><BR>
<P>Sets Calling-Party-Number type of number to the specified value
for calls sent to this endpoint
(0 - UnknownType, 1 - InternationalType, 2 - NationalType,
3 - NetworkSpecificType, 4 - SubscriberType, 6 - AbbreviatedType, 7 - ReservedType).</P>
</LI>
<LI><CODE>CalledPlanOfNumber=1</CODE><BR>
Default: <CODE>N/A</CODE><BR>
<P>Sets Called-Numbering-Plan of number to the specified value
for calls sent to this endpoint
(0 - UnknownType, 1 - ISDN, 3 - X.121 numbering, 4 - Telex, 8 - National standard, 9 - private numbering).</P>
</LI>
<LI><CODE>CallingPlanOfNumber=1</CODE><BR>
Default: <CODE>N/A</CODE><BR>
<P>Sets Calling-Numbering-Plan of number to the specified value
for calls sent to this endpoint
(0 - UnknownType, 1 - ISDN, 3 - X.121 numbering, 4 - Telex, 8 - National standard, 9 - private numbering).</P>
</LI>
<LI><CODE>Proxy=1</CODE><BR>
Default: <CODE>0</CODE><BR>
<P>Enables/disables proxying calls sent to this endpoint (0 - do not
change global proxy settings, 1 - force proxy mode, 2 - disable proxy mode).</P>
</LI>
<LI><CODE>TranslateReceivedQ931Cause=17:=34</CODE><BR>
Default: <CODE>N/A</CODE><BR>
<P>Translate received cause codes in ReleaseComplete messages from this endpoint.
In the above example code 17 (User busy) will be translated into cause code 34 (No circuit/channel available).</P>
</LI>
<LI><CODE>TranslateSentQ931Cause=21:=34,27:=34</CODE><BR>
Default: <CODE>N/A</CODE><BR>
<P>Translate cause codes in ReleaseComplete messages sent out to this endpoint.
In the above example code 21 and 27 will be translated into cause code 34, because this particular gateway might deal with error code 34 better than with others.</P>
</LI>
<LI><CODE>DisableH46017=1</CODE><BR>
Default: <CODE>0</CODE><BR>
<P>Disable H.460.17 for this endpoint.</P>
</LI>
<LI><CODE>DisableH46018=1</CODE><BR>
Default: <CODE>0</CODE><BR>
<P>Disable H.460.18/.19 for this endpoint.</P>
</LI>
<LI><CODE>MaxBandwidth=81920</CODE><BR>
Default: <CODE>-1</CODE><BR>
<P>Maximum bandwidth this endpoint may use in units of 100 bits per second.</P>
<P>This includes inbound and outbound bandwidth, so for symmetrical calls this
should be doubled.</P>
<P>Common bandwidth settings and their GnuGk equivalents:<BR>
384K = 7680<BR>
512K = 10240<BR>
768K = 15360<BR>
1024K = 20480<BR>
1920K = 38400<BR>
2048K = 40960<BR>
4096K = 81920<BR></P>
<P>If you do not wish to restrict bandwidth, then use "-1".</P>
</LI>
<LI><CODE>AdditionalDestinationAlias=H323-TRUNK</CODE><BR>
Default: <CODE>n/a</CODE><BR>
<P>Add an additional alias to all calls going to this endpoint, if its not already present.
This can be used to add the trunk ID required by Swxy version 6 and up.</P>
</LI>
<LI><CODE>UseTLS=1</CODE><BR>
Default: <CODE>0</CODE><BR>
<P>Use TLS (transport layer security) when calling this endpoint. See also
<A HREF="manual-12.html#tls">[TLS] section</A>.</P>
</LI>
</UL>
</P>
<P>Example how to attach an [EP::..] section to an endpoint:</P>
<P>
<BLOCKQUOTE><CODE>
<PRE>
[RasSrv::PermanentEndpoints]
192.168.1.1=gw1;48
192.168.1.2=gw2;48,!4850,!4860,!4869,!4888
[EP::gw1]
Capacity=60
GatewayPriority=1
[EP::gw2]
Capacity=30
GatewayPriority=2
</PRE>
</CODE></BLOCKQUOTE>
</P>
<P>In this example, calls will be sent to the gateway <CODE>gw1</CODE> until its
capacity is fully utilized (60 concurrent calls) and then to the gateway <CODE>gw2</CODE>.</P>
<HR>
<A HREF="manual-12.html">Next</A>
<A HREF="manual-10.html">Previous</A>
<A HREF="manual.html#toc11">Contents</A>
</BODY>
</HTML>
|