Synchronet v3.17b-Win32 (install) has been released (Jan-2019).

New Synchronet YouTube channel

You can donate to the Synchronet project using PayPal.

This is an old revision of the document!


sbbs.ini

The Synchronet BBS (SBBS) Initialization File is the mother of all Synchronet configuration files and is located in the ctrl directory.

Filename

The base filename of the initialization file is ctrl/sbbs.ini.

The standard host/platform variations of the initialization filenames are also supported. See INI Filenaming for details.

Defaults

Download or view the default sbbs.ini file here: sbbs.ini

Editing

When using the Synchronet-Win32 Control Panel, the contents of this file are automatically updated when any of the configuration changes are made in the File->Properties menu or the various server configuration dialogs. Windows sysops may never need to edit this file by hand.

If a sysop needs to edit the file by hand, any decent text file editor should do the job. See INI files for more details.

Sections

The contents of the file are divided into multiple named sections:

[Global]

The [Global] section contains keys whose values will serve as default values for like-named keys in other server sections in the sbbs.ini file.

These keys are:

Hostname

Default: <none>

The public Internet hostname of this server.

If not set, the hostname configured in SCFG->Networks->Internet E-mail Address will be used.

Interface

Default: <any>

The IPv4 and/or IPv6 address of the network interfaces to listen for incoming TCP/IP connections on.

If multiple address are specified, they are to be separated by commas (this is true of all the *Interface values in this file).

If not set, any and all network interfaces available will be listened on.

CtrlDirectory

Default: $SBBSCTRL

Specify the location of the Synchronet ctrl directory. Since this file is normally found in the ctrl directory (e.g. by way of the SBBSCTRL environment variable) you do not normally need to set this.

TempDirectory

Default: ctrl/../temp

Override the default system “temp” directory (optional). If you do override this, do NOT use the system-wide temp dir (e.g.: /tmp or windows\temp), use a subdirectory instead. Synchronet assumes it is the only user of this directory/subdirectory for its temporary files only.

SemFileCheckFrequency

Default: 2 (seconds) Minimum: 1 (seconds)

The interval, in seconds, betweeen semaphore file checks. If you want to reduce the amount of disk I/O while the BBS is idle, you can increase this value. If you set this value below 1, the BBS server threads will use the default value (2).

BindRetryCount

Default: 2

Set the number of times an interface bind will be attempted for each port (before giving up and failing to start/restart the server). An interface/port bind is required for listening for incoming TCP/IP connections.

Increase this value if you get errors binding to ports on reloads (especially on *nix).

BindRetryDelay

Default: 15 (seconds)

Delay (in seconds) between bind retries.

LogLevel

Default: Debugging

Highest log level to actually log/print (ignore all higher/less-severe log entries). Supported log levels in decreasing severity (ala syslog):

Emergency, Alert, Critical, Error, Warning, Notice, Informational, Debugging

JavaScriptMaxBytes

Default: 8M

Maximum allocation of memory per JavaScript run-time.

JavaScriptContextStack

Default: 16K

Maximum stack size per JavaScript context.

JavaScriptTimeLimit

Default: 864000 (24 hours)

Maximum number of ticks (100ms) before auto-termination of a JavaScript script (i.e. infinite loop detection).

Set to 0 for unlimited time (disables infinite loop detection).

Note: This key replaces the old JavaScriptBranchLimit key which is no longer used (as of Synchronet v3.16).

JavaScriptGcInterval

Default: 100

JavaScript Garbage Collection interval (in ticks).

Set to 0 for never.

JavaScriptYieldInterval

Default: 10000

Time-slice yield interval (in ticks).

Set to 0 for never.

JavaScriptLoadPath

Default: load

Comma-separated list of load paths (relative to exec or mods directories).

These are the directories/sub-directories where the JavaScript load() method will search for filenames to be loaded by other scripts.

LoginAttemptDelay

Default: 5000 (milliseconds)

The number of milliseconds to pause after a failed login attempt.

LoginAttemptThrottle

Deafult: 1000 (milliseconds)

This value is multiplied by the number of consecutive unique failed login attempts and the result is the number of milliseconds to delay a connection from a suspicious host (e.g. with multiple consecutive unique failed login attempts).

LoginAttemptHackThreshold

Default: 10 (attempts)

The number of consecutive unique failed login attempts from the same host before adding entries to the hack.log file.

Set to 0 to disable automatic hack.log file entries for failed login attempts.

LoginAttemptTempBanThreshold

Default: 20 (attempts)

The number of consecutive unique failed login attempts from the same host before temporarily banning connections from that client (based o IP address).

Set to 0 to disable automatic banning.

NOTE: Failed logins using any of the filtered user IDs (from name.can) will automatically trigger a temporary ban.

NOTE: Added in v3.17 (May-2016)

LoginAttemptTempBanDuration

Default: 10M (10 minutes)

The length (in seconds) of a temporary IP ban based on either multiple consecutive failed login attempts or any failed login attempt using a banned user ID (from name.can).

NOTE: Added in v3.17 (May-2016)

LoginAttemptFilterThreshold

Default: 0 (attempts)

The number of consecutive unique failed login attempts from the same host before auto-filtering the host's IP address in the ip.can file.

For this auto-filtering feature to work with the Synchronet v3.16c Terminal Server (Telnet, RLogin, and SSH login attempts), the sysop must set SCFG->Nodes->Node 1->Toggle Options->Always Prompt for Password to “Yes”.

Set to 0 to disable automatic filtering of IP addresses due to failed login attempts.

[BBS]

See Terminal Server for more details.

In addition to the keys listed in the [Global] section, the [BBS] section can contain the following keys with the specified default values:

AutoStart

Default: true

Automatically startup the Terminal Server when Synchronet starts up.

TelnetInterface

Default: value of [Global] Interface

The IPv4 and/or IPv6 addresses of the network interfaces to listen on for incoming Telnet connections on (0 for any IPv4 interface, and :: for any IPv6 interface)).

TelnetPort

Default: 23

The TCP port number on which to listen for incoming Telnet connections.

RLoginInterface

Default: value of [Global] Interface

The IPv4 and/or IPv6 addresses of the network interfaces to listen on for incoming RLogin connections on (0 for any interface).

RLoginPort

Default: 513

The TCP port number on which to listen for incoming RLogin connections.

SSHInterface

Default: value of [Global] Interface

The IPv4 and/or IPv6 address of the network interfaces to listen for incoming Secure Shell (SSH) connections on (0 for any interface).

SSHPort

Default: 22

The TCP port number on which to listen for incoming Secure Shell (SSH) connections.

SSHConnectTimeout

Default: 10 (seconds)

The maximum amount of time allowed for a SecureShell (SSH) connection negotiation to complete.

Pet40Port

Default: 64

If a connection is made to the Terminal server, via any supported protocol, on this TCP port number, the terminal will be assumed to be a 40-column CBM/PETSCII (non-ANSI) terminal (e.g. Commodore 64). Setting this port number does not cause the server to listen on this port, so if you desire to support CBM/PETSCII terminal-connections, you will also need to add this port number to the TelnetInterface list (for example).

Pet80Port

Default: 128

If a connection is made to the Terminal server, via any supported protocol, on this TCP port number, the terminal will be assumed to be an 80-column CBM/PETSCII (non-ANSI) terminal (e.g. Commodore 128). Setting this port number does not cause the server to listen on this port, so if you desire to support CBM/PETSCII terminal-connections, you will also need to add this port number to the TelnetInterface list (for example).

FirstNode

Default: 1

The number of the first terminal server node serviced by this instance of Synchronet. The minimum value for this settings is 1 and the maximum is 255.

Normally, this value should be left at 1. If the sysop wanted to run multiple instances of Synchronet, all sharing the same directory tree and data files, then multiple sbbs.ini files would be used (with host-unique filenaming) and unique (non-overlapping) node ranges specified with the FirstNode and LastNode values in each.

LastNode

Default: 4

The number of the last terminal server node serviced by this instance of Synchronet. The minimum value for this settings is 1 and the maximum is 255. If this setting's value is higher than the total number of nodes configured for the BBS (i.e. in SCFG->Nodes), then it will be automatically adjusted at run time during Terminal Server startup with a logged notice:

Specified last_node (x) > sys_nodes (y), auto-corrected

MaxConcurrentConnections

Default: 0

If set to a non-zero number, this will limit the number of concurrent connections to the Terminal Server from a common host/client IP address. Exempt hosts are not connection-limited by this setting. This setting was added in Synchronet v3.17.

OutbufHighwaterMark

Default: 0 or 1024 (bytes)

OutbufDrainTimeout

Default: 10 (milliseconds)

SemFileCheckFrequency

Default: value of [Global] SemFileCheckFrequency

TempDirectory

Default: value of [Global] TempDirectory

HostName

Default: value of [Global] HostName

ExternalTermANSI

Default: pc3 (Linux) or cons25 (FreeBSD)

When the BBS is running on a *nix-like OS, this value determines the value of the TERM environment variable that will be set when invoking interactive external programs for users with terminals supporting ANSI.

ExternalTermDumb

Default: dumb

When the BBS is running on a *nix-like OS, this value determines the value of the TERM environment variable that will be set when invoking interactive external programs for users with terminals that do not support ANSI.

DOSemuPath

Default: /usr/bin/dosemu.bin (Linux) or /usr/local/bin/doscmd (FreeBSD)

When the BBS is running on a *nix-like OS and built with DOS emulator support (e.g. USE_DOSEMU defined on Linux), this value determines the default path of the DOS emulator to be executed when a non-native program (e.g. 16-bit MS-DOS door game) will be invoked by the BBS.

AnswerSound

Default: none

Path to a WAVE file to played (locally) when accepting incoming connections. Only supported on Windows.

HangupSound

Default: none

Path to a WAVE file to be played (locally) when terminating connections. Only supported on Windows.

Options

Default: XTRN_MINIMIZED

Recommended: XTRN_MINIMIZED | ALLOW_RLOGIN | ALLOW_SSH

Supported options, separated by the pipe (|) symbol:

Option Description
XTRN_MINIMIZED External program windows are automatically minimized (Windows)
AUTO_LOGON Enable automatic login based on IP address for V-exempt users (not recommended)
DEBUG_TELNET Log Telnet commands and responses (with Debug log-level messages)
ALLOW_SSH Enable the Secure Shell (SSH) protocol for incoming connections
ALLOW_RLOGIN Enable the RLogin protocol for incoming connections
NO_QWK_EVENTS Disable QWK networking events
NO_NEWDAY_EVENTS Disable daily events from running in this instance of Synchronet
NO_EVENTS Disable the Events thread (all timed events)
NO_TELNET_GA Disable periodic transmissions of the Telnet “Go Ahead” command (Telnet only)
NO_HOST_LOOKUP Do not attempt hostname look-ups on incoming connections (log IP addresses only)
NO_SPY_SOCKETS Disable node spying (on *nix)
NO_DOS Disable 16-bit DOS Program support (eliminate the potential for modal error dialogs in 64-bit editions of Windows)
NO_RECYCLE Disable the ability for the terminal server to be recycled
GET_IDENT Use the IDENT protocol on incoming connections
MUTE Disable all local sound output

[FTP]

See FTP Server for more details.

[Mail]

See Mail Server for more details.

[Web]

See Web Server for more details.

[Services]

See Services and services.ini for more details.

[UNIX]

See Configuring UNIX for more details.

See Also


In Other Languages
Translations of this page: