This is an old revision of the document!
Table of Contents
Synchronet Console
The Synchronet Console is a simple program used to control (e.g. start/stop) and monitor Synchronet status and log output from a text mode console (primarily, Unix consoles).
On Windows, the Synchronet Console is intended to be used as an alternative to the Synchronet Control Panel, not in addition to.
The console may not currently be used in conjunction with Synchronet as Windows Services.
Executable
The Synchronet Console is a native executable program.
On Windows, the executable file is: exec/sbbs.exe
On Unix, the executable file is: exec/sbbs
On Unix, this same executable file is used to start Synchronet as a daemon.
Command-line Usage
Help on the command-line usage can be displayed by executing the command: sbbs -?
or sbbs –help
:
Synchronet Console for Win32 Version 3.15a Copyright 2010 Rob Swindell Reading c:\sbbs\ctrl\sbbs.ini usage: sbbs [[setting] [...]] [path/ini_file] Global settings: hn[host] set hostname for this instance if host not specified, uses gethostname gi get user identity (using IDENT protocol) nh disable hostname lookups nj disable JavaScript support ne disable event thread ni do not read settings from .ini file defaults show default settings and options Terminal server settings: tf<node> set first node number tl<node> set last node number tp<port> set Telnet server port rp<port> set RLogin server port (and enable RLogin server) r2 use second RLogin name in BSD RLogin to<value> set Terminal server options value (advanced) ta enable auto-logon via IP address td enable Telnet command debug output tc emabble sysop availability for chat tq disable QWK events t- disable Terminal server FTP server settings: fp<port> set FTP server port fo<value> set FTP server options value (advanced) f- disable FTP server Mail server settings: ms<port> set SMTP server port mp<port> set POP3 server port mr<addr> set SMTP relay server (and enable SMTP relay) md<addr> set DNS server address for MX-record lookups mo<value> set Mail server options value (advanced) ma allow SMTP relays from authenticated users m- disable Mail server (entirely) mp- disable POP3 server ms- disable SendMail thread Services settings: so<value> set Services option value (advanced) s- disable Services (no services module) Web server settings: wp<port> set HTTP server port wo<value> set Web server option value (advanced) w- disable Web server (no services module)
Log Output
The log output from the enabled servers is intermixed into the console output.
The amount of detail is control via the LogLevel
key values in the sbbs.ini
file.
Example:
Synchronet Console for Win32 Version 3.15a Copyright 2010 Rob Swindell Reading c:\sbbs\ctrl\sbbs.ini Loading configuration files from c:\sbbs\ctrl\ 3/16 14:32:55 term Synchronet Terminal Server Version 3.15 Revision A Debug 3/16 14:32:55 web Synchronet Web Server Revision 1.524 Debug 3/16 14:32:55 srvc Synchronet Services Revision 1.243 Debug 3/16 14:32:55 mail Synchronet Mail Server Revision 1.513 Debug 3/16 14:32:55 ftp Synchronet FTP Server Revision 1.365 Debug 3/16 14:32:55 term Compiled Mar 16 2010 13:05:02 with MSC 1200 3/16 14:32:55 web Compiled Mar 16 2010 13:06:09 with MSC 1200 3/16 14:32:55 srvc Compiled Mar 16 2010 13:06:05 with MSC 1200 3/16 14:32:55 mail Compiled Mar 16 2010 13:05:58 with MSC 1200 3/16 14:32:55 ftp Compiled Mar 16 2010 13:05:52 with MSC 1200 3/16 14:32:55 term SMBLIB 2.51 (format 1.21) 3/16 14:32:55 web WinSock 2.0 Running 3/16 14:32:55 srvc WinSock 2.0 Running 3/16 14:32:55 mail SMBLIB 2.51 (format 1.21) 3/16 14:32:55 ftp WinSock 2.0 Running 3/16 14:32:55 term WinSock 2.0 Running 3/16 14:32:55 web Initializing on Tue Mar 16 14:32:55 2010 with options: 800 3/16 14:32:55 srvc Initializing on Tue Mar 16 14:32:55 2010 with options: 800 3/16 14:32:55 mail WinSock 2.0 Running 3/16 14:32:55 ftp Initializing on Tue Mar 16 14:32:55 2010 with options: 114 3/16 14:32:55 term Initializing on Tue Mar 16 14:32:55 2010 with options: 1158 3/16 14:32:55 web Loading configuration files from c:\sbbs\ctrl\ 3/16 14:32:55 srvc Loading configuration files from c:\sbbs\ctrl\ 3/16 14:32:55 mail Initializing on Tue Mar 16 14:32:55 2010 with options: 4 3/16 14:32:55 ftp Loading configuration files from c:\sbbs\ctrl\ 3/16 14:32:55 term Loading configuration files from c:\sbbs\ctrl\ 3/16 14:32:55 web Temporary file directory: c:\sbbs\temp\ 3/16 14:32:55 srvc Temporary file directory: c:\sbbs\temp\ 3/16 14:32:55 mail Loading configuration files from c:\sbbs\ctrl\ 3/16 14:32:55 ftp Temporary file directory: c:\sbbs\temp\ 3/16 14:32:55 term Verifying/creating data directories 3/16 14:32:55 web Root directory: c:\sbbs\web\root 3/16 14:32:55 mail Temporary file directory: c:\sbbs\temp\ 3/16 14:32:55 srvc Reading c:\sbbs\ctrl\services.ini 3/16 14:32:55 web Error directory: c:\sbbs\web\root\error\ 3/16 14:32:55 mail Reading c:\sbbs\ctrl\mailproc.ini 3/16 14:32:55 ftp Maximum clients: 10 3/16 14:32:55 web CGI directory: c:\sbbs\web\root\cgi-bin\ 3/16 14:32:55 mail Maximum clients: 10 3/16 14:32:55 ftp Passive Port Low: 1024 3/16 14:32:55 mail Maximum inactivity: 120 seconds 3/16 14:32:55 web Read 79 MIME types from c:\sbbs\ctrl\mime_types.ini 3/16 14:32:55 ftp Passive Port High: 65535 3/16 14:32:55 srvc 1656 NNTP socket bound to TCP port 119 3/16 14:32:55 ftp Maximum inactivity: 300 seconds 3/16 14:32:55 web Read 2 CGI content handlers from c:\sbbs\ctrl\web_handler.ini 3/16 14:32:55 mail 1640 SMTP socket opened 3/16 14:32:55 web Read 1 JavaScript content handlers from c:\sbbs\ctrl\web_handler.ini 3/16 14:32:55 srvc 1668 Finger socket bound to TCP port 79 3/16 14:32:55 mail 1640 SMTP Server listening on port 25 3/16 14:32:55 ftp 1620 FTP Server socket opened 3/16 14:32:55 ftp 1620 FTP Server listening on port 21 3/16 14:32:55 web 1596 Web Server socket opened 3/16 14:32:55 srvc 1604 UDP-Finger socket bound to UDP port 79 3/16 14:32:55 mail 1600 POP3 socket opened 3/16 14:32:55 ftp 1620 FTP Server thread started 3/16 14:32:55 mail 1600 POP3 Server listening on port 110 3/16 14:32:55 srvc 1584 Gopher socket bound to TCP port 70 3/16 14:32:55 web 1596 Web Server listening on port 8080 3/16 14:32:55 mail 0000 SendMail thread started 3/16 14:32:55 mail 1640 Mail Server thread started 3/16 14:32:55 srvc 1548 IRC socket bound to TCP port 6667 3/16 14:32:55 web 1596 Web Server thread started 3/16 14:32:55 srvc 1548 IRC static JavaScript service thread started 3/16 14:32:55 srvc 0000 Services thread started (5 service sockets bound) 3/16 14:32:55 term Verifying/creating node directories 3/16 14:32:55 srvc 1548 IRC SynchronetIRCd-1.3a(1.151) started. 3/16 14:32:55 term Telnet socket 1512 opened 3/16 14:32:55 term Telnet Server listening on port 23 3/16 14:32:55 srvc 1548 IRC Reading Config: c:\sbbs\ctrl\ircd.conf 3/16 14:32:56 term SSH socket 1480 opened 3/16 14:32:56 term SSH Server listening on port 22 3/16 14:32:56 term Terminal Server constructor using socket 1512 (settings=8212) 3/16 14:32:56 term Terminal Server temporary file directory: c:\sbbs\temp\ 3/16 14:32:56 term BBS Events constructor using socket -1 (settings=8212) 3/16 14:32:56 term Terminal Server output thread started 3/16 14:32:56 term BBS Events temporary file directory: c:\sbbs\temp\event\ 3/16 14:32:56 evnt BBS Events thread started 3/16 14:32:56 term BBS Events JavaScript: Creating runtime: 8388608 bytes 3/16 14:32:56 term BBS Events JavaScript: Initializing context (stack: 16384 bytes) 3/16 14:32:56 term BBS Events JavaScript: Thread stack limit: 262144 bytes 3/16 14:32:56 term Terminal Server thread started for nodes 1 through 4 3/16 14:32:56 term Backing-up user data... 3/16 14:32:56 term Backing-up mail data... 3/16 14:32:56 term Checking for inactive/expired user records... 3/16 14:32:56 term Purging deleted/expired e-mail [Threads: 10 Sockets: 13 Clients: 0 Served: 0 Errors: 0] (?=Help):
Command Prompt
The command prompt can be used for basic control and monitoring commands. Hitting ?
will display prompt help:
Synchronet Console Version 3.15a Help q = quit n = node list w = who's online l = lock node (toggle) d = down node (toggle) i = interrupt node (toggle) r = recycle servers (when not in use) s = shutdown servers (when not in use) t = terminate servers (immediately) ! = execute external command ? = print this help information
Source Code
The Synchronet Console is primarily coded in sbbscon.c
.