Settings

These are the settings available in shroudBNC. Note that this just lists the default changeable settings included with sBNC, and not the ones provided by userscripts.

• sbnc.conf: system.dontmatchuser
• Default: 0
• Description: Whether to check the username if the user's ssl certificate already unambiguously matches a user.

• sbnc.conf: system.hosts.host<number>
• Default: n/a
• Description: List of hostnames which have access to the bouncer.

• sbnc.conf: system.ip
• Default: 0.0.0.0
• Description: The ip address which should be used for binding the main listener(s).

• sbnc.conf: system.listerners.listener<number>
• Default: n/a
• Description: List of additional listeners.

• sbnc.conf: system.max<resource>
• Default: n/a
• Description: Resource limits (<resource> can be: memory, channels, bans, keys, clients).

• sbnc.conf: system.md5
• Default: 1
• Description: Whether the users' passwords are stored using md5 hashes.

• sbnc.conf: system.modules.mod<number>
• Default: n/a
• Description: List of module filenames.

• sbnc.conf: system.motd
• Default: <empty>
• Description: The bouncer's motd (see /sbnc help motd).

• sbnc.conf: system.port
• Default: n/a
• Description: The bouncer's main port.

• sbnc.conf: system.realname
• Default: shroudBNC User
• Description: The default realname for users who have not specified a realname.

• sbnc.conf: system.sendq
• Default: 10240
• Description: The sendq size (in kB).

• sbnc.conf: system.sslport
• Default: n/a
• Description: The bouncer's main SSL port.

• sbnc.conf: system.users
• Default: <empty>
• Description: List of usernames.

• sbnc.conf: system.vhost
• Default: n/a
• Description: The default vhost for users who have not specified a vhost.

Settings found in ”~/sbnc/users/<user>.conf”.

• <user>.conf: user.admin
• Default: 0
• Description: Whether the user is an admin.

• <user>.conf: user.away
• /sbnc set: away
• Default: <empty>
• Description: Away reason (/away.

• <user>.conf: user.awaymessage
• /sbnc set: awaymessage
• Default: <empty>
• Description: The user's away message (spammed to all chans, /ame style).

• <user>.conf: user.awaynick
• /sbnc set: awaynick
• Default: <empty>
• Description: Away nick.

• <user>.conf: user.automodes
• /sbnc set: automodes
• Default: <empty>
• Description: Auto modes (applied when you attach).

• <user>.conf: user.channels
• Default: <empty>
• Description: Comma-seperated list of channels.

• <user>.conf: user.channelsort
• Default: cts
• Description: How to order channels, options: cts (client timestamp), alpha (alphabetical), custom (using sort module handler).

• <user>.conf: user.delayjoin
• /sbnc set:
• Default: 0
• Description: Whether to delay-join channels (usually just used by scripts).

• <user>.conf: user.dropmodes
• /sbnc set: dropmodes
• Default: <empty>
• Description: Dropped modes (removed when you detach).

• <user>.conf: user.ident
• Default: <user>
• Description: Ident for the user.

• <user>.conf: user.ignsysnotices
• /sbnc set: sysnotices
• Default: 0
• Description: Whether the user should receive system notices.

• <user>.conf: user.ip
• /sbnc set: vhost
• Default: <empty>
• Description: The user's vhost.

• <user>.conf: user.ipv6
• /sbnc set: ipv6
• Default: 0
• Description: Whether the user's server uses ipv6.

• <user>.conf: user.lean
• Default: 0
• Description: Lean mode (see lean for details).

• <user>.conf: user.lock
• Default: 0
• Description: Whether the user is suspended.

• <user>.conf: user.max<resource>
• Default: n/a
• Description: User-specific resource limits (<resource> can be: memory, channels, bans, keys, clients).

• <user>.conf: user.nick
• Default: <empty>
• Description: The user's nick.

• <user>.conf: user.password
• /sbnc set: password
• Default: n/a
• Description: The user's password ((salted) md5 hash if system.md5 is 1).

• <user>.conf: user.port
• /sbnc set: server
• Default: 6667
• Description: The port of the irc server for this user.

• <user>.conf: user.quitaway
• /sbnc set: usequitasaway
• Default: 0
• Description: Whether to use the user's /quit reason as the away reason.

• <user>.conf: user.quitted
• Default: 0
• Description: Whether the user should stay disconnected from the irc server.

• <user>.conf: user.realname
• /sbnc set: realname
• Default: shroudBNC User
• Description: The user's realname.

• <user>.conf: user.seen
• Default: n/a
• Description: Timestamp when the user was last seen.

• <user>.conf: user.server
• /sbnc set: server
• Default: <empty>
• Description: The IRC server's IP/hostname.

• <user>.conf: user.spass
• /sbnc set: serverpass
• Default: <empty>
• Description: IRC server password.

• <user>.conf: user.ssl
• /sbnc set: ssl
• Default: 0
• Description: Whether the user's server uses ssl.

• <user>.conf: user.suspend
• Default: <empty>
• Description: Suspend reason for the user.

• <user>.conf: user.ts
• /sbnc set: appendtimestamp
• Default: 0
• Description: Whether to append a timestamp to the user's away reason.

• <user>.conf: user.tz
• /sbnc set: timezone
• Default: 0
• Description: GMT offset.