diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 27 |
1 files changed, 27 insertions, 0 deletions
@@ -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. |