spothole/templates/help/usage/telnet.html

{% extends "../help_page.html" %}
{% block help_content %}

<h2 class="mt-4 mb-4">Using the Telnet Server</h2>
{% if telnet_server_enabled %}
<p>As well as a web interface and an HTTP API, Spothole offers a telnet server. This can be used to integrate Spothole's
    data into a traditional desktop logging program. The data Spothole produces is compatible with DXSpider, and
    therefore many loggers should accept it with no problems.</p>
<p>This is a relatively new feature however, so if you run into problems, please do let me know.</p>
<p>The one caveat with the Spothole telnet server is that <em>it does not support any commands</em>, other than <code>exit</code>.
    You cannot therefore issue commands to retrieve past entries, set up filters, etc. If you need to filter the data,
    many desktop logging programs support this client-side, so hopefully this is not too big of an obstacle.
</p>
<p>To access Spothole via telnet, set up your logger with the server address <code>{{ telnet_server_address }}</code>
    and port <code>{{ telnet_server_port }}</code>. You can also access it from a terminal with <code>telnet {{
        telnet_server_address }} {{ telnet_server_port }}</code></p>
{% else %}
<p>The telnet server on this instance of Spothole is disabled. If you need telnet access, please use a different
    Spothole server, or run your own.</p>
{% end %}

{% end %}