Update readme

This commit is contained in:
Les De Ridder 2020-11-14 23:08:27 +01:00
parent 95f3d8fabd
commit 5eea8a71f1
2 changed files with 27 additions and 8 deletions

View File

@ -1,19 +1,38 @@
# salty-ircd
salty-ircd is an [Internet Relay Chat](https://en.wikipedia.org/wiki/Internet_Relay_Chat) daemon written in [D](https://dlang.org/).
## Goals
The main goals of salty-ircd are strict RFC compliance and security.
### RFC compliance
salty-ircd aims to be fully compliant with the IRC RFCs (in 'RFC mode'), specifically [RFC 1459](https://tools.ietf.org/html/rfc1459), [RFC 2811](https://tools.ietf.org/html/rfc2811), [RFC 2812](https://tools.ietf.org/html/rfc2812), and [RFC 2813](https://tools.ietf.org/html/rfc2813) (planned).
Newer RFCs take precedence over older RFCs. Errata are respected by default, with newer errata (on the same RFC) taking precedence over older errata.
salty-ircd aims to be fully compliant with the IRC RFCs (in 'RFC mode'), specifically [RFC 1459](https://tools.ietf.org/html/rfc1459), [RFC 2811](https://tools.ietf.org/html/rfc2811), [RFC 2812](https://tools.ietf.org/html/rfc2812), and [RFC 2813](https://tools.ietf.org/html/rfc2813) (planned), including all errata.
Newer RFCs take precedence over older RFCs.
Any additional features breaking RFC compliance will be made available through compile-time options (i.e. 'non-RFC modes').
Any additional features breaking RFC compliance are available through compile-time options.
### Security (non-RFC modes)
* salty-ircd will require TLS for all connections. An exception could be made to allow hosting a Tor hidden service.
* salty-ircd will require TLS client certificates for authentication.
### Security
The following rules apply when any compile-time option is enabled (breaking strict RFC compliance):
* TLS is required for all connections, except connections from localhost (useful for running a Tor hidden service, which already has encryption)
* TLS client certificates are required for oper and vhost authentication
## Building
Build dependencies:
* A D compiler
* dub
* fish
* git
Build command:
* RFC compliant: `dub build`
* With all additional features: `dub build -c=modern`
TODO: Add a way to supply a custom list of compile-time options.
## Running
First, create the configuration file, `config.sdl`. You can find a template in `config.template.sdl`.
Then, simply run `./out/salty-ircd`.
## License
The source code for salty-ircd is licensed under the [University of Illinois/NCSA Open Source License](LICENSE).

View File

@ -15,5 +15,5 @@ configuration "compliant" {
}
configuration "modern" {
versions "BasicFixes" "SupportTLS"
versions "Modern"
}