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
Last revisionBoth sides next revision
config:sbbsecho.ini [2019/01/14 23:39] digital manconfig:sbbsecho.ini [2022/03/02 22:55] – Document robots digital man
Line 1: Line 1:
-====== sbbsecho.ini file ======+====== SBBSecho (FidoNet EchoMail Program) Configuration ======
  
 ''[[dir:ctrl]]/sbbsecho.ini'' is the default configuration filename used by [[util:SBBSecho]] version 3, [[module:BinkIT]] version 2, and [[module:TickIT]] version 1. While other configuration filenames may be passed-to and used-by SBBSecho, the format must be the same [[ini_files|.ini format]] and only one configuration file may be used per invocation of SBBSecho. ''[[dir:ctrl]]/sbbsecho.ini'' is the default configuration filename used by [[util:SBBSecho]] version 3, [[module:BinkIT]] version 2, and [[module:TickIT]] version 1. While other configuration filenames may be passed-to and used-by SBBSecho, the format must be the same [[ini_files|.ini format]] and only one configuration file may be used per invocation of SBBSecho.
  
-The current default ''sbbsecho.ini'' file can be downloaded from CVS [[http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/ctrl/sbbsecho.ini|here]].+The current default ''sbbsecho.ini'' file can be downloaded from [[howto:Git]] [[https://gitlab.synchro.net/main/sbbs/-/raw/master/ctrl/sbbsecho.ini?inline=false|here]]. 
  
 ===== Editing ===== ===== Editing =====
Line 33: Line 34:
 | ''LogLevel''            | ''Informational''         | Minimum severity of log messages written to the log file | | ''LogLevel''            | ''Informational''         | Minimum severity of log messages written to the log file |
 | ''StripLineFeeds''        | ''false''               | Strip line-feed (ASCII 10) characters from exported messages | | ''StripLineFeeds''        | ''false''               | Strip line-feed (ASCII 10) characters from exported messages |
 +| ''StripSoftCRs''          | ''true''                | Strip soft carriage-return (0x8D) characters from imported messages |
 | ''BinkleyStyleOutbound''  | ''true''                | Mailer is BSO/FLO style (rather than ArcMail/Attach style) |   | ''BinkleyStyleOutbound''  | ''true''                | Mailer is BSO/FLO style (rather than ArcMail/Attach style) |  
 | ''BsyTimeout''            | ''12 hours''            | Time-out duration when attempting to lock ''.bsy'' files | | ''BsyTimeout''            | ''12 hours''            | Time-out duration when attempting to lock ''.bsy'' files |
Line 41: Line 43:
 | ''AreaFileBackups''       | ''100''                 | Number of Area File backups to maintain (for Area Manager modifications) | | ''AreaFileBackups''       | ''100''                 | Number of Area File backups to maintain (for Area Manager modifications) |
 | ''CfgFileBackups''        | ''100''                 | Number of configuration file backups to maintain (for Area Manager or EchoCfg modifications)| | ''CfgFileBackups''        | ''100''                 | Number of configuration file backups to maintain (for Area Manager or EchoCfg modifications)|
 +| ''MaxLogSize''            | ''10M''                 | Maximum size (in bytes) of each SBBSecho log file (0 = no limit) |
 +| ''MaxLogsKept''           | ''10''                  | Maximum number of SBBSecho log files to keep |               
 +| ''MinFreeDiskSpace''      | ''10M''                 | Minimum amount of available disk space required for SBBSecho to operate |
 +| ''UseOutboxes''           | ''true''                | If a linked-node has an outbox value specified, place outbound files for that node in it |
 +| ''AutoUTF8''              | ''true''                | Automatically detect UTF-8-encoded incoming messages and mark them accordingly |
  
 === EchoMail-related settings === === EchoMail-related settings ===
Line 55: Line 62:
 | ''ZoneBlindThreshold''           | ''65535''      | Zone numbers less than this will be considered //blind// (all part of the same node number "namespace") | | ''ZoneBlindThreshold''           | ''65535''      | Zone numbers less than this will be considered //blind// (all part of the same node number "namespace") |
 | ''AreaAddFromEcholistsOnly''     | ''false''      | Allow echoes to be AreaFix-added from Additional EchoLists only (not Area File) | | ''AreaAddFromEcholistsOnly''     | ''false''      | Allow echoes to be AreaFix-added from Additional EchoLists only (not Area File) |
-| ''AutoAddSubs''                  | ''true''       | Automatically add new Sub-boards within linked Message Groups to the Area File |+| ''AutoAddSubs''                  | ''true''       | Automatically add new Sub-boards within linked Message Groups to the run-time Area List | 
 +| ''AutoAddToAreaFile''            | ''true''       | Automatically add new Sub-boards within linked Message Groups to the on-disk Area File |
 | ''MaxEchomailAge''               | ''60 days''    | Age limit (in days) of EchoMail messages that may be imported (0 = no limit) | | ''MaxEchomailAge''               | ''60 days''    | Age limit (in days) of EchoMail messages that may be imported (0 = no limit) |
 | ''RelayFilteredMsgs''            | ''false''      | Messages that are filtered (e.g. due to age) will be relayed to downlinks | | ''RelayFilteredMsgs''            | ''false''      | Messages that are filtered (e.g. due to age) will be relayed to downlinks |
 | ''AreaManager''                  | ''SYSOP''      | BBS user name or alias to notify (via email) of AreaFix activities and errors | | ''AreaManager''                  | ''SYSOP''      | BBS user name or alias to notify (via email) of AreaFix activities and errors |
 | ''EchoStats''                    | ''../data/echostats.ini'' | Path/filename of EchoMail Statistics ("EchoStats") database | | ''EchoStats''                    | ''../data/echostats.ini'' | Path/filename of EchoMail Statistics ("EchoStats") database |
 +| ''RequireLinkedNodeCfg''         | ''true''       | Require that area-linked nodes (in the area file) are configured as linked-nodes |
  
 === NetMail-related settings === === NetMail-related settings ===
Line 81: Line 90:
 The ''[BinkP]'' section is used for BinkP-specific global settings (i.e. used exclusively by [[module:BinkIT]] version 2): The ''[BinkP]'' section is used for BinkP-specific global settings (i.e. used exclusively by [[module:BinkIT]] version 2):
  
-^ Key                              ^ Default Value ^ Description ^ +^ Key           ^ Default Value ^ Description ^ 
-| Capabilities                     | <blank>       | If set, changes the text in the ''M_NUL NDL'' line from the default of “115200,TCP,BINKP” | +| Capabilities  | <blank>       | If set, changes the text in the ''M_NUL NDL'' line from the default of “115200,TCP,BINKP” | 
-| Sysop                            | <blank>       | If set, over-rides the sysop name (''ZYZ'') value (e.g. to send the sysop's real name instead of alias) | +| Sysop         | <blank>       | If set, over-rides the sysop name (''ZYZ'') value (e.g. to send the sysop's real name instead of alias) | 
 +| PlainAuthOnly | ''false''     | If set to ''true'', disables CRAM-MD5 authentication and encryption support for all inbound and outbound sessions (e.g. for trouble-shooting purposes) | 
 +| PlainTextOnly | ''false''     | If set to ''true'', disables encryption support for all inbound and outbound sessions (when set to ''false'', requires that //PlainAuthOnly// is also set to ''false'') |
 ==== Archive Sections ==== ==== Archive Sections ====
  
Line 118: Line 128:
 | ''Name''                     | Name of this linked-node's operator (e.g. real name or alias), auto-set when receiving Area Manager requests | | ''Name''                     | Name of this linked-node's operator (e.g. real name or alias), auto-set when receiving Area Manager requests |
 | ''Comment''    |               | Personal comment about this node (any text useful to you) | | ''Comment''    |               | Personal comment about this node (any text useful to you) |
-| ''Inbox''      |               | Optional filebox for incoming files (correlates with BinkD's ''ibox'' setting) | +| ''Inbox''      |               | Optional filebox for incoming files (correlates with BinkD's ''ibox'' setting, [[module:BinkIT]] does **not support** inboxes) | 
-| ''Outbox''                   | Optional filebox for outgoing files (correlates with BinkD's ''obox'' setting) |+| ''Outbox''                   | Optional filebox for outgoing files (correlates with BinkD's ''obox'' setting, [[module:BinkIT]] has //experimental support// for outboxes) |
 | ''Keys''                     | List of keys (comma-separated) which enable AreaFix access to one or more Additional EchoLists | | ''Keys''                     | List of keys (comma-separated) which enable AreaFix access to one or more Additional EchoLists |
 | ''Notify''     | ''false''     | Notify via NetMail of node's current AreaFix settings whenever SBBSecho is run with the '`-g`' option | | ''Notify''     | ''false''     | Notify via NetMail of node's current AreaFix settings whenever SBBSecho is run with the '`-g`' option |
Line 127: Line 137:
 | ''Archive''    | ''None''      | Name of a configured archive type or "None" | | ''Archive''    | ''None''      | Name of a configured archive type or "None" |
 | ''Route''      |               | FTN address (e.g. of a hub) to route all EchoMail and NetMail destined for this node's address | | ''Route''      |               | FTN address (e.g. of a hub) to route all EchoMail and NetMail destined for this node's address |
 +| ''LocalAddress'' |             | Optional local system address (AKA) to use when sending packets to this node                   |
 | ''GroupHub''                 | List of Message Groups (comma-separated) for which this linked node is your system's uplink (hub) | | ''GroupHub''                 | List of Message Groups (comma-separated) for which this linked node is your system's uplink (hub) |
 | ''BinkpHost''  |               | Host name or IP address of this link's BinkP mailer (optional) | | ''BinkpHost''  |               | Host name or IP address of this link's BinkP mailer (optional) |
Line 132: Line 143:
 | ''BinkpPoll''  | ''false''    | Poll this link (e.g. as part of the ''BINKPOLL'' timed event) for incoming mail | | ''BinkpPoll''  | ''false''    | Poll this link (e.g. as part of the ''BINKPOLL'' timed event) for incoming mail |
 | ''BinkpAllowPlainAuth'' | ''false''| Allow plain-password (in addition to CRAM-MD5) when authenticating with this linked node | | ''BinkpAllowPlainAuth'' | ''false''| Allow plain-password (in addition to CRAM-MD5) when authenticating with this linked node |
-| ''BinkpPlainAuthOnly''  | ''false''| //Only// support plain-password authentication with this linked node |+| ''BinkpPlainAuthOnly''  | ''false''| //Only// support plain-password authentication when connecting (outbound) with this linked node |
 | ''BinkpAllowPlainText'' | ''true'' | Allow plain-text (unencrypted) communication with this linked node | | ''BinkpAllowPlainText'' | ''true'' | Allow plain-text (unencrypted) communication with this linked node |
 | ''BinkpSourceAddress''  |          | Use an alternative FTN address as the source address when communicating with this node via BinkP | | ''BinkpSourceAddress''  |          | Use an alternative FTN address as the source address when communicating with this node via BinkP |
 +| ''BinkpTLS''            | ''false''| Use implicit TLS for outbound encrypted connections with this linked node |
  
 **NOTE:** **NOTE:**
Line 140: Line 152:
  
 === Example === === Example ===
-<file>+<code ini>
 [node:1:218/700] [node:1:218/700]
         Comment = My Hub         Comment = My Hub
Line 168: Line 180:
         Status = Normal         Status = Normal
         Route = 1:218/700                 Route = 1:218/700        
-</file>+</code>
  
 === BinkP Session-Security === === BinkP Session-Security ===
Line 183: Line 195:
  
 Also note: authentication is performed by the //answering// BinkP node (server/service), so while one security level may work okay for outgoing connections to a linked-node, its possible that there could be problems (incompatibilities) with incoming connections from that same linked-node. It's a good idea to test both incoming and outgoing connections with a linked-node before increasing the BinkP session security level. Also note: authentication is performed by the //answering// BinkP node (server/service), so while one security level may work okay for outgoing connections to a linked-node, its possible that there could be problems (incompatibilities) with incoming connections from that same linked-node. It's a good idea to test both incoming and outgoing connections with a linked-node before increasing the BinkP session security level.
 +
 +
 +==== Robot Sections ====
 +
 +Each NetMail Robot Section has a prefix of "''robot:''" with the name of the robot (e.g. ''filefix'') following the prefix. Received NetMail addressed to the name of a robot will be stored in your ''[[dir:data]]/mail'' base and expected to be acted-up by a robot that is trigged when its associated semaphore file is touched. [[module:TickFix]] is an example of a NetMail robot.
 +
 +^ Key             ^ Description ^
 +| ''SemFile''     | The path and filename of a semaphore file to be //touched// by SBBSecho when a NetMail is received for the robot |
 +| ''attr''        | NetMail attribute flags to set (usually specific in hexadecimal notation with a ''0x'' prefix), ''0x20'' (In-Transit) is recommended |
  
 ==== Domain Sections ==== ==== Domain Sections ====
Line 209: Line 230:
 ===== See Also ===== ===== See Also =====
   * [[:config:|config index]]   * [[:config:|config index]]
-  * [[:util:SBBSecho]] +  * [[:util:SBBSecho]] FidoNet EchoMail program (tosser/scanner) 
-  * [[:util:echocfg]]+  * [[:util:echocfg]] SBBSecho Configuration utility 
 +  * [[:module:BinkIT]] FidoNet/BINKP mailer
  
-{{tag>}}+{{tag>fidonet}}
  
config/sbbsecho.ini.txt · Last modified: 2022/03/14 19:54 by Andre
Back to top
CC Attribution 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0