1MODULEECHOLINK.CONF(5) File Formats MODULEECHOLINK.CONF(5)
2
6 ModuleEchoLink.conf - Configuration file for the SvxLink server
7 EchoLink module
8
10 svxlink is a general purpose voice service system for ham radio use.
11 This man-page describe the SvxLink server configuration for the
12 EchoLink module.
13 The EchoLink module is used to connect to other EchoLink stations.
15
17 There are a couple of configuration variables that are common to all
18 modules. The documentation for these can be found in the
19 svxlink.conf(5) manual page.
20 Here is the description of all module specific configuration variables
22 that the SvxLink EchoLink module understands.
23 ModuleEchoLink
25 ALLOW_IP
26 Use this variable very carefully. Connections originating from
27 the given subnet will not be checked against the EchoLink direc‐
28 tory server. A typical use of this is if you want to connect to
29 your own svxlink server and both the server and you are behind a
30 IP masquerading firewall.
31 DROP Drop all connections where the remote callsign match this regu‐
33 lar expression. No message will be sent to the remote station
34 notifying about the drop. The connection will just be ignored.
35 For more information see the REGULAR EXPRESSIONS chapter below.
36 REJECT Reject all connections where the remote callsign match this reg‐
38 ular expression. A message will be sent to the remote station
39 indicating that the connection was rejected. The DROP directive
40 will be evaluated before REJECT. For more information see the
41 REGULAR EXPRESSIONS chapter below.
42 ACCEPT Only accept connections where the remote callsign match this
44 regular expression. If the callsign doesn't match, a message
45 will be sent to the remote station indicating that the connec‐
46 tion was rejected. The DROP and REJECT directives will be eval‐
47 uated before ACCEPT. For more information see the REGULAR
48 EXPRESSIONS chapter below.
49 SERVER The IP address or name of the EchoLink directory server to use.
51 CALLSIGN
53 The callsign to use to login to the EchoLink directory server.
54 SYSOPNAME
56 The name of the person or club that is responsible for this sys‐
57 tem.
58 PASSWORD
60 The EchoLink directory server password to use.
61 LOCATION
63 The location of the station. Note: In the default configuration
64 file the value of this configuration variable starts with
65 "[Svx]". This is of course not necessary but it's fun to see
66 which other stations are running SvxLink.
67 LOCATION_INFO
69 Enter the section name that contains information required for
70 transfering positioning data to location servers. Setting this
71 item makes the system visible on the EchoLink link status page
72 and the APRS network.
73 MAX_QSOS
75 The maximum number of stations that can participate in a confer‐
76 ence QSO on this node. If more stations try to connect, the con‐
77 nect request will be rejected.
78 MAX_CONNECTIONS
80 When more stations than specified in MAX_QSOS try to connect, a
81 connection will temporarily be established long enough to play a
82 message telling the remote station that the connection was
83 rejected. The connection is then immediately terminated. If the
84 number of connections exceeds MAX_CONNECTIONS, the connect
85 request is just ignored. This variable is typically set to
86 MAX_QSOS+1 or more if using a large number for MAX_QSOS.
87 LINK_IDLE_TIMEOUT
89 The number of seconds that a connection is idle before discon‐
90 nection will occur. This is to prevent a link to stay open if
91 someone forget to disconnect. Disable this feature by setting
92 this config variable to zero (or comment it out).
93 DESCRIPTION
95 A longer description that is sent to remote stations upon con‐
96 nection. This description should typically include detailed sta‐
97 tion information like QTH, transceiver frequency/power, antenna,
98 CTCSS tone frequency etc.
99 LocationInfo
101 STATUS_SERVER_LIST
102 Enter a space separated list of EchoLink status servers that
103 should be used to send node status beacons. Your node informa‐
104 tion can be found on http://www.echolink.org/links.jsp. The
105 format is host:port. Host - hostname or IP address, port - UDP
106 port. Don't change the default unless you know what you are
107 doing. If you don't want to update the EchoLink status server,
108 comment out this configuration variable.
109 Example:
111 STATUS_SERVER_LIST=aprs.echolink.org:5199
112 APRS_SERVER_LIST
114 This configuration variable specifies connection parameters for
115 connecting to an APRS server network using the TCP protocol. In
116 this case, the positioning information is forwarded to the
117 worldwide APRS network. Have a look at http://aprs.fi/.
118 To choose a suitable APRS server from the so called tier 2 net‐
120 work, have a look at http://www.aprs2.net/. Either choose a spe‐
121 cific server or one of the regional addresses. The regional
122 addresses bundle all APRS servers within a region so that a ran‐
123 dom tier 2 server is chosen within the region. There are five
124 regions defined: noam.aprs2.net - North America, euro.aprs2.net
125 - Europe, asia.aprs2.net - Asia, soam.aprs2.net - South America
126 and Africa, aunz.aprs2.net - Austrailia and New Zeeland. The
127 format is a space separated list of host:port entries. Host -
128 hostname or IP address, port - TCP port.
129 Example:
131 APRS_SERVER_LIST=euro.aprs2.net:14580
132 LON_POSITION
134 The longitude of the station position, entered as
135 "degrees.arcminutes.arcseconds"
136 Example:
138 LON_POSITION=09.02.20E
139 LAT_POSITION
141 The latitude of the station position, entered as
142 "degrees.arcminutes.arcseconds"
143 Example:
145 LAT_POSITION=51.02.22N
146 FREQUENCY
148 The tx-frequency of the link/repeater in MHz. For repeaters,
149 information about the RX/TX shift in the COMMENT configuration
150 variable may be useful.
151 Example:
153 FREQUENCY=430.050 # tx-frequency is 430.050 MHz
154 TX_POWER
156 The power of your transmitter in watts.
157 Example:
159 TX_POWER=10 # tx output is 10 watts
160 ANTENNA_GAIN
162 The gain of your antenna in dBd.
163 Example:
165 ANTENNA_GAIN=5 # antenna gain is 5 dBd
166 ANTENNA_HEIGHT
168 The height of the link-/repeater antenna in meters or feet above
169 the terrain, not sealevel.
170 Example:
172 ANTENNA_HEIGHT=10m # 10 meters above the ground
173 ANTENNA_HEIGHT=90 # 90 feet
174 ANTENNA_DIR
176 Main beam direction of the antenna in degrees. If an omni direc‐
177 tion antenna is used, specify -1 as the direction.
178 Example:
180 ANTENNA_DIR=-1 # an omni directional antenna is used
181 ANTENNA_DIR=128 # main beam direction is 128 degrees
182 PATH The PATH variable controls the way of forwarding your beacon
184 inside the APRS network if it is gated by a local APRS digi‐
185 peater. In some cases it has to be changed according to local
186 requirements. Please contact your local APRS sysop for further
187 information. Changes should be made only according to the NEWn-N
188 paradigm. Leave this variable untouched if you are unsure of its
189 setting. No spaces or control characters are allowed. PATH has
190 no influence on the propagation on non-RF networks.
191 Examples:
193 PATH=WIDE1-1
194 PATH=WIDE1-1,WIDE2-2
195 BEACON_INTERVAL
197 The interval, in minutes, with which beacons will be sent to the
198 APRS network. A good value is 10 minutes. If your beacon is
199 gated via RF, please increase the interval a bit to keep the
200 APRS traffic on RF produced by the APRS RF gate as low as possi‐
201 ble. Intervals shorter than 10 minutes will be changed to 10.
202 Example:
204 BEACON_INTERVAL=30 # APRS-beacons will be sent every 30 min‐
205 utes.
206 TONE The CTCSS subaudible tone that is to be used for operation over
208 your link or repeater. If you don't use tone control set it to
209 0.
210 Examples:
212 TONE=136 # we are using a CTCSS-tone of 136.5 Hz
213 TONE=0 # we don't use CTCSS subaudible or call tones
214 TONE=1750 # the link/repeater use a tone burst of 1750 Hz
215 COMMENT
217 Specify a short comment here, maybe a link to your website or
218 information that could be interesting for others. The length
219 should not exceed 255 characters and may not have control char‐
220 acters like "Carriage Return" (\r) or "Line Feed" (\n) inside.
221 Make your comment as short as you can to give users with a small
222 display (TH-D7) the chance to display the full comment text.
223 Example:
225 COMMENT=[svx] Running SvxLink by SM0SVX
226
228 Regular expressions are used in the DROP, REJECT and ACCEPT configura‐
229 tion variables. A regular expression can be quite complex and the syn‐
230 tax is fully described in the regex(7) manual page. This is just a
231 quick tutorial for the most important features.
232 ^ match the beginning of a string.
234 $ match the end of a string.
236 . match one character.
238 * match the previous expression zero or more times.
240 | match the expression before OR after the |.
242 \ escape the following character. Note that backslash is also
244 parsed by the SvxLink configuration parser so a backslash must
245 actually be typed as two. For example to include a * in the
246 matching pattern it must be escaped as \\*.
247 () grouping an expression.
249 [] match any of the characters inside of the brackets.
251 Some examples:
253 ^(AB1CDE|BA5CBA-L)$
255 Match AB1CDE or BA5CBA-L.
256 ^(AB1CDE-[LR])$
258 Match AB1CDE-L or AB1CDR-R.
259 ^(AB1.*)$
261 Match all callsigns starting with AB1.
262 ^(\\*.*\\*)$
264 Match all conference "callsigns". We need to escape the star
265 character since it would otherwise be parsed by the regular
266 expression parser. We also need two backslah characters so that
267 the SvxLink configuration reader doesn't parse it as an escape
268 sequence.
269 The matches in SvxLink are case insensitive so "sm3" and "SM3" are the
271 same. SvxLink use extended regular expressions (see regex(7) ). You
272 almost always want to start the regular expression with "^(" and end it
273 with ")$" so that the whole callsign will be used in the match.
274
276 /etc/svxlink.conf
277 The system wide configuration file.
278 ~/.svxlink/svxlink.conf or ~/.svxlinkrc
280 Per user configuration file.
281 /etc/svxlink.d/ModuleEchoLink.conf
283 Global modularized configuration file. Depends on the CFG_DIR
284 configuration variable setting.
285 ~/.svxlink/svxlink.d/ModuleEchoLink.conf
287 Per user modularized configuration file. Depends on the CFG_DIR
288 configuration variable setting.
289
291 Tobias Blomberg (SM0SVX) <sm0svx at users dot sourceforge dot net>
292
294 svxlink.conf(5)
295Linux APRIL 2009 MODULEECHOLINK.CONF(5)