Go to file
Daniel Oaks 317a804644 Fix dates at top of source files 2017-03-27 22:15:02 +10:00
cmd/oragono-web Move oragono-web to its own directory so go get works, as requested by @jamesog 2017-01-10 19:15:08 +10:00
docs readme: Add note about updating and password gen 2017-03-24 12:43:55 +10:00
irc Fix dates at top of source files 2017-03-27 22:15:02 +10:00
mkcerts Fix dates at top of source files 2017-03-27 22:15:02 +10:00
vendor vendor: Update submodules 2017-03-10 21:27:28 +10:00
web Fix dates at top of source files 2017-03-27 22:15:02 +10:00
.gitignore Start web interface framework 2016-11-06 23:04:30 +10:00
.gitmodules vendor: Update submodules 2017-03-06 22:18:28 +10:00
CHANGELOG.md Setup 0.8.0-unreleased for next release 2017-03-27 22:07:11 +10:00
DEVELOPING.md developing: Add advice for debugging hangs 2017-03-27 14:29:30 +10:00
LICENSE MIT license 2014-02-25 09:54:14 -08:00
README.md readme: Simplify and cut down a bunch 2017-03-08 22:19:40 +10:00
build.sh build: Add Linux ARM (raspi) and fix ARCH 2017-01-10 22:40:14 +10:00
oragono-web.yaml Start web interface framework 2016-11-06 23:04:30 +10:00
oragono.go Fix dates at top of source files 2017-03-27 22:15:02 +10:00
oragono.motd motd: Betterise logo 2016-04-13 11:42:52 +10:00
oragono.yaml config: Allow enabling/disabling channel reg 2017-03-24 12:52:38 +10:00

README.md

Oragono logo

Oragono is a modern, experimental IRC server written in Go. Its 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 Lets Encrypt!

Configuration

The default config file oragono.yaml helps walk you through what each option means and changes. The configurations intended to be sparse, so if there are options missing its either because that feature isnt written/configurable yet or because we dont 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