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
700c0797b9
ergo/README.md
Daniel Oaks ddba5af265 Update changelog and readme
2017-01-11 22:52:15 +10:00

3.1 KiB
Raw Blame History

Oragono logo

Oragono is a modern, experimental IRC server written in Go. It’s designed to be simple to setup and use, and to provide the majority of features that IRC users expect today.

It includes features such as UTF-8 nicks and channel names, client accounts and SASL, and other assorted IRCv3 support.

Oragono is a fork of the Ergonomadic IRC daemon <3

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.

Oragono

Features

  • UTF-8 nick and channel names with rfc7700
  • yaml configuration
  • native TLS/SSL support
  • server password (PASS command)
  • an extensible privilege system for IRC operators
  • ident lookups for usernames
  • automated client connection limits
  • on-the-fly updating server config and TLS certificates (rehashing)
  • client accounts and SASL
  • passwords stored with bcrypt (client account passwords also salted)
  • banning ips/nets and masks with KLINE and DLINE
  • IRCv3 support
  • a heavy focus on developing with specifications
  • integrated (alpha) REST API and web interface

Installation

go build oragono.go
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 testing 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

oragono run

Web interface

Oragono also includes a web interface, which works with the REST API to provide a way to manage user accounts and bans.

This interface is an early alpha, is in no way secure and will not be in a final release for a while. Requires the alpha REST API to be enabled (check your server config to enable that if you really want to).

Installation

go build oragono-web.go
cp oragono-web.yaml web.yaml
vim web.yaml  # modify the config file to your liking
oragono-web mkcerts

Running

oragono-web run

Credits