kawaii

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)
• IRCv3 support
• TODO: Secure and production-ready setup with TLS out-of-the-box
• Configurable via a file
• SASL support with SQLite and PostgreSQL
• kawaii messages

cap-notify, echo-message, extended-join, invite-notify, labeled-response, message-ids, message-tags, multi-prefix, sasl, server-time, setname, userhost-in-names

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 requires UTF-8 from clients, and for now it only supports ascii as casemapping.

Build and install

Prerequisites:

• The Rust compiler (at least version 1.39, or v1.41 when using PostgreSQL) 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.

During development, build it with cargo build, and run it with cargo run.

For packaging, build it with cargo build --release --locked. The release flag will enable optimizations and the locked flag will require a valid lock file (Cargo.lock), to make sure that the same dependencies are used for development and for release. The executable is generated at target/release/ellidri.

Usage

Note: for now this is being worked on, and the only option to run ellidri is with a configuration file, like so: ellidri CONFIG_FILE. Type ellidri --help for help. In the long term, ellidri will fetch certificates from caddy and certbot by default, since in a setup with ports 80 and 443 taken by a HTTP server fetching certificate is practically impossible.

If you already have a domain name, the simplest way to start ellidri is by the command below. ellidri will get certificates from Let's Encrypt, and listen on ports 6667 (plain-text) and 6697 (TLS). It will also enable STS so that modern clients are redirected to the TLS-enabled port. If you specify the --database argument, ellidri will also connect to the given database and enable SASL.

ellidri --domain your.domain.tld [--database sqlite:///var/lib/ellidri/example.db]

If you want more configuration options, you can instead write a configuration file, like the following:

```conf

Configuration file

domain your.domain.tld

Manually bind to an address and port. ellidri will not listen on default

ports like above nor generate certificates if you specify bind_to.

bind_to 127.0.0.1:6667

TLS-enabled port, with a PKCS12 archive.

bind_to 0.0.0.0:7000 /var/lib/ellidri/identity.p12

Default is /etc/motd

motdfile custommotd.txt ```

And start ellidri with the --conf argument like so:

ellidri --conf /path/to/the.configuration.file

An example configuration file with all settings and their defaults can be found in 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
• Submit PRs on Github or 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.