| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| config:cnf_files [2010/02/23 18:36] – digitalman | config:cnf_files [2023/07/30 13:35] (current) – [Development Notes] typo fixed and more detail added digital man |
|---|
| ====== CNF Files ====== | ====== .cnf files ====== |
| |
| These are binary files most of which are in the [[dir:ctrl|CTRL Directory]] and are maintained by [[scfg]]. These feature an auto-backup system configured via [[scfg:System:Advanced Options]]. | ''.cnf'' files are proprietary binary configuration files located in the ''[[dir:ctrl]]'' directory and ''[[dir:node]]'' directories and are maintained using the [[util:SCFG]] utility before Synchronet v3.20. |
| |
| ====== Individual files ====== | ===== Auto-backup ===== |
| |
| The various CNF files are: | [[util:SCFG:]] features an auto-backup system controlled with the [[util:SCFG]] ''-b#'' command-line option to specify the backup level. ''-b5'' is the default, providing for 5 backups of each file modified. ''-b0'' disables the auto-backup feature. |
| * ''chat.cnf'': This contains the [[scfg:Chat Features]] settings from [[config:scfg|SCFG]] specifically the Guru, Multinode chat actions and channels, and external sysop pages. This is unused on most BBSs and may be removed from or integrated with the [[service:ircd]] in [[version 4]]. | |
| * ''file.cnf'': Contains the file [[library]] and [[directory]] configuration from [[scfg:File Areas]] and the file transfer configuration from [[scfg:File Options]] | |
| * ''main.cnf'': [[scfg:System]] settings and [[scfg:Command Shells]] are configrued via this file. | |
| * ''msgs.cnf'': Contains the message [[groups]] and [[sub-boards]] configured via [[scfg:Message Areas]], [[scfg:Message Options]], and [[scfg:Networks]] | |
| * ''xtrn.cnf'': Contains the [[scfg:External Programs]] configuration which includes [[events]], [[external editors]], [[hot-key events]] and [[doors]] | |
| * ''node.cnf'': Located in the [[dir:node|NODE Directories]], and configured via the [[scfg:Nodes]] menu, it is expected that only the node config which corresponds to the [[config:sbbs.ini#first node|FirstNode]] value (usually 1) in sbbs.ini is actually used, but there may be times with some tools that a different node config file is used. Because of this, it is recommended that a sysop ensure that all node.cnf files for the same instance are configured identically. | |
| |
| | ''.cnf'' files ending with ''.0.cnf'' represent the most recent backup of the ''.cnf'' file, ''.1.cnf'' the next to most recent backup, etc. |
| |
| ====== Development Notes ====== | The oldest backup files (e.g. ''*.5.cnf'' when the backup level is 5) are automatically removed (deleted). |
| |
| These files were originally a text-based configuration but were converted to binary for efficiency reasons which no longer apply. For [[version 4]], these files will be converted to a text format, most likely fixed width TSV or CSV. | ====== Individual files ====== |
| |
| The multiple node.cnf files need to be replaced by a single file which configures all the nodes for a specific instance of Synchronet. Currently, this means supporting the ''<base>.<host|os>.<ext>'' format because the assumption that the only reason to run multiple instances is that there are multiple systems is currently baked in. | The various .cnf files are: |
| | * ''chat.cnf'': This contains the [[util:scfg:Chat Features]] settings from [[util:SCFG]] specifically the Guru, Multinode chat actions and channels, and external sysop pages. This is unused on most BBSs and may be removed from or integrated with the [[service:ircd]] in [[version 4]]. |
| | * ''file.cnf'': Contains the file [[library]] and [[directory]] configuration from [[util:scfg:File Areas]] and the file transfer configuration from [[util:scfg:File Options]] |
| | * ''main.cnf'': [[util:scfg:System]] settings and [[util:scfg:Command Shells]] are configrued via this file. |
| | * ''msgs.cnf'': Contains the message [[groups]] and [[sub-boards]] configured via [[util:scfg:Message Areas]], [[util:scfg:Message Options]], and [[util:scfg:Networks]] |
| | * ''xtrn.cnf'': Contains the [[util:scfg:External Programs]] configuration which includes [[events]], [[external editors]], [[hot-key events]] and [[doors]] |
| | * ''node.cnf'': Located in the [[dir:node|NODE Directories]], and configured via the [[util:scfg:Nodes]] menu, it is expected that only the node config which corresponds to the [[config:sbbs.ini#first node|FirstNode]] value (usually 1) in ''[[sbbs.ini]]'' is actually used, but there may be times with some tools that a different node config file is used. Because of this, it is recommended that a sysop ensure that all ''node.cnf'' files for the same instance are configured identically. |
| |
| | ====== Development Notes ====== |
| | |
| | These files were originally a text-based configuration (''*.cfg'' files in Synchronet version 1) but were converted to binary for efficiency reasons that no longer apply. In version 3.20 of Synchronet, these files were converted to [[.ini files]]; see [[history:newcfgfiles]] for details. |
| ===== See Also ===== | ===== See Also ===== |
| | * [[:util:SCFG:]] |
| * [[:config:|Configuration]] | * [[:config:|Configuration]] |
| |
| | |
| | {{tag>configuration file_type cnf}} |
