GitHub/ergo
3
0
Fork 0
mirror of https://github.com/ergochat/ergo.git synced 2024-11-10 22:19:31 +01:00
Code Issues Projects Releases Wiki Activity
09802f7181
ergo/README.md
Daniel Oaks db1309e69b Update docs to match rfc7700 stuff
2016-10-11 23:54:13 +10:00

2.3 KiB
Raw Blame History

Oragono logo

Oragono is an IRC daemon written in Go. It’s an early, experimental fork of the Ergonomadic IRC daemon.

Also see the mammon IRC daemon for a similar project written in Python instead.

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.

Features

  • UTF-8 nick and channel names with rfc7700
  • yaml configuration
  • native TLS/SSL support
  • server password (PASS command)
  • channels with most standard modes
  • IRC operators
  • ident lookups for usernames
  • passwords stored in bcrypt format
  • channels that persist between restarts (+P)
  • client accounts and SASL
  • IRCv3 support

What about TLS/SSL?

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 mkcerts

Note: This installation will give you unsigned certificates only suitable for teting purposes. For real crets, look into Let’s Encrypt.

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