mirror of https://github.com/ergochat/ergo.git
79 lines
2.4 KiB
Markdown
79 lines
2.4 KiB
Markdown
# Ergonomadic
|
|
|
|
Ergonomadic is an IRC daemon written from scratch in Go. Pull requests and
|
|
issues are welcome. Discuss it here or on Freenode in [#ergonomadic][irc].
|
|
|
|
## Some Features
|
|
|
|
- follows the RFCs where possible
|
|
- UTF-8 nick and channel names
|
|
- [gcfg][gcfg] gitconfig-style configuration
|
|
- server password (PASS command)
|
|
- channels with most standard modes
|
|
- IRC operators (OPER command)
|
|
- haproxy [PROXY protocol][proxy-proto] header for hostname setting
|
|
- passwords stored in [bcrypt][go-crypto] format
|
|
- channels that [persist][go-sqlite] between restarts (+P)
|
|
|
|
## Why?
|
|
|
|
I wanted to learn Go.
|
|
|
|
## What's with the name?
|
|
|
|
"Ergonomadic" is an anagram of "Go IRC Daemon".
|
|
|
|
## What about SSL/TLS support?
|
|
|
|
Go has a not-yet-verified-as-safe TLS 1.2 implementation. Sadly, many popular
|
|
IRC clients will negotiate nothing newer than SSLv2. If you want to use SSL to
|
|
protect traffic, I recommend using [stunnel][stunnel] version 4.56 with
|
|
haproxy's [PROXY protocol][proxy-proto]. This will allow the server to get the
|
|
client's original addresses for hostname lookups.
|
|
|
|
## What about federation?
|
|
|
|
IRC federation solves a problem that was more likely to occur on the internet of
|
|
1991 than today. We are exploring alternatives to federation that avoid nickname
|
|
and channel sync issues created during netsplits.
|
|
|
|
## Installation
|
|
|
|
```sh
|
|
go get
|
|
go install
|
|
ergonomadic initdb -conf ergonomadic.conf
|
|
```
|
|
|
|
## Configuration
|
|
|
|
See the example [`ergonomadic.conf`][conf]. Passwords are base64-encoded bcrypted byte
|
|
strings. You can generate them with the `genpasswd` subcommand.
|
|
|
|
```sh
|
|
ergonomadic genpasswd 'hunter2!'
|
|
```
|
|
|
|
## Running the Server
|
|
|
|
```sh
|
|
ergonomadic run -conf ergonomadic.conf
|
|
```
|
|
|
|
## IRC Documentation
|
|
|
|
- [RFC 1459: Internet Relay Chat Protocol](http://tools.ietf.org/html/rfc1459)
|
|
- [RFC 2811: IRC Channel Management](http://tools.ietf.org/html/rfc2811)
|
|
- [RFC 2812: IRC Client Protocol](http://tools.ietf.org/html/rfc2812)
|
|
- [RFC 2813: IRC Server Protocol](http://tools.ietf.org/html/rfc2813)
|
|
- [IRC/2 Numeric List](https://www.alien.net.au/irc/irc2numerics.html)
|
|
|
|
|
|
[conf]: blob/master/ergonomadic.conf
|
|
[gcfg]: https://code.google.com/p/gcfg/
|
|
[go-crypto]: http://godoc.org/code.google.com/p/go.crypto
|
|
[go-sqlite]: https://github.com/mattn/go-sqlite3
|
|
[irc]: irc://chat.freenode.net/#ergonomadic
|
|
[proxy-proto]: http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt
|
|
[stunnel]: https://www.stunnel.org/index.html
|