Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
config:sbbs.ini [2010/02/22 22:38] digitalmanconfig:sbbs.ini [2019/03/24 00:14] – Document the OutboundInterface key (was called OutgoingV4 till recent) digital man
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 15: Line 15:
 ===== Editing ===== ===== 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.+When using the [[monitor:sbbsctrl|Synchronet-Win32 Control Panel]], the contents of this file are automatically updated when any of the configuration changes are made in the File->[[monitor:sbbsctrl: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. 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.
Line 24: Line 24:
  
 ==== [Global] ==== ==== [Global] ====
 +
 +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 supported ''[Global]'' keys are:
 +
 +=== HostName ===
 +
 +Default: <none>
 +
 +The public Internet DNS host name of this server.
 +
 +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 ===
 +
 +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.
 +
 +=== OutboundInterface ===
 +
 +Default: ''0.0.0.0'' (any available IPv4 interface)
 +
 +The IPv4 address of the network interface to use for outgoing TCP/IP connections.
 +
 +=== CtrlDirectory ===
 +
 +Default: ''$[[:config:env#SBBSCTRL]]''
 +
 +Specify the location of the Synchronet ''[[dir:ctrl]]'' directory. Since this file is normally found in the ''[[dir:ctrl]]'' directory (e.g. by way of the ''[[:config:env#SBBSCTRL]]'' environment variable) you do not normally need to set this.
 +
 +=== TempDirectory ===
 +
 +Default: ''[[dir: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.
 +
 +**Note**:
 +The ''[Global] TempDirectory'' value may be overridden by a ''TempDirectory'' value in the subsequent server sections of this file.
 +
 +=== SemFileCheckFrequency ===
 +
 +Default: ''2'' (seconds)
 +Minimum: ''1'' (seconds)
 +
 +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 ===
 +
 +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).
 +
 +**Note**:
 +This setting may be overridden by a ''BindRetryCount'' value in the subsequent server sections of this file.
 +
 +=== BindRetryDelay ===
 +
 +Default: ''15'' (seconds)
 +
 +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 ===
 +
 +Default: ''Debugging''
 +
 +Highest log level to actually log/print (ignore all higher/less-severe log entries).
 +Supported log levels in decreasing severity (ala [[:monitor:syslog]]):
 +  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 ===
 +
 +Default: ''8M''
 +
 +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 ===
 +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 ''[[dir:exec]]'' or ''[[dir: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.
 +
 +**Note**:
 +Each ''[Global] LoginAttempt*'' setting may be overridden by a corresponding ''LoginAttempt*'' value in the subsequent server sections of this file.
 +
 +=== 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 ''[[config:name.can]]'') will automatically trigger a temporary ban.
 +
 +=== 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 ''[[config:name.can]]'').
 +
 +=== 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 ''[[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".
 +
 +Set to ''0'' to disable automatic filtering of IP addresses due to failed login attempts.
  
 ==== [BBS] ==== ==== [BBS] ====
  
-==== [FTP====+See [[:server:terminal|Terminal Server]for more details.
  
-==== [Mail====+In addition to the keys listed in the ''[Global]'' section, the ''[BBS]'' section can contain the following keys with the specified default values:
  
-==== [Web] ====+=== AutoStart ===
  
-==== [Services] ====+Default: ''true''
  
-==== [UNIX====+Automatically startup the [[server:Terminal]Server when Synchronet starts up.
  
-Unix Sysops will particularly want to pay attention to the ''[UNIX]'' section of your ''sbbs.ini'' file.+=== TelnetInterface ===
  
-If you do not want to run Synchronet (and all external programs/doors) as +Default: value of ''[Global] Interface''
-root, you will have to set the ''User'' and ''Group'' key values. Example:+
  
-  User=sbbsgroup +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)).
-  Group=sbbsuser+
  
-Also, the file +=== TelnetPort ===
-permissions/ownership should be such that the other user would have read +
-and write access to them.  The best way to accomplish this is a command +
-like:+
  
-  # chown -R sbbsuser:sbbsgroup /sbbs+Default''23''
  
-If you want Synchronet to fork and run in the background as a daemon, logging +The TCP port number on which to listen for incoming Telnet connections.
-via syslog rather than the local console, set Daemonize=True in this sectionExample:+
  
-  Daemonize=True+=== RLoginInterface ===
  
-To configure syslog and the ''LogFacility'', a good default to use is:+Default: value of ''[Global] Interface''
  
-  LogFacility=3 +The IPv4 and/or IPv6 addresses of the network interfaces to listen on for incoming RLogin connections on (''0'' for //any// interface).
-  +
-  +
-Then, in ''/etc/syslog.conf'' you will need to add the line:+
  
-  local3.*                 /var/log/synchronet.log+=== RLoginPort ===
  
-Depending on how your vendor set up ''syslog.conf'' initially, you may also want +Default: ''513''
-to exclude local3.* from other log files (Noteably ''/var/log/messages''). how to +
-do this varies with your syslogd implementation, but for BSD based ones +
-(Which BSD and many Linux distros use) you would add ";local3.none" to the +
-end of the first field in the ''/var/log/messages'' line.+
  
-You will have to create this file manually initially by running: +The TCP port number on which to listen for incoming RLogin connections.
-  # touch /var/log/synchronet.log+
  
-Then send a HUP to syslogd like so: +=== SSHInterface ===
-  # killall -HUP syslogd+
  
-You will want to investigate how your system rotates logs and set it up to +Default: value of ''[Global] Interface''
-rotate ''synchronet.log'' also.+
  
-Further use of the ''LogFacility'' setting is beyond the scope of this document. +The IPv4 and/or IPv6 address of the network interfaces to listen for incoming Secure Shell (SSH) connections on (''0'' for //any// interface).
-Read your ''syslog.conf'' manpage for more information about this.  In particular, +
-do NOT use the 'S' setting unless you are familiar with advanced syslogd +
-configuration.  The S setting will use different facilities for each feature +
-of Synchronet as appropriate Specifically, S will use:+
  
-    LOG_AUTH +=== SSHPort ===
-    LOG_DAEMON +
-    LOG_FTP (If available) +
-    LOG_MAIL +
-    LOG_CRON +
-    +
-=== LogIdent === +
-Default: Synchronet +
-=== PidFile === +
-Default: ''/var/run/sbbs.pid'' +
-=== umask === +
-Default: 077 +
- +
  
 +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 [[:server: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 [[: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 ===
 +
 +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 [[:dir:|directory tree]] and data files, then multiple ''sbbs.ini'' files would be used (with host-unique [[ini_files#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 [[server:Terminal]] Server from a common host/client IP address. [[config:ipfilter_exempt.cfg|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 [[:server:ftp|FTP Server]] for more details.
 +
 +==== [Mail] ====
 +
 +See [[:server:mail|Mail Server]] for more details.
 +
 +==== [Web] ====
 +
 +See [[:server:web|Web Server]] for more details.
 +
 +==== [Services] ====
 +
 +See [[:service:index|Services]] and [[:config:services.ini]] for more details.
 +
 +==== [UNIX] ====
 +
 +See [[:config:nix|Configuring UNIX]] for more details.
 +  
 ===== See Also ===== ===== See Also =====
   * [[:config:|Configuration]]   * [[:config:|Configuration]]
Line 106: Line 399:
    
  
- +{{tag>sbbs.ini}}
- +
  
  
config/sbbs.ini.txt · Last modified: 2024/03/03 01:34 by digital man
Back to top
CC Attribution 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0