File: README.settings

package info (click to toggle)
sbnc 1.2-26
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 6,216 kB
  • sloc: cpp: 17,556; ansic: 15,514; sh: 13,419; tcl: 5,567; php: 448; makefile: 284
file content (60 lines) | stat: -rw-r--r-- 3,409 bytes parent folder | download | duplicates (3)
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
shroudBNC Configuration
-----------------------

This document is supposed to give some insight into the available configuration options (i.e. for sbnc.conf and the
users' configuration files). You should usually not edit these files manually unless you know what you are doing.

sbnc.conf
---------

Option				| Default Value		| Purpose
--------------------------------------------------------------------------------
system.port			| N/A			| the bouncer's main port
system.sslport			| N/A			| the bouncer's main ssl port
system.md5			| 1			| whether the users' passwords are stored using md5 hashes
system.vhost			| N/A			| the default vhost for users who have not specified a vhost
system.ip			| 0.0.0.0		| the ip address which should be used for binding the main listener(s)
system.motd			| <empty>		| the bouncer's motd (see /sbnc help motd)
system.realname			| shroudBNC User	| the default realname for users who have not specified a realname
system.sendq			| 10240			| the sendq size (in kB)
system.dontmatchuser		| 0			| whether to check the username if the user's ssl certificate already unambiguously matches a user
system.users			| <empty>		| list of usernames
system.hosts.host<Nr>		| N/A			| list of hostnames which have access to the bouncer
system.modules.mod<Nr>		| N/A			| list of module filenames
system.listeners.listener<Nr>	| N/A			| list of additional listeners
system.max<Resource>		| N/A			| resource limits (options are: memory, channels, bans, keys, clients)

User configuration files
------------------------

Option				| Default Value		| Purpose
--------------------------------------------------------------------------------
user.password			| N/A			| the user's password (md5 hash if system.md5 == 1)
user.admin			| 0			| whether the user is an admin
user.max<Resource>		| N/A			| user-specific resource limits
user.quitted			| 0			| whether the user should stay disconnected from the irc server
user.ts				| 0			| whether to append a timestamp to the user's away reason
user.port			| 6667			| the port of the irc server for this user
user.lock			| 0			| whether the user is suspended
user.seen			| N/A			| timestamp when the user was last seen
user.delayjoin			| 0			| whether to delay-join channels (usually just used by scripts)
user.ssl			| 0			| whether the user's server uses ssl
user.ipv6			| 0			| whether the user's server uses ipv6
user.ignsysnotices		| 0			| whether the user should receive system notices
user.lean			| 0			| lean mode (see README.lean for details)
user.quitaway			| 0			| whether to use the user's /quit reason as the away reason
user.automodes			| <empty>		| automodes
user.dropmodes			| <empty>		| dropmodes
user.away			| <empty>		| away reason (/away)
user.awaynick			| <empty>		| away nick
user.nick			| <empty>		| the user's nick
user.realname			| <empty>		| the user's realname
user.server			| <empty>		| the irc server's hostname
user.ip				| <empty>		| the user's vhost
user.channels			| <empty>		| comma-seperated list of channels
user.suspend			| <empty>		| suspend reason for the user
user.spass			| <empty>		| irc server password
user.ident			| the user's username	| ident for the user
user.tz				| 0			| gmt offset
user.awaymessage		| <empty>		| the user's away message (spammed to all chans, /ame style)
user.channelsort		| cts			| how to order channels, options: cts (client ts), alpha (alphabetical), custom (using sort module handler)