kawaii

ellidri, your kawaii IRC server.

ellidri is an IRC server (or IRCd, for short), that aims to be simple to setup, widely compatible, feature complete and scalable.

Join the IRC channel: #ellidri on freenode!

Features

• RFC 1459 and 2812 compliance (almost! see #1)
• TLS support
• Multiple listening ports
• Capabilities (version 302)
• SASL support with SQLite and PostgreSQL
• kawaii messages

Supported capabilities:

• cap-notify
• echo-message
• message-ids
• message-tags
• sasl
• server-time

ellidri doesn't support any server-to-server (S2S) protocol. As such, it is impossible to make several instances of ellidri manage the same IRC network.

ellidri only supports the UTF-8 encoding for messages, though for now it only supports the ascii casemapping.

Build and install

Prerequisites:

• The Rust compiler (at least version 1.39) and Cargo: https://rustup.rs/
• SQLite 3 (if the sqlite feature is enabled)
• PostgreSQL client libraries (if the postgres feature is enabled)
• On Linux, the OpenSSL library and its development files

Install ellidri with cargo install ellidri, or with the AUR package.

Build it with cargo build. Append the --release flag to build with optimizations enabled.

Usage

ellidri needs a configuration file to run. Its format is the following:

file   =  *( line "\n" )
line   =  sp key sp value sp
key    =  word
value  =  *( word / sp )
sp     =  any sequence of whitespace

An example configuration file with all settings and their defaults can be found in doc/ellidri.conf.

To start ellidri, pass the path of the configuration file as its first argument:

cargo run -- doc/ellidri.conf
# or
./target/debug/ellidri doc/ellidri.conf
# or
./target/release/ellidri doc/ellidri.conf

Contributing

Patches are welcome! Here are some links to get started:

• Documentation: https://docs.rs/ellidri
• Git repository: https://git.sr.ht/~taiite/ellidri
• Send patches to the mailing list: https://lists.sr.ht/~taiite/public-inbox
• Report bugs on the issue tracker: https://todo.sr.ht/~taiite/ellidri

Acknowledgments

ellidri couldn't have existed without the help of https://ircdocs.horse. Thank you Daniel Oaks and all other contributors!

Also thanks to the IRCv3 working group for all the work on modernizing the IRC protocol!

License

ellidri is under the ISC license. See LICENSE for a copy.