summaryrefslogtreecommitdiff
path: root/blabouncer.conf.example
blob: f5007c477fca8cf74d240e07973c20c919ed10b2 (plain)
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# blabouncer configuration file
#
# Normal entries must be in the form:
# option name, space, equals sign, space, double quote, option value, double quote
# e.g.
# realname = "Mr Bla Bouncer"
#
# Array entries must be in the form:
# option name, space, equals sign, space, open brace
# (optional indentation,) double quote, element value, double quoute
# (optional multiple values to be repeated after the first one(s))
# close brace
# e.g.
# connectcommands = {
#   "PRIVMSG NickServ IDENTIFY bananas"
#   "PRIVMSG myfriend I'm online!"
# }
#
# Shell expansion is not supported, so do not try and specify e.g.
# "~/.blabouncer/" or "$HOME/.blabouncer/", instead use "/home/foo/.blabouncer"
#
# Some settings can be reloaded at runtime, please refer to README for details.

# Nick(s) to use when connecting - will be cycled through in order in the event of
# a nick being in use or invalid
nicks = {
  "blabounce"
  "bbounce2"
  "bbounce3"
}

username = "bounceusr"
realname = "Mr Bla Bouncer"

# Channels to automatically join (defaults to none)
# Put channel keys/passwords after channel names (separated with a space)
channels = {
  "#blabouncer keyword"
  "#test"
}

# Auto replay mode upon a bouncer client connecting
# "none" = Don't auto replay
# "time" = Always send the last "replayseconds" worth of logs
# "lastspoke" = All messages since your current nick last spoke
# "noclients" = All messages since you last had no clients connected
# "lastchange" = All messages since your last client connection/disconnection
# "perclient" = All messages since the current client last disconnected (see README)
replaymode = "time"

# How many seconds of replay log should be sent to connecting clients if replaymode = "time"
replayseconds = "600"

# Should replay log timestamps include the date when replaying? ("1" for yes or "0" for no)
replaydates = "0"

# Connect password clients must provided to connect
password = "bananas"

# Port the bouncer should listen on
clientport = "1234"

# Enable TLS for clients connecting to the bouncer ("1" for yes or "0" for no)
# If "0" then certfile and keyfile need not be set
clienttls = "1"

# Enable TLS for the bouncer connecting to the IRC server ("1" for yes or "0" for no)
servertls = "1"

# Real IRC server the bouncer connects to
ircserver = "irc.blatech.net"

# Real IRC server port
ircserverport = "6697"

# Real IRC server password
#ircserverpassword = "apples"

# Command(s) to send to the server upon completing registration (e.g. a NickServ password)
#connectcommands = {
#  "PRIVMSG NickServ IDENTIFY bananas"
#  "PRIVMSG myfriend I'm online!"
#}

# Base directory (defaults to $HOME/.blabouncer/)
# Things such as the logs directory will be placed below this
#basedir = "/home/foo/.blabouncer/"

# Certificate file (defaults to <basedir>/cert.pem)
# If clienttls = "0" then this need not be set
#certfile = "/home/foo/.blabouncer/cert.pem"

# Certificate key file (defaults to <basedir>/key.pem)
# If clienttls = "0" then this need not be set
#keyfile = "/home/foo/.blabouncer/key.pem"

# OpenSSL security level, from 0 to 5 at the time of writing, left at the OpenSSL default if undefined,
# see https://docs.openssl.org/master/man3/SSL_CTX_set_security_level/#default-callback-behaviour
# for further details
#sslseclevel = "2"

# Enable logging ("1" for yes or "0" for no)
# Logs go to basedir/logs/ with one file per channel/nick
logging = "1"

# Enable replay logging ("1" for yes or "0" for no)
# Replay log goes to basedir/replay.log
replaylogging = "1"

# Debug verbosity ("0" for critical only, "1" for some extra info, "2" for full debug mode)
# (All output goes to <basedir>/debug.txt)
debug = "2"

# Number of debug logs to keep
debugkeep = "5"

# Send NOTICE to all other clients upon new client connections ("1" for yes or "0" for no)
alertconnect = "1"

# Send NOTICE to all other clients upon clients failing to authenticate ("1" for yes or "0" for no)
alertauthfail = "1"

# Send NOTICE to all other clients upon clients succesfully authenticating ("1" for yes or "0" for no)
alertauthsuccess = "1"

# Send NOTICE to all other clients upon unauthenticated client disconnections ("1" for yes or "0" for no)
alertunautheddisconnect = "1"

# Send NOTICE to all other clients upon authenticated client disconnections ("1" for yes or "0" for no)
alertautheddisconnect = "1"

# Check for updates upon startup and successful client authentication ("1" for yes or "0" for no)
# This sends a DNS TXT request to blatech.net, disable this if you do not wish for that to happen
checkupdates = "1"