Mirror/ergo
1
0
Fork 0
mirror of https://github.com/jeremyd/ergo.git synced 2026-05-04 19:29:09 -07:00
Code Issues Packages Projects Releases Wiki Activity

ergonomadic -> oragono. I'm making lots of changes and this is AN EXPERIMENT. I want to differentiate this from Ergonomadic proper

Browse Source
This commit is contained in:
Daniel Oaks
2016-04-13 08:55:37 +10:00
parent 29d80366a6
commit c0c16c72f0
4 changed files with 22 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -1,20 +1,12 @@
Ergonomadic (anagram of "go IRC daemon") is an IRC daemon written from scratch
in Go. Pull requests and issues are welcome.
Discussion at:
* host/port: irc.skub.club:6697, use SSL
* password: smellyoulater
* #darwin
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.
# Features
* follows the RFCs where possible
* UTF-8 nick and channel names
* [yaml](http://yaml.org/) 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)
* messages are queued in the same order to all connected clients
@@ -28,44 +20,37 @@ protect traffic, I recommend using
[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
cp ergonomadic.yaml ircd.yaml
cp oragono.yaml ircd.yaml
vim ircd.yaml # modify the config file to your liking
ergonomadic initdb
oragono initdb
```
# Configuration
See the example [`ergonomadic.yaml`](ergonomadic.yaml). Passwords are base64-encoded bcrypted byte
See the example [`oragono.yaml`](oragono.yaml). Passwords are base64-encoded bcrypted byte
strings. You can generate them with the `genpasswd` subcommand.
```sh
ergonomadic genpasswd
oragono genpasswd
```
# Running the server
```sh
ergonomadic run
oragono run
```
# Credits
* Jeremy Latt, creator, <https://github.com/jlatt>
* Edmund Huber, maintainer, <https://github.com/edmund-huber>
* Niels Freier, added WebSocket support, <https://github.com/stumpyfr>
* Jeremy Latt, creator of Ergonomadic, <https://github.com/jlatt>
* Edmund Huber, maintainer of Ergonomadic, <https://github.com/edmund-huber>
* Niels Freier, added WebSocket support to Ergonomadic, <https://github.com/stumpyfr>
* apologies to anyone I forgot.
[go-crypto]: https://godoc.org/golang.org/x/crypto
[go-sqlite]: https://github.com/mattn/go-sqlite3
[proxy-proto]: http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt