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]

[BBS]

[FTP]

[Mail]

[Web]

[Services]

[UNIX]

Unix Sysops will particularly want to pay attention to the [UNIX] section of your sbbs.ini file.

If you do not want to run Synchronet (and all external programs/doors) as root, you will have to set the User and Group key values. Example:

User=sbbsgroup
Group=sbbsuser

Also, the file 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

If you want Synchronet to fork and run in the background as a daemon, logging via syslog rather than the local console, set Daemonize=True in this section. Example:

Daemonize=True

To configure syslog and the LogFacility, a good default to use is:

LogFacility=3

Then, in /etc/syslog.conf you will need to add the line:

local3.*                 /var/log/synchronet.log

Depending on how your vendor set up syslog.conf initially, you may also want 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:

# touch /var/log/synchronet.log

Then send a HUP to syslogd like so:

# killall -HUP syslogd

You will want to investigate how your system rotates logs and set it up to rotate synchronet.log also.

Further use of the LogFacility setting is beyond the scope of this document. 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
  LOG_DAEMON
  LOG_FTP (If available)
  LOG_MAIL
  LOG_CRON
 

LogIdent

Default: Synchronet

PidFile

Default: /var/run/sbbs.pid

umask

Default: 077

See Also

config/sbbs.ini.1266907122.txt · Last modified: 2010/02/22 22:38 by digitalman
Back to top
CC Attribution 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0