ergo/README.md

Oragono is a very early, extremely experimental fork of the 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 IRC daemon for something similar written in Python.

This project adheres to Semantic Versioning. For the purposes of versioning, we consider the “public API” to refer to the configuration files, CLI interface and database format.

Features

• UTF-8 nick and channel names
• yaml configuration
• server password (PASS command)
• channels with most standard modes
• IRC operators (OPER command)
• passwords stored in bcrypt format
• channels that persist between restarts (+P)
• messages are queued in the same order to all connected clients

What about SSL/TLS?

There is inbuilt TLS support using the Go TLS implementation. However, stunnel version 4.56 with haproxy’s PROXY protocol may also be used. This will allow the server to get the client’s original addresses for hostname lookups.

Installation

go get
go install
cp oragono.yaml ircd.yaml
vim ircd.yaml  # modify the config file to your liking
oragono initdb
oragono createcerts

Configuration

See the example oragono.yaml. Passwords are stored using bcrypt. You can generate encrypted password strings for use in the config with the genpasswd subcommand.

oragono genpasswd

Running the server

oragono run

Credits

• 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
• Daniel Oakley, maintainer of Oragono, https://github.com/DanielOaks
• apologies to anyone I forgot.