GitHub/ergo
3
0
Fork 0
mirror of https://github.com/ergochat/ergo.git synced 2024-11-25 13:29:27 +01:00
Code Issues Projects Releases Wiki Activity
5ecdc427e8
ergo/README.md
Daniel Oaks 0675b09c88 readme: Simplify and cut down a bunch
2017-03-08 22:19:40 +10:00

3.7 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 it includes features such as UTF-8 nicks / channel names, client accounts with SASL, and other assorted IRCv3 support.

Oragono is a fork of the Ergonomadic IRC daemon <3

Go Report Card Freenode #oragono

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 rfc7613
  • 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 suitable for testing purposes. For real crets, look into Let’s Encrypt!

Configuration

The default config file oragono.yaml helps walk you through what each option means and changes. The configuration’s intended to be sparse, so if there are options missing it’s either because that feature isn’t written/configurable yet or because we don’t think it should be configurable.

Logs

By default, logs are stored in the file ircd.log. The configuration format of logs is designed to be easily pluggable, and is inspired by the logging config provided by InspIRCd.

Passwords

Passwords (for both PASS and oper logins) are stored using bcrypt. To generate encrypted strings for use in the config, use the genpasswd subcommand as such:

oragono genpasswd

With this, you receive a blob of text which you can plug into your configuration file.

Running

After this, running the server is easy! Simply run the below command and you should see the relevant startup information pop up.

oragono run

Credits