Project

General

Profile

Replicant-bridge » History » Version 3

Denis 'GNUtoo' Carikli, 06/02/2021 10:48 PM
Requirements: fix bullet points (I started with vim)

1 1 Denis 'GNUtoo' Carikli
h1. Replicant-bridge
2
3 2 Denis 'GNUtoo' Carikli
{{toc}}
4
5 1 Denis 'GNUtoo' Carikli
h1. Warnings
6
7
This tutorial is a work in progress
8
9
h1. Introduction
10
11
We run a bridge between the #replicant channel on OFTC and the #replicant
12
channel on liberachat. This is because we originally started on Freenode,
13
but we found out that it was not possible to create accounts with Tor in
14
Freenode so we also opened a #replicant channel on the OFTC network to
15
also enable users that want to protect their identity to be able to join
16
the replicant channel.
17
18
h1. Requirements
19
20
To deploy the Replicant IRC bridge, you need:
21 3 Denis 'GNUtoo' Carikli
* To have the OFTC network and libreachat networks configured in an IRC client in a way that enforces encryption and checks for certificates validity. More precisely:
22
** TLS should be used for both OFTC and Libera.Chat
23
** SASL should be used for Libera.Chat. This is to avoid sending passwords in clear.
24
* Access to the Replicant contact address to change the passwords
25
* A virtual or physical computer that can stay always on
26
* The ability to run FSDG compliant distributions in that computer
27
* The ability ro run matterbridge (the bridge software) on the distribution you use
28 1 Denis 'GNUtoo' Carikli
29
If you intend to deploy a similar configuration for other purposes some of the
30
requirements above could be removed.
31
32
h1. Deployement
33
34
We want to avoid passing around password in insecure ways. So the way to
35
re-deploy this bridge is to first change the passwords, then add the new passwords
36
in the configuration file and run matterbridge.
37
38
h2. Changing passwords
39
40
You will first need to shut down the actual bridge if it's already running as
41
this tutorial doesn't take in account cases where you lost control of a running
42
bridge for some reasons. If that happens you might need to kick the old bridge
43
from IRC first or prevent it from login in with the Replicant-bridge username
44
after having changed the password.
45
46
Once done, you can either start with Libera.chat or OFTC, but you'll need to do
47
both.
48
49
h3. Change the liberachat password
50
51
To change the password you first need to connect to liberachat securely.
52
53
Once done, you can request a password change with the following command:
54
<pre>
55
/msg NickServ SENDPASS Replicant-bridge
56
</pre>
57
58
The instructions to change the password will then arrive at the Replicant
59
contact address.
60
61
Once the password has been changed you will need to update it in the
62
matterbridge.toml configuration file.
63
64
Once this is done, make sure that your IRC client is not connected (anymore)
65
as Replicant-bridge.
66
67
h3. Change the OFTC password
68
69
To change the password, you first need to connect to the OFTC network securely.
70
71
TODO: Document how to change the OFTC password.
72
73
h2. Deploying matterbridge
74
75
Here's (below) the matterbridge.toml file we use:
76
<pre>
77
[irc]
78
79
    [irc.liberachat]
80
    Nick="Replicant-bridge"
81
    NickServNick="Replicant-bridge"
82
    NickServPassword="PASSWORD"
83
    Server="irc.libera.chat:6697"
84
    UseTLS=true
85
    UseSASL=true
86
    SkipTLSVerify=false
87
    RemoteNickFormat="<{NICK}@OFTC> "
88
    
89
    [irc.OFTC]
90
    Nick="Replicant-bridge"
91
    NickServNick="Replicant-bridge"
92
    Server="irc.oftc.net:6697"
93
    UseTLS=true
94
    SkipTLSVerify=false
95
    RunCommands=["PRIVMSG nickserv :IDENTIFY PASSWORD Replicant-bridge"] 
96
    RemoteNickFormat="<{NICK}@Libera.Chat> "
97
    
98
[[gateway]]
99
name="mygateway"
100
enable=true
101
    [[gateway.inout]]
102
    account="irc.liberachat"
103
    channel="#replicant"
104
105
    [[gateway.inout]]
106
    account="irc.OFTC"
107
    channel="#replicant"
108
</pre>
109
110
The passwords have been replaced with PASSWORD.