From ba40937ad1b15d2a319cd472045f85eb32e4d5b5 Mon Sep 17 00:00:00 2001 From: Luke Bratch Date: Sun, 19 May 2019 19:49:23 +0100 Subject: Add README and TODO files. --- README | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 0000000..94777e6 --- /dev/null +++ b/README @@ -0,0 +1,27 @@ +blabouncer - An IRC client written in C + +== Compiling == + +To compile run "make". + +== Running == + +To run from the current directory once compiled run "./blabouncer". + +== Configuration == + +An example configuration file is provided named "blabouncer.conf". + +If you don't specify one using "-c /path/to/configuration/file" then the example configuration one will be created for you in $HOME/.blabouncer/ when starting. + +== SSL/TLS == + +To use TLS for client connections, which is enabled by default in the example configuration file, you will need to provide both a certificate and a key file. +One way of creating these is to use OpenSSL: + +# openssl genrsa 2048 > key.pem +# openssl req -x509 -days 30 -new -key key.pem -out cert.pem + +But you can create them however you like, or disable client TLS (not recommended) using the "clienttls" configuration file option. + +Server TLS is also enabled by default in the example configuration file, and can be disabled (not recommended) using the "servertls" configuration file option. -- cgit v1.2.3