ellidri 2.3.0

Your kawaii IRC server
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

[![builds.sr.ht status](https://builds.sr.ht/~taiite/ellidri.svg)](https://builds.sr.ht/~taiite/ellidri?)
[![crates.io](https://img.shields.io/crates/v/ellidri.svg)](https://crates.io/crates/ellidri)

# kawaii

ellidri, your kawaii IRC server.

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

Join the IRC channel: [#ellidri on freenode][irc]!

[ircd]: https://en.wikipedia.org/wiki/IRCd
[v3]: https://ircv3.net/
[irc]: https://webchat.freenode.net/#ellidri


## Features

- RFC [1459][r1] and [2812][r2] compliance (almost! see [#1][i1])
- TLS support
- Multiple listening ports
- Capabilities (version 302)
- SASL support with SQLite and PostgreSQL
- kawaii messages

Supported capabilities:

- [cap-notify](https://ircv3.net/specs/core/capability-negotiation#cap-notify)
- [echo-message](https://ircv3.net/specs/extensions/echo-message-3.2)
- [message-ids](https://ircv3.net/specs/extensions/message-ids)
- [message-tags](https://ircv3.net/specs/extensions/message-tags)
- [sasl](https://ircv3.net/specs/extensions/sasl-3.1)
- [server-time](https://ircv3.net/specs/extensions/server-time-3.2.html)

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.

[r1]: https://tools.ietf.org/html/rfc1459
[r2]: https://tools.ietf.org/html/rfc2812
[i1]: https://todo.sr.ht/~taiite/ellidri/1


## 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][aur].

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

[aur]: https://aur.archlinux.org/packages/ellidri/


## 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:

```shell
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][ac]!

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

[ac]: https://github.com/ircdocs/modern-irc/graphs/contributors
[i3]: https://ircv3.net/charter


## License

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