Document telnet interface

Fixes #61
master
HimbeerserverDE 2021-09-13 18:04:15 +02:00
parent 12b0d68687
commit 2ac579777c
No known key found for this signature in database
GPG Key ID: 1A651504791E6A8B
1 changed files with 15 additions and 0 deletions

15
doc/telnet.md Normal file
View File

@ -0,0 +1,15 @@
# Telnet interface
mt-multiserver-proxy provides a telnet interface that can be used to
execute proxy chat commands.
## Differences to chat interface
Telnet clients can execute any chat command. They do not have any
privileges, only the chat command permission check will succeed.
## Security
There is no authentication at all. For this reason the telnet server
only listens on the loopback interface by default.
## Connecting
The telnet server listens on the IPv6 loopback address "::1"
and TCP port 40010 by default. Use the telnet command to connect.
## Disconnecting
Type \quit or \q to close the connection. All telnet clients will also
be disconnected when the proxy shuts down.