README


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

blabouncer - An IRC client written in C

== Compiling ==

To compile run "make".

== Running ==

To run from the current directory once compiled run "./blabouncer".

Running with command line arguments takes the form:
./blabouncer [-f] [-c /path/to/blabouncer.conf]

-f sets foreground mode (without this, blabouncer will detach and run in the background as a daemon)
-c sets a path to a configuration file (this is optional)

Arguments are all optional, but they must be specified in the order shown above.

== 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.

== Commands ==

Once connected to blabouncer with a client, you can use the following commands:

"BLABOUNCER REPLAY [[[[days:]hours:]minutes:]seconds]" (To replay a given length of time of replay log.)
"BLABOUNCER QUIT [quit message]" (To quit blabouncer, optionally sending [quit message] to the server.)

Blabouncer commands are all prefixed with BLABOUNCER which you can usually send using "/QUOTE BLABOUNCER".

== Client 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 > ~/.blabouncer/key.pem
# openssl req -x509 -days 30 -new -key ~/.blabouncer/key.pem -out ~/.blabouncer/cert.pem

But you can create them however you like, or disable client TLS (not recommended) using the "clienttls" configuration file option.

By default blabouncer looks for the certificate and key files in $HOME/.blabouncer/cert.pem and $HOME/.blabouncer/key.pem, respectively.

== Server SSL/TLS ==

Server TLS is also enabled by default in the example configuration file, and can be disabled (not recommended) using the "servertls" configuration file option.