From 18be86d3c8ede6eb36b2a75ac357b071cb3b6e4c Mon Sep 17 00:00:00 2001 From: Luke Bratch Date: Mon, 27 May 2019 16:22:32 +0100 Subject: Update README. --- README | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README b/README index 59524a7..ccb7596 100644 --- a/README +++ b/README @@ -14,7 +14,15 @@ 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 == +== Commands == + +Once connected to blabouncer with a client, you can use the following commands: + +"BLABOUNCER REPLAY [seconds]" (Where [seconds] is the number of seconds of replay log to replay.) + +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: @@ -24,4 +32,8 @@ One way of creating these is to use OpenSSL: 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. -- cgit v1.2.3