prologic/eris repository overview

eris - IRC Server / Daemon written in Go

From Eris⁠ and Eristic⁠

The connotation here is that IRC (Internet Relay Chat) is a place of chaos, strife and discord. IRC is a place where you argue and get into arguments for the sake of argument.

So eris is an IRC daemon written from scratch in Go to facilitate discord and have arguments for the sake of argument!

Pull requests and issues are welcome.

Discussion at:

• /server irc.mills.io +6697 (use TLS/SSL)
• /join #lobby

Or (not recommended):

• /server irc.mills.io (default port 6667, non-TLS)
• /join #lobby

⁠Features

• follows the RFCs where possible
• UTF-8 nick and channel names
• yaml⁠ configuration
• server password (PASS command)
• channels with most standard modes
• IRC operators (OPER command)
• passwords stored in [bcrypt][go-crypto] format
• messages are queued in the same order to all connected clients
• SSL/TLS support
• Simple IRC operator privileges (overrides most things)
• Secure connection tracking (+z) and SecureOnly user mode (+Z)
• Secure channels (+Z)
• Three layers of channel privacy, Public, Private (+p) and Secret (s)

⁠Quick Start

$ go get github.com/prologic/eris
$ cat > ircd.yml <<EOF
network:
  name: Test
server:
  name: Test
  listen:
    - ":6667"
EOF
$ eris

If you want TLS (recommended) then:

$ go get github.com/prologic/mksslcert
$ mksslcert

This generates a self-signed cert cert.pem and key.pem into the $PWD.

Then add a tlslisten block to your config:

server:
  tlslisten:
    ":6697":
      key: key.pem
      cert: cert.pem

⁠Installation

$ go install github.com/prologic/eris
$ eris --help

⁠Configuration

See the example ircd.yml⁠. Passwords are base64-encoded bcrypted byte strings. You can generate them with the mkpasswd tool from prologic/mkpasswd⁠:

$ go install github.com/prologic/mkpasswd
$ mkpasswd

Self-signed certificates can also be generated using the mksslcert tool from prologic/mksslcert⁠:

$ go install github.com/prologic/mksslcert
$ mksslcert

⁠Deployment

To run simply run the eris binary (assuming a ircd.yml in the current directory):

$ eris

Or you can deploy with Docker⁠ using the prebuilt prologic/eris⁠:

docker run -d -p 6667:6667 -p 6697:6697 prologic/eris

You may want to customize the configuration however and create your own image based off of this; or deploy with docker stack deploy on a Docker Swarm⁠ clsuter like this:

$ docker stack deploy -c docker-compose.yml eris

Which assumes a ircd.yml coniguration file in the current directory which Docker will use to distribute as the configuration. The docker-compose.yml (Docker Stackfile) is available at the root of this repository.

⁠Related Projects

There are a number of supported accompanying services that are being developed alongside Eris:

• Soter⁠ -- An IRC Bot that persists channel modes and topics.
• Cadmus⁠ -- An IRC Bot that logs channels and provides an interface for viewing and searching logs

⁠Recommended Clients

⁠CLI / Terminal

• irccat⁠
• irssi⁠

⁠Cloud

• IRCCloud⁠

⁠Desktop

• HexChat (Linux)⁠
• Textual (OSX)⁠
• mIRC (Windows)⁠

⁠Mobile

• Palaver (iOS)⁠ -- SASL, TLS, Server Password, Push Notifications, IRCv3 (Also supports custom image upload service(s) for better privacy of shared photos/images over IRC)

⁠Web

• Dispatch⁠ -- TLS, Multiple Servers and Users, Client Certificates

⁠Related Projects

• cadmus⁠ -- an IRC Bot written in Go that logs IRC Channels and provides an interface to view and search those logs
• soter⁠ -- an IRC Bot written in Go that protects IRC Channels by persisting channel modes and topics

⁠License

eris is licensed under the MIT License.