Skip to content

Telnet Server

The Telnet login server provides a standard non-secure Telnet login experience.

The following configuration can be made in config.hjson under the loginServers.telnet block:

KeyRequiredDescription
enabledNoDefaults to true. Set to false to disable Telnet.
portNoOverride the default port of 8888.
addressNoSets an explicit bind address.
firstMenuNoFirst menu a telnet connected user is presented with. Defaults to telnetConnected.
{
loginServers: {
telnet: {
enabled: true
port: 8888
}
}
}

The Telnet server can listen on more ports than its main one. Add each under loginServers.telnet.listeners, keyed by a name of your choosing. A port can send its callers to a different first menu, which is useful for a separate board entrance on its own port.

KeyRequiredDescription
portYesPort to listen on.
addressNoBind address. Defaults to the main Telnet address.
firstMenuNoFirst menu for callers on this port. Defaults to the main Telnet firstMenu.
emulationNoTerminal emulation for callers on this port, for example petscii.
enabledNoDefaults to true. Set to false to leave the listener out without removing it. Read at startup: a change to port, address or enabled needs a restart.

ansi, petscii and atascii are implemented today; see PETSCII (Commodore) Callers and ATASCII (Atari) Callers. Any other value is recorded and falls back to ANSI.

Additional listeners run only while the main Telnet server is enabled. A listener with a missing or invalid port, one on a port already in use by the main server or another listener, or one that fails to bind is logged as an error and skipped; the main listener and the rest of the board start as normal.

{
loginServers: {
telnet: {
port: 8888
listeners: {
retro: {
port: 6400
firstMenu: retroConnected
emulation: petscii
}
local: {
port: 8890
address: 127.0.0.1
}
}
}
}
}