~fluix/tilde

ref: 6607d0115602139177d6c65c1bea9218430811c5 tilde/flatpages/templates/chat.html -rw-r--r-- 3.7 KiB
6607d011Steven Guikal Update chat information, mentioning gamja 6 months ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
<!--
SPDX-FileCopyrightText: 2021 Steven Guikal <void@fluix.one>

SPDX-License-Identifier: AGPL-3.0-only
SPDX-License-Identifier: CC-BY-SA-4.0
-->

{% extends "base.html" %}

{% block head %}
  <title>Chat</title>
{% endblock %}

{% block main %}
  <h1>Chat</h1>
  <p>We currently only provide an <abbr title="Internet Relay Chat">IRC</abbr> server and web client for communication. It is hosted on the <a href="ircs://irc.{{ request.environ.HTTP_HOST }}">irc.{{ request.environ.HTTP_HOST }}</a> subdomain. <a href="https://ergo.chat">Ergo</a>, our ircd, includes a <b>built-in bouncer</b> to keep message history, integrated services, and IP cloaking. It is only available over TLS.</p>

  <h2>Daemon Information</h2>
  <ul>
    <li><b>server</b>: <a href="https://ergo.chat">Ergo</a></li>
    <li><b>url</b>: <a href="ircs://irc.cats.sh:6697">ircs://irc.cats.sh:6697</a></li>
    <li><b>host</b>: <code>irc.cats.sh</code></li>
    <li><b>port</b>: <code>6697</code></li>
    <li><b>auth</b>: SASL</li>
  </ul>

  <h2>Web Client Information</h2>
  <ul>
    <li><b>client</b>: <a href="https://sr.ht/~emersion/gamja">Gamja</a></li>
    <li><b>url</b>: <a href="https://gamja.cats.sh">https://gamja.cats.sh</a></li>
  </ul>

  <h2>Connecting</h2>
  <p>A web-based IRC client, <a href="https://sr.ht/~emersion/gamja/">gamja</a>, is hosted on <a href="gamja.cats.sh">gamja.cats.sh</a>. Login with the same username and password you register with.</p>
  <p>Most clients should work well with Ergo. Check <a href="https://ircv3.net/software/clients">the list here</a> for many options.</p>
  <p>Connect over TLS on host <a href="ircs://irc.cats.sh:6697"><code>irc.cats.sh</code> and port <code>6697</code></a>. Use SASL authentication with the same username and password that you registered with.</p>
  <p>See the <a href="https://github.com/ergochat/ergo/blob/stable/docs/USERGUIDE.md#introduction">Ergo Userguide</a> for more information and links to other guides (note that you do not need to register your account with <code>NickServ</code>).</p>

  <h2>Channels</h2>
  <p>You can join a channel with <code>/join #channel-name</code>. Note that if everyone leaves a channel, it disappears, and if you are the only one in the channel you are/can become an operator in it. To keep your channel and its settings through server restarts and users leaving, <b>register it with <code>ChanServ</code></b> like so:</p>
  <p><code>/msg ChanServ register #channel-name</code></p>
  <p>The userguide linked above mentions registering channels which you can do on our server.</p>
  <p>The only <b>official channel is <a href="ircs://irc.cats.sh:6697/#cats">#cats</a></b> which you can join by typing <code>/join #cats</code> in your IRC client. The webchat automatically connects you to this channel.</p>

  <h2>Message History</h2>
  <p>Ergo has been configured to store message history in RAM for a period of <b>1 month</b>. There are also specific limits for different history protocols and leave/join messages, but 1 month is the global limit.</p>
  <p>If you use a client which supports some of the more modern IRC protocols you may not have to configure anything. When you connect, you should be able to see messages while you were gone. Depending on your client, you may have had to connect at least once before receiving history.</p>
  <p>For older clients, you can enable <code>always-on</code> for your user with <code>/msg NickServ set always-on true</code>. Note that this has other side-effects like showing you always connected to the server and open to direct messages.</p>
  <p>Check out the <a href="https://github.com/ergochat/ergo/blob/stable/docs/USERGUIDE.md#history">History section of the Ergo Userguide</a> for complete information, and do not hesitate to ask questions in <code>#cats</code>.</p>
{% endblock %}