Synchronet v3.19b-Win32 (install) has been released (Jan-2022).

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 revisionPrevious revision
Next revision
Previous revision
config:ini_files [2020/08/23 15:15] – Change links from viewcvs/cvsweb to gitlab. digital manconfig:ini_files [2023/10/26 17:21] (current) – Add text.ini digital man
Line 5: Line 5:
 ===== Configuration ===== ===== Configuration =====
  
-Synchronet supports a variety of configuration files of different formats. A growing majority of these configuration files are of the [[wp>INI file]] type. Synchronet's INI configuration files are typically stored in the ''[[dir:ctrl]]'' directory, with a ''.ini'' filename suffix/extension.+Synchronet's INI configuration files are typically stored in the ''[[dir:ctrl]]'' directory, with a ''.ini'' filename suffix/extension. 
 + 
 +==== Primary Configuration Files ==== 
 + 
 +The primary configuration files managed by the [[util:SCFG]] utility are: 
 +^ Filename    ^ Description ^ 
 +|''[[sbbs.ini]]'' |[[https://gitlab.synchro.net/sbbs/sbbs/-/raw/master/ctrl/sbbs.ini|Synchronet Server Initialization File]] | 
 +| ''main.ini'' | Primary system settings (e.g. BBS name, location, security settings) and command shells | 
 +| ''msgs.ini'' | Message areas, message options, and message networking | 
 +| ''file.ini'' | File areas (for uploads, download), text file areas, and file-related options | 
 +| ''xtrn.ini'' | External program configurations which includes timed events, message editors, hot-key events and doors | 
 +| ''chat.ini'' | Chat Features settings, specifically the Guru, Multi-node chat actions and channels, and external sysop pagers | 
 +| ''node.ini'' | Located in the [[dir:node|node directories]], and configured via the SCFG [[util:scfg:Nodes]] menu | 
 + 
 +==== Secondary Configuration Files ====
  
 ^Filename Page             ^Default Contents^Description^ ^Filename Page             ^Default Contents^Description^
 +|''[[custom:text.ini]]''    |N/A | Customized ''text.dat'' strings (optional) |
 +|''text.//lang//.ini''      |varies | Alternate language ''text.ini'' files |
 |''[[cgi_env.ini]]''        |[[https://gitlab.synchro.net/sbbs/sbbs/-/raw/master/ctrl/cgi_env.ini|cgi_env.ini]]|[[server:Web]] Server CGI Settings| |''[[cgi_env.ini]]''        |[[https://gitlab.synchro.net/sbbs/sbbs/-/raw/master/ctrl/cgi_env.ini|cgi_env.ini]]|[[server:Web]] Server CGI Settings|
 |''[[formmail.ini]]''       |[[https://gitlab.synchro.net/sbbs/sbbs/-/raw/master/ctrl/formmail.ini|formmail.ini]]|Configuration for ''[[dir:web]]/formmail.ssjs'', Synchronet's Server-side [[custom:JavaScript]] version of [[http://www.scriptarchive.com/formmail.html|FormMail]]| |''[[formmail.ini]]''       |[[https://gitlab.synchro.net/sbbs/sbbs/-/raw/master/ctrl/formmail.ini|formmail.ini]]|Configuration for ''[[dir:web]]/formmail.ssjs'', Synchronet's Server-side [[custom:JavaScript]] version of [[http://www.scriptarchive.com/formmail.html|FormMail]]|
Line 16: Line 32:
 |''[[modopts.ini]]''        |[[https://gitlab.synchro.net/sbbs/sbbs/-/raw/master/ctrl/modopts.ini|modopts.ini]]|Configuration settings (options) for various [[custom:JavaScript]] modules, stock and/or 3rd party| |''[[modopts.ini]]''        |[[https://gitlab.synchro.net/sbbs/sbbs/-/raw/master/ctrl/modopts.ini|modopts.ini]]|Configuration settings (options) for various [[custom:JavaScript]] modules, stock and/or 3rd party|
 |''[[rss.ini]]''            |[[https://gitlab.synchro.net/sbbs/sbbs/-/raw/master/ctrl/rss.ini|rss.ini]]|Configuration for Synchronet RSS Feed module (''[[dir:web]]/root/rss.ssjs'')| |''[[rss.ini]]''            |[[https://gitlab.synchro.net/sbbs/sbbs/-/raw/master/ctrl/rss.ini|rss.ini]]|Configuration for Synchronet RSS Feed module (''[[dir:web]]/root/rss.ssjs'')|
-|''[[sbbs.ini]]''           |[[https://gitlab.synchro.net/sbbs/sbbs/-/raw/master/ctrl/sbbs.ini|sbbs.ini]]|Synchronet Initialization File| 
 |''[[sbbsctrl.ini]]''       |N/A|Configuration for Synchronet Control Panel ([[monitor:SBBSCTRL]]) for Windows, exported from Windows Registry| |''[[sbbsctrl.ini]]''       |N/A|Configuration for Synchronet Control Panel ([[monitor:SBBSCTRL]]) for Windows, exported from Windows Registry|
 |''[[sbbsexec.ini]]''           |[[https://gitlab.synchro.net/sbbs/sbbs/-/raw/master/exec/sbbsexec.ini|sbbsexec.ini]]|Configuration for the Synchronet Virtual FOSSIL / UART Driver for Windows| |''[[sbbsexec.ini]]''           |[[https://gitlab.synchro.net/sbbs/sbbs/-/raw/master/exec/sbbsexec.ini|sbbsexec.ini]]|Configuration for the Synchronet Virtual FOSSIL / UART Driver for Windows|
Line 133: Line 148:
 <code ini> <code ini>
 !include another.ini !include another.ini
 +</code>
 +
 +In Synchronet v3.18c, the ability to include multiple files was added, e.g.
 +
 +<code ini>
 +!include sub-dir/*.ini
 </code> </code>
  
Line 172: Line 193:
 ==== Enumerated Values ==== ==== Enumerated Values ====
  
-Some keys support values specified either by number (typically from ''0'' through n) or by a symbolic name for each supported value. These are referred to enumerated values.+Some keys support values specified either by number (typically from ''0'' through n) or by a symbolic name for each supported value. These are referred to as enumerated values.
  
 A numeric value higher than the highest supported enumerated value will be treated the same as the highest supported enumerated value. A numeric value higher than the highest supported enumerated value will be treated the same as the highest supported enumerated value.
 +
 +When a word is provided for the enumerated key value, an exact case-insensitive match is performed search following by a partial-match search, so "Debug" would match the enum value for "Debugging", and "Info" would match the enum value for "Informational".
  
 === Log Levels === === Log Levels ===
Line 226: Line 249:
   * [[config:cfg_files|CFG Files]]   * [[config:cfg_files|CFG Files]]
   * [[config:cnf_files|CNF Files]]   * [[config:cnf_files|CNF Files]]
-  
    
  
 +{{tag>configuration file_type ini}}