kasplodey/echolink-proxy repository overview

⁠Echolink Proxy

Echolink is an application for licensed amateur radio operators that connects your device to thousands of other stations over the Internet.

If you find yourself unable to connect to Echolink due to a firewall issue it's likely that using an Echolink proxy will help.

⁠Quick start

All variables are optional but if you do not specify any settings, you will end up with a server with the password set to "PUBLIC", no timeout and no registration name/registration comment so the server will not appear on the offical proxy server list.

For a public server listed on the official EchoLink proxy list⁠ page:

docker run -d \
  -e PASSWORD=PUBLIC \
  -e REGISTRATIONNAME="Text that will appear under the notes column on the official proxy list page." \
  -e REGISTRATIONCOMMENT="Text that will appear under the comments column on the official proxy list page." \
  -p 5198:5198/udp \
  -p 5199:5199/udp \
  -p 5200:5200/tcp \
  -p 8100:8100/tcp \
  --restart unless-stopped \
  kasplodey/echolink-proxy

For a private server:

docker run -d \
  -e PASSWORD=YourSuperSecretSquirrelPassword123! \
  -p 5198:5198/udp \
  -p 5199:5199/udp \
  -p 5200:5200/tcp \
  -p 8100:8100/tcp \
  --restart unless-stopped \
  kasplodey/echolink-proxy

⁠Parameters

⁠Paramater details:

PASSWORD
OPTIONAL
Default value = PUBLIC
Set this to PUBLIC if you would like for your proxy to be publicly accessible. If not, set this to your desired password.

REGISTRATIONNAME
OPTIONAL
No default value
Set REGISTRATIONNAME to something unique if you want the EchoLink proxy to register itself with the EchoLink website. This REQUIRES that you set PASSWORD to PUBLIC. This value does not apply to non-public servers. Set a value only if you want your server to be listed on the official EchoLink proxy list⁠. Also note that each REGISTRATIONNAME must be unique for each instance.

REGISTRATIONCOMMENT
OPTIONAL
No default value
Set REGISTRATIONCOMMENT to the text you would like to appear in the comments column on the official EchoLink proxy list⁠. This value does not apply to non-public servers.

PORT
OPTIONAL
Default value = 8100
Change Port to something else if you don't want to use the default.

CONNECTIONTIMEOUT
OPTIONAL
Default value - 0
Will disconnect the client after the specified number of minutes regardless of whether an EchoLink connection is active.

BINDADDRESS
OPTIONAL
Default value = 0.0.0.0
Set this if you have multiple IPs on the server and you would like the EchoLink proxy to bind to a specific IP.

EXTERNALBINDADDRESS
OPTIONAL
Default value = 0.0.0.0
Set if this is a multi-homed host and you want to associate this instance of the EchoLink proxy with a specific interface for its Internet traffic. In this situation, BINDADDRESS will be used for communication with the client and EXTERALBINDADDRESS will be used for Internet traffic.

PUBLICADDRESS
OPTIONAL
No default value
Set this if this is a multi-homed host and the address that appears on the official EchoLink proxy list⁠ is incorrect.

CALLSIGNSDENIED
OPTIONAL
No default value
Deny access from specified callsigns. Allows regular expressions. A connection will be denied if it matches CALLSIGNSDENIED or if it does NOT match CALLSIGNSALLOWED (and CALLSIGNSALLOWED is not empty).
Example: CALLSIGNSDENIED=.-L$|.-R$ will deny any Sysop nodes from using it.

CALLSIGNSALLOWED
OPTIONAL
No default value
Allow access from specified callsigns. Allows regular expressions. A connection will be denied if it matches CALLSIGNSDENIED or if it does NOT match CALLSIGNSALLOWED (and CALLSIGNSALLOWED is not empty).
Example: CALLSIGNSALLOWED=ABC123|XYZ123 will allow only ABC123 and XYZ123 to use this proxy.