|
@@ -1,20 +1,12 @@
|
1
|
|
-Ergonomadic (anagram of "go IRC daemon") is an IRC daemon written from scratch
|
2
|
|
-in Go. Pull requests and issues are welcome.
|
3
|
|
-
|
4
|
|
-Discussion at:
|
5
|
|
-* host/port: irc.skub.club:6697, use SSL
|
6
|
|
-* password: smellyoulater
|
7
|
|
-* #darwin
|
|
1
|
+Oragono is a very early, extremely experimental fork of the [Ergonomadic](https://github.com/edmund-huber/ergonomadic) IRC daemon. Ergonomadic looks cool, and this is something I can experiment on. Hopefully most of the stuff I do in this can be merged back into Ergonomadic! Also see the [mammon](https://github.com/mammon-ircd/mammon) IRC daemon for something similar written in Python.
|
8
|
2
|
|
9
|
3
|
# Features
|
10
|
4
|
|
11
|
|
-* follows the RFCs where possible
|
12
|
5
|
* UTF-8 nick and channel names
|
13
|
6
|
* [yaml](http://yaml.org/) configuration
|
14
|
7
|
* server password (PASS command)
|
15
|
8
|
* channels with most standard modes
|
16
|
9
|
* IRC operators (OPER command)
|
17
|
|
-* haproxy [PROXY protocol][proxy-proto] header for hostname setting
|
18
|
10
|
* passwords stored in [bcrypt][go-crypto] format
|
19
|
11
|
* channels that [persist][go-sqlite] between restarts (+P)
|
20
|
12
|
* messages are queued in the same order to all connected clients
|
|
@@ -28,44 +20,37 @@ protect traffic, I recommend using
|
28
|
20
|
[PROXY protocol][proxy-proto]. This will allow the server to get the client's
|
29
|
21
|
original addresses for hostname lookups.
|
30
|
22
|
|
31
|
|
-# What about federation?
|
32
|
|
-
|
33
|
|
-IRC federation solves a problem that was more likely to occur on the internet of
|
34
|
|
-1991 than today. We are exploring alternatives to federation that avoid nickname
|
35
|
|
-and channel sync issues created during netsplits.
|
36
|
|
-
|
37
|
23
|
# Installation
|
38
|
24
|
|
39
|
25
|
```sh
|
40
|
26
|
go get
|
41
|
27
|
go install
|
42
|
|
-cp ergonomadic.yaml ircd.yaml
|
|
28
|
+cp oragono.yaml ircd.yaml
|
43
|
29
|
vim ircd.yaml # modify the config file to your liking
|
44
|
|
-ergonomadic initdb
|
|
30
|
+oragono initdb
|
45
|
31
|
```
|
46
|
32
|
|
47
|
33
|
# Configuration
|
48
|
34
|
|
49
|
|
-See the example [`ergonomadic.yaml`](ergonomadic.yaml). Passwords are base64-encoded bcrypted byte
|
|
35
|
+See the example [`oragono.yaml`](oragono.yaml). Passwords are base64-encoded bcrypted byte
|
50
|
36
|
strings. You can generate them with the `genpasswd` subcommand.
|
51
|
37
|
|
52
|
38
|
```sh
|
53
|
|
-ergonomadic genpasswd
|
|
39
|
+oragono genpasswd
|
54
|
40
|
```
|
55
|
41
|
|
56
|
42
|
# Running the server
|
57
|
43
|
|
58
|
44
|
```sh
|
59
|
|
-ergonomadic run
|
|
45
|
+oragono run
|
60
|
46
|
```
|
61
|
47
|
|
62
|
48
|
# Credits
|
63
|
49
|
|
64
|
|
-* Jeremy Latt, creator, <https://github.com/jlatt>
|
65
|
|
-* Edmund Huber, maintainer, <https://github.com/edmund-huber>
|
66
|
|
-* Niels Freier, added WebSocket support, <https://github.com/stumpyfr>
|
|
50
|
+* Jeremy Latt, creator of Ergonomadic, <https://github.com/jlatt>
|
|
51
|
+* Edmund Huber, maintainer of Ergonomadic, <https://github.com/edmund-huber>
|
|
52
|
+* Niels Freier, added WebSocket support to Ergonomadic, <https://github.com/stumpyfr>
|
67
|
53
|
* apologies to anyone I forgot.
|
68
|
54
|
|
69
|
55
|
[go-crypto]: https://godoc.org/golang.org/x/crypto
|
70
|
56
|
[go-sqlite]: https://github.com/mattn/go-sqlite3
|
71
|
|
-[proxy-proto]: http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt
|