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

New Synchronet YouTube channel

You can donate to the Synchronet project using PayPal.

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
config:sbbs.ini [2019/01/05 15:44]
digital man [[BBS]] Added clarifications and missing settings from [BBS] section
config:sbbs.ini [2019/03/24 00:14] (current)
digital man Document the OutboundInterface key (was called OutgoingV4 till recent)
Line 1: Line 1:
-====== sbbs.ini ======+====== sbbs.ini ​file ======
  
-The Synchronet BBS (SBBS) Initialization File is the mother of all Synchronet configuration files and is located in the ''​[[dir:​ctrl]]''​ directory.+The Synchronet BBS (SBBS) Initialization File (''​sbbs.ini''​) ​is the mother of all Synchronet ​v3 configuration files and is located in the ''​[[dir:​ctrl]]''​ directory.
  
 ===== Filename ===== ===== Filename =====
Line 7: Line 7:
 The base filename of the initialization file is ''​[[dir:​ctrl]]/​sbbs.ini''​. ​ The base filename of the initialization file is ''​[[dir:​ctrl]]/​sbbs.ini''​. ​
  
-The standard host/​platform variations of the initialization filenames are also supported. See [[INI_files#​filenaming|INI Filenaming]] for details.+The standard host/​platform variations of the initialization filenames are also supported. See [[INI_files#​filenaming|.ini filenaming]] for details.
  
 ===== Defaults ===== ===== Defaults =====
Line 27: Line 27:
 The ''​[Global]''​ section contains keys whose values will serve as default values for like-named keys in other server sections in the ''​[[config:​sbbs.ini]]''​ file.  The ''​[Global]''​ section contains keys whose values will serve as default values for like-named keys in other server sections in the ''​[[config:​sbbs.ini]]''​ file. 
  
-These keys are:+The supported ''​[Global]'' ​keys are:
  
-=== Hostname ​===+=== HostName ​===
  
 Default: <​none>​ Default: <​none>​
  
-The public Internet ​hostname ​of this server.+The public Internet ​DNS host name of this server.
  
-If not set, the hostname ​configured in [[util:​SCFG]]->​Networks->​Internet E-mail Address will be used.+If not set, the host name configured in ''​[[util:​SCFG]]->​Networks->​Internet E-mail->​System ​Address'' ​will be used
 + 
 +**Note**: 
 +The ''​[Global] HostName''​ setting may be overridden by a ''​HostName''​ value in the subsequent server sections of this file.
  
 === Interface === === Interface ===
  
-Default: ​<any>+Default: ​''​0.0.0.0,::''​ (any/all IPv4 or IPv6 interface) 
 + 
 +The IPv4 and/or IPv6 addresses of the network interfaces to listen on for incoming TCP/IP connections. 
 + 
 +If multiple addresses are specified, they are to be separated by commas (this is true of all the ''​*Interface''​ values in this file). 
 + 
 +The address value ''​0''​ or ''​0.0.0.0''​ indicates //all IPv4 interfaces//​. The address value ''::''​ indicates //all IPv6 interfaces//​. 
 + 
 +If this value is not set, any and all IPv4 and IPv6 network interfaces available will be listened to for incoming connections. 
 + 
 +**Note**: 
 +Although TCP port numbers may be specified (with ''//<​address>//://​port//''​ syntax) in the ''​*Interface''​ values of the subsequent server sections of this file, the ''​[Global] Interface''​ value **must not** have any port numbers specified.
  
-The IPv4 and/or IPv6 address of the network interfaces to listen for incoming TCP/IP connections on.+=== OutboundInterface ===
  
-If multiple address are specified, they are to be separated by commas (this is true of all the ''​*Interface'' ​values in this file).+Default: ​''​0.0.0.0'' ​(any available IPv4 interface)
  
-If not set, any and all network ​interfaces available will be listened on.+The IPv4 address of the network ​interface to use for outgoing TCP/IP connections.
  
 === CtrlDirectory === === CtrlDirectory ===
Line 60: Line 74:
 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. 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.
  
 +**Note**:
 +The ''​[Global] TempDirectory''​ value may be overridden by a ''​TempDirectory''​ value in the subsequent server sections of this file.
  
 === SemFileCheckFrequency === === SemFileCheckFrequency ===
Line 67: Line 83:
  
 The interval, in seconds, betweeen [[semfiles|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). The interval, in seconds, betweeen [[semfiles|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).
 +
 +**Note**:
 +The ''​[Global] SemFileCheckFrequency''​ value may be overridden by a ''​SemFileCheckFrequency''​ value in the subsequent server sections of this file.
  
 === BindRetryCount === === BindRetryCount ===
Line 75: Line 94:
  
 Increase this value if you get errors binding to ports on reloads (especially on *nix). Increase this value if you get errors binding to ports on reloads (especially on *nix).
 +
 +**Note**:
 +This setting may be overridden by a ''​BindRetryCount''​ value in the subsequent server sections of this file.
  
 === BindRetryDelay === === BindRetryDelay ===
Line 81: Line 103:
   
 Delay (in seconds) between bind retries. Delay (in seconds) between bind retries.
 +
 +**Note**:
 +This setting may be overridden by a ''​BindRetryDelay''​ value in the subsequent server sections of this file.
  
 === LogLevel === === LogLevel ===
Line 89: Line 114:
 Supported log levels in decreasing severity (ala [[:​monitor:​syslog]]):​ Supported log levels in decreasing severity (ala [[:​monitor:​syslog]]):​
   Emergency, Alert, Critical, Error, Warning, Notice, Informational,​ Debugging   Emergency, Alert, Critical, Error, Warning, Notice, Informational,​ Debugging
 +  ​
 +**Note**:
 +This setting may be overridden by a ''​LogLevel''​ value in the subsequent server sections of this file.
  
 === JavaScriptMaxBytes === === JavaScriptMaxBytes ===
Line 95: Line 123:
  
 Maximum allocation of memory per JavaScript run-time. Maximum allocation of memory per JavaScript run-time.
 +
 +**Note**:
 +Each ''​[Global] JavaScript*''​ setting may be overridden by a corresponding ''​JavaScript*''​ value in the subsequent server sections of this file.
  
 === JavaScriptContextStack === === JavaScriptContextStack ===
Line 136: Line 167:
  
 The number of milliseconds to pause after a failed login attempt. The number of milliseconds to pause after a failed login attempt.
 +
 +**Note**:
 +Each ''​[Global] LoginAttempt*''​ setting may be overridden by a corresponding ''​LoginAttempt*''​ value in the subsequent server sections of this file.
  
 === LoginAttemptThrottle === === LoginAttemptThrottle ===
Line 156: Line 190:
 Set to ''​0''​ to disable automatic banning. Set to ''​0''​ to disable automatic banning.
  
-NOTE: Failed logins using any of the filtered user IDs (from ''​[[config:​name.can]]''​) will automatically trigger a temporary ban. +**Note**: Failed logins using any of the filtered user IDs (from ''​[[config:​name.can]]''​) will automatically trigger a temporary ban.
- +
-NOTE: Added in v3.17 (May-2016)+
  
 === LoginAttemptTempBanDuration === === LoginAttemptTempBanDuration ===
Line 164: Line 196:
  
 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 ''​[[config:​name.can]]''​). 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 ''​[[config:​name.can]]''​).
- 
-NOTE: Added in v3.17 (May-2016) 
  
 === LoginAttemptFilterThreshold === === LoginAttemptFilterThreshold ===
Line 172: Line 202:
 The number of consecutive unique failed login attempts from the same host before auto-filtering the host's IP address in the ''​[[config:​ip.can]]''​ file. The number of consecutive unique failed login attempts from the same host before auto-filtering the host's IP address in the ''​[[config:​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 [[util:​SCFG]]->​Nodes->​Node 1->​Toggle Options->​Always Prompt for Password to "​Yes"​.+For this auto-filtering feature to work with the Synchronet v3.16c Terminal Server (Telnet, RLogin, and SSH login attempts), the sysop must set ''​[[util:​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. Set to ''​0''​ to disable automatic filtering of IP addresses due to failed login attempts.
 +
 ==== [BBS] ==== ==== [BBS] ====
  
Line 240: Line 271:
  
 If a connection is made to the [[:​server:​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). If a connection is made to the [[:​server:​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).
 +
 +=== OutboundInterface ===
 +
 +Default: ''​0.0.0.0''​ (any available IPv4 interface)
 +
 +The IPv4 address of the network interface to use for outgoing TCP/IP connections (i.e. for Telnet and RLogin gateway connections).
  
 === FirstNode === === FirstNode ===

In Other Languages