GitHub/ergo
3
0
Fork 0
mirror of https://github.com/ergochat/ergo.git synced 2024-12-22 18:52:41 +01:00
Code Issues Projects Releases Wiki Activity
https://github.com/ergochat/ergo
480 Commits 22 Branches 70 Tags 46 MiB
Go 96.7%
Python 2.7%
Shell 0.4%
Dockerfile 0.1%
ca2255804b
Go to file
Daniel Oaks ca2255804b README: Add info on new SASL stuff
2016-09-07 21:35:43 +10:00
irc accounts: Add SASL EXTERNAL handler 2016-09-07 21:32:58 +10:00
mkcerts mkcerts: Clean up and rename to be nicer 2016-08-13 18:17:40 +10:00
.gitignore db: Add very initial buntdb datastore 2016-08-19 23:21:52 +10:00
CHANGELOG.md README: Add info on new SASL stuff 2016-09-07 21:35:43 +10:00
LICENSE MIT license 2014-02-25 09:54:14 -08:00
oragono.go registration: Add new password manager, integrate registration and credential types 2016-09-05 18:45:42 +10:00
oragono.motd motd: Betterise logo 2016-04-13 11:42:52 +10:00
oragono.yaml config: Add basic reg stuff, remove inaccurate comment (given ircd hash is required for starting db) 2016-09-05 23:01:40 +10:00
README.md README: Add info on new SASL stuff 2016-09-07 21:35:43 +10:00

README.md

Oragono

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.

NOTE: Things are probably very broken right now. The THEATER command does not work, and I’m 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
  • 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