3
0
mirror of https://github.com/ergochat/ergo.git synced 2024-11-10 22:19:31 +01:00
ergo/README.md
2016-08-13 18:17:40 +10:00

2.6 KiB
Raw Blame History

Oragono

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.


Go Report Card


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.

NOTE: Things are probably very broken right now. The THEATER command does not work, and Im currently most of the way through rearchitecting the command handling. It should be finished apart from the THEATER command, but things are probably still broken.

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 haproxys PROXY protocol may also be used. This will allow the server to get the clients 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 mkcerts

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