|
@@ -1,8 +1,7 @@
|
1
|
1
|
# Ergonomadic
|
2
|
2
|
|
3
|
3
|
Ergonomadic is an IRC daemon written from scratch in Go. Pull requests and
|
4
|
|
-issues are welcome. Discuss it here or on Freenode in
|
5
|
|
-[#ergonomadic](irc://chat.freenode.net/#ergonomadic).
|
|
4
|
+issues are welcome. Discuss it here or on Freenode in [#ergonomadic][irc].
|
6
|
5
|
|
7
|
6
|
## Some Features
|
8
|
7
|
|
|
@@ -11,7 +10,7 @@ issues are welcome. Discuss it here or on Freenode in
|
11
|
10
|
- server password (PASS command)
|
12
|
11
|
- channels with most standard modes
|
13
|
12
|
- IRC operators (OPER command)
|
14
|
|
-- haproxy [PROXY protocol](http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt) header for hostname setting
|
|
13
|
+- haproxy [PROXY protocol][proxy-proto] header for hostname setting
|
15
|
14
|
- passwords stored in bcrypt format
|
16
|
15
|
- channels that persist between restarts (+P)
|
17
|
16
|
|
|
@@ -25,14 +24,17 @@ I wanted to learn Go.
|
25
|
24
|
|
26
|
25
|
## What about SSL/TLS support?
|
27
|
26
|
|
28
|
|
-Go has a not-yet-verified-as-safe TLS 1.2 implementation. Sadly, many
|
29
|
|
-popular IRC clients will negotiate nothing newer than SSLv2. If you
|
30
|
|
-want to use SSL to protect traffic, I recommend using
|
31
|
|
-[stunnel](https://www.stunnel.org/index.html) version 4.56 with
|
32
|
|
-haproxy's
|
33
|
|
-[PROXY protocol](http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt). This
|
34
|
|
-will allow the server to get the client's original addresses for
|
35
|
|
-hostname lookups.
|
|
27
|
+Go has a not-yet-verified-as-safe TLS 1.2 implementation. Sadly, many popular
|
|
28
|
+IRC clients will negotiate nothing newer than SSLv2. If you want to use SSL to
|
|
29
|
+protect traffic, I recommend using [stunnel][stunnel] version 4.56 with
|
|
30
|
+haproxy's [PROXY protocol][proxy-proto]. This will allow the server to get the
|
|
31
|
+client's original addresses for hostname lookups.
|
|
32
|
+
|
|
33
|
+## What about federation?
|
|
34
|
+
|
|
35
|
+IRC federation solves a problem that was more likely to occur on the internet of
|
|
36
|
+1991 than today. We are exploring alternatives to federation that avoid nickname
|
|
37
|
+and channel sync issues created during netsplits.
|
36
|
38
|
|
37
|
39
|
## Installation
|
38
|
40
|
|
|
@@ -44,9 +46,8 @@ ergonomadic initdb -conf ergonomadic.conf
|
44
|
46
|
|
45
|
47
|
## Configuration
|
46
|
48
|
|
47
|
|
-See the example `ergonomadic.conf`. Passwords are base64-encoded
|
48
|
|
-bcrypted byte strings. You can generate them with the `genpasswd`
|
49
|
|
-subcommand.
|
|
49
|
+See the example `ergonomadic.conf`. Passwords are base64-encoded bcrypted byte
|
|
50
|
+strings. You can generate them with the `genpasswd` subcommand.
|
50
|
51
|
|
51
|
52
|
```sh
|
52
|
53
|
ergonomadic genpasswd 'hunter2!'
|
|
@@ -65,3 +66,8 @@ ergonomadic run -conf ergonomadic.conf
|
65
|
66
|
- [RFC 2812: IRC Client Protocol](http://tools.ietf.org/html/rfc2812)
|
66
|
67
|
- [RFC 2813: IRC Server Protocol](http://tools.ietf.org/html/rfc2813)
|
67
|
68
|
- [IRC/2 Numeric List](https://www.alien.net.au/irc/irc2numerics.html)
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+[proxy-proto]: http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt
|
|
72
|
+[irc]: irc://chat.freenode.net/#ergonomadic
|
|
73
|
+[stunnel]: https://www.stunnel.org/index.html
|