aboutsummaryrefslogtreecommitdiffstats
path: root/chat.sr.ht/bouncer-usage.md
blob: e0e42e06f656e58b8ecabf921e7300be78ada45a (plain) (blame)
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
# Using the chat.sr.ht bouncer

For full details, refer to the [soju(1)] man page. Information about common
use-cases is provided here.

## Connecting with a third-party IRC client

Check out the [quickstart for experienced IRC users][quickstart] for details on
configuring your own IRC client for use with chat.sr.ht.

[quickstart]: /chat.sr.ht/quickstart.md

## Managing your IRC networks

The webchat at [https://chat.sr.ht](https://chat.sr.ht) provides a UI for
managing your bouncer networks. Third-party clients with soju support may detect
the bouncer and offer similar functionality. If not, you can also message
BouncerServ to configure soju. Use `/msg BouncerServ help` for a full list of
supported commands.

To add a new IRC network via BouncerServ:

```
/msg BouncerServ network create -addr <hostname> [options...]
```

See [soju(1)] for details on the supported options.

[soju(1)]: https://soju.im/doc/soju.1.html#IRC_SERVICE

## Detaching from channels

You can instruct the bouncer to "detach" from a channel. This causes it to be
hidden from your channel list, but to leave your connection to the channel
active. If you're mentioned by a user in this channel, you will receive
notifications for it, and if you re-join later, you will be able to view logs of
discussions which took place in your absence.

To detach from a channel, use the `/part detach` command, or `/msg BouncerServ
channel update <name> -detached=<true|false>`.

## Client-specific configuration

Various configuration recommendations for third-party IRC clients are documented
here: [contrib/clients.md](https://git.sr.ht/~emersion/soju/tree/master/item/contrib/clients.md).