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_INCOMING
33 Drop all incoming connections where the remote callsign match
34 this regular expression. No message will be sent to the remote
35 station notifying about the drop. The connection will just be
36 ignored. For more information on the syntax, see the REGULAR
37 EXPRESSIONS chapter below.
38 REJECT_INCOMING
40 Reject all incoming connections where the remote callsign match
41 this regular expression. A message will be sent to the remote
42 station indicating that the connection was rejected. The
43 DROP_INCOMING directive will be evaluated before REJECT_INCOM‐
44 ING. For more information on the syntax, see the REGULAR
45 EXPRESSIONS chapter below.
46 ACCEPT_INCOMING
48 Only accept incoming connections where the remote callsign match
49 this regular expression. If the callsign doesn't match, a mes‐
50 sage will be sent to the remote station indicating that the con‐
51 nection was rejected. The DROP_INCOMING and REJECT_INCOMING
52 directives will be evaluated before ACCEPT_INCOMING. For more
53 information on the syntax, see the REGULAR EXPRESSIONS chapter
54 below.
55 REJECT_OUTGOING
57 Reject all outgoing connections where the remote callsign match
58 this regular expression. For more information on the syntax, see
59 the REGULAR EXPRESSIONS chapter below.
60 REJECT_CONF
62 When this is set to 1, reject all incoming connections where the
63 name of the remote station ends in the word CONF. A message will
64 be sent to the remote station indicating that the connection was
65 rejected. This blocks connects from stations that are in con‐
66 ference mode. When a station enters conference mode after con‐
67 necting, and transmits towards us, it will be disconnected as
68 well.
69 CHECK_NR_CONNECTS
71 If a station connects to often it can be blocked for a config‐
72 urable time span. Example: CHECK_NR_CONNECTS=3,300,120 If a sta‐
73 tion connects more than 3 times with less than 300 seconds in
74 between each connect, that station will be rejected for 120 min‐
75 utes.
76 ACCEPT_OUTGOING
78 Only accept outgoing connections where the remote callsign match
79 this regular expression. The REJECT_OUTGOING directive will be
80 evaluated before ACCEPT_OUTGOING. For more information on the
81 syntax, see the REGULAR EXPRESSIONS chapter below.
82 SERVERS
84 A space separated list of IP addresses or names of the EchoLink
85 directory servers to use. The specified servers will be tried in
86 order until one is found that works. SvxLink will then stick to
87 that server. If that server fail, SvxLink will again try the
88 next server in the list and when the end of the list has been
89 reached, the search start from the beginning again. Hostnames
90 that resolve to multiple IP addresses, like
91 servers.echolink.org, will also be correctly handled so that all
92 returned IP addresses will be tried if necessary.
93 CALLSIGN
95 The callsign to use to login to the EchoLink directory server.
96 SYSOPNAME
98 The name of the person or club that is responsible for this sys‐
99 tem.
100 PASSWORD
102 The EchoLink directory server password to use.
103 LOCATION
105 The location of the station. Note: In the default configuration
106 file the value of this configuration variable starts with
107 "[Svx]". This is of course not necessary but it's fun to see
108 which other stations are running SvxLink.
109 PROXY_SERVER
111 If set, connect to the given EchoLink proxy server host. All
112 EchoLink connections, both incoming and outgoing, will then go
113 through the proxy.
114 PROXY_PORT
116 Set the TCP port used for connecing to an EchoLink proxy server.
117 Default is 8100.
118 PROXY_PASSWORD
120 Set the EchoLink proxy password used when connecting to an
121 EchoLink proxy server. Use the password PUBLIC for public proxy
122 servers.
123 BIND_ADDR
125 This configuration variable can be set to bind the EchoLink net‐
126 work sockets to a specific IP-address/interface. This may be
127 needed if the computer is fitted with more than one ethernet
128 interface and EchoLink should only be used on one of them.
129 Example: BIND_ADDR=192.168.0.1
131 MAX_QSOS
133 The maximum number of stations that can participate in a confer‐
134 ence QSO on this node. If more stations try to connect, the con‐
135 nect request will be rejected.
136 USE_GSM_ONLY
138 On smaller systems with a less powerful CPU it is a good idea to
139 prevent SvxLink from switching into the Speex codec when another
140 SvxLink station is connecting via EchoLink. If this param is
141 set to 1 SvxLink remains in the default codec (GSM).
142 DEFAULT_LANG
144 Set the language to use for announcements sent to remote
145 EchoLink stations. If not set, it will be the same as the one
146 chosen for the logic core. The reason for setting this up may be
147 that you want one language for the core and another language for
148 annoncements sent to remote EchoLink stations.
149 MAX_CONNECTIONS
151 When more stations than specified in MAX_QSOS try to connect, a
152 connection will temporarily be established long enough to play a
153 message telling the remote station that the connection was
154 rejected. The connection is then immediately terminated. If the
155 number of connections exceeds MAX_CONNECTIONS, the connect
156 request is just ignored. This variable is typically set to
157 MAX_QSOS+1 or more if using a large number for MAX_QSOS.
158 LINK_IDLE_TIMEOUT
160 The number of seconds that a connection is idle before discon‐
161 nection will occur. This is to prevent a link to stay open if
162 someone forget to disconnect. Disable this feature by setting
163 this config variable to zero (or comment it out).
164 AUTOCON_ECHOLINK_ID
166 Set this variable to an EchoLink ID that you want to automati‐
167 cally connect to. SvxLink will autoconnect only when no other
168 station is connected.
169 AUTOCON_TIME
171 Set this to the time in seconds that you want in between auto‐
172 connect tries.
173 DESCRIPTION
175 A longer description that is sent to remote stations upon con‐
176 nection. This description should typically include detailed sta‐
177 tion information like QTH, transceiver frequency/power, antenna,
178 CTCSS tone frequency etc.
179 COMMAND_PTY
181 Specify the path to a PTY that can be used to control the
182 EchoLink module from the operating system. Commands: "KILL" will
183 disconnect the current talker, "DISC callsign" will disconnect
184 the station with the given callsign. Commands can be issued
185 using a simple echo command from the shell.
186
188 Regular expressions are used in the DROP, REJECT and ACCEPT configura‐
189 tion variables. A regular expression can be quite complex and the syn‐
190 tax is fully described in the regex(7) manual page. This is just a
191 quick tutorial for the most important features.
192 ^ match the beginning of a string.
194 $ match the end of a string.
196 . match one character.
198 * match the previous expression zero or more times.
200 | match the expression before OR after the |.
202 \ escape the following character. Note that backslash is also
204 parsed by the SvxLink configuration parser so a backslash must
205 actually be typed as two. For example to include a * in the
206 matching pattern it must be escaped as \\*.
207 () grouping an expression.
209 [] match any of the characters inside of the brackets.
211 Some examples:
213 ^(AB1CDE|BA5CBA-L)$
215 Match AB1CDE or BA5CBA-L.
216 ^(AB1CDE-[LR])$
218 Match AB1CDE-L or AB1CDR-R.
219 ^(AB1.*)$
221 Match all callsigns starting with AB1.
222 ^(\\*.*\\*)$
224 Match all conference "callsigns". We need to escape the star
225 character since it would otherwise be parsed by the regular
226 expression parser. We also need two backslah characters so that
227 the SvxLink configuration reader doesn't parse it as an escape
228 sequence.
229 The matches in SvxLink are case insensitive so "sm3" and "SM3" are the
231 same. SvxLink use extended regular expressions (see regex(7) ). You
232 almost always want to start the regular expression with "^(" and end it
233 with ")$" so that the whole callsign will be used in the match.
234
236 /etc/svxlink/svxlink.conf (or deprecated /etc/svxlink.conf)
237 The system wide configuration file.
238 ~/.svxlink/svxlink.conf
240 Per user configuration file.
241 /etc/svxlink/svxlink.d/ModuleEchoLink.conf
243 Global modularized configuration file. Depends on the CFG_DIR
244 configuration variable setting.
245 ~/.svxlink/svxlink.d/ModuleEchoLink.conf
247 Per user modularized configuration file. Depends on the CFG_DIR
248 configuration variable setting.
249
251 Tobias Blomberg (SM0SVX) <sm0svx at users dot sourceforge dot net>
252
254 svxlink.conf(5)
255Linux MARS 2013 MODULEECHOLINK.CONF(5)