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
Next revisionBoth sides next revision
util:sbbsecho [2018/07/31 15:26] – Updated Secure Operation and Long Tags sections digital manutil:sbbsecho [2019/08/23 15:42] – Describe AreaFile-less operation, updated echocfg screens, etc. digital man
Line 16: Line 16:
 The terminology used with FidoNet networking technology can be as confusing as it is particular. In our [[ref:FidoNet Glossary]] we attempt to define some terms we will be using through-out this article to describe the features and functions of SBBSecho. If you come across a term you aren't familiar with, please check the [[ref:FidoNet Glossary]]. The terminology used with FidoNet networking technology can be as confusing as it is particular. In our [[ref:FidoNet Glossary]] we attempt to define some terms we will be using through-out this article to describe the features and functions of SBBSecho. If you come across a term you aren't familiar with, please check the [[ref:FidoNet Glossary]].
    
-===== Installation =====+===== Install =====
  
-SBBSecho and its configuration program, EchoCfg, come with Synchronet BBS software (i.e. their executables can be found in your Synchronet ''[[dir:exec]]'' directory. So it usually requires no special installation steps of its own.+SBBSecho and its configuration program, EchoCfg, come with Synchronet BBS software (i.e. their executables can be found in your Synchronet ''[[dir:exec]]'' directory). So the program itself usually requires no special installation steps of its own.
  
-SBBSecho expects to find an area file (e.g. ''areas.bbs''in your Synchronet ''[[dir:data]]'' +Thing you should have before you proceed: 
-directory. You will need to create the Area File in order for SBBSecho to do anything with EchoMail messages. Importing and exporting //NetMail// does not require an area file.+  - Your hub/uplink's FidoNet address 
 +  - Your hub/uplink's Internet hostname or IP address 
 +  - Your own FidoNet address 
 +  - Your hub-agreed-upon BinkP session password 
 +  - Your hub-agreed-upon packet password (optional) 
 +  - Your hub-agreed-upon AreaFix password (optional) 
 +  - An //EchoList// file for the network (e.g. ''BACKBONE.NA'')
  
-[[util:SCFG]] can also export a group of message areas (sub-boards) to an SBBSecho-compatible Area File+==== Message Group ====  
-You may want to first import a network's EchoList (e.g. FidoNet's ''BACKBONE.NA'') into message group (using [[util:SCFG]]) and then export the networked message group(sfrom [[util:SCFG]] to the SBBSecho-compatible Area File once you're linked successfully with your network hub.+ 
 +Create a message group called "FidoNet" (or whatever is most appropriate for the network) in [[util:SCFG]]->Message Areas: 
 +<file> 
 +╔══════════════════════════════════════════════════════════╗ 
 +║                       FidoNet Group                      ║ 
 +╠══════════════════════════════════════════════════════════╣ 
 +║ │Long Name                  FidoNet                      ║ 
 +║ │Short Name                 FidoNet                      ║ 
 +║ │Internal Code Prefix       FIDONET_                     ║ 
 +║ │Access Requirements                                     ║ 
 +║ │Sort Group by Sub-board    Index Position               ║ 
 +║ │Clone Options                                           ║ 
 +║ │Export Areas...                                         ║ 
 +║ │Import Areas...                                         ║ 
 +║ │Message Sub-boards...                                   ║ 
 +╚══════════════════════════════════════════════════════════╝ 
 + 
 +</file> 
 + 
 +==== EchoList ==== 
 + 
 +Now, import a list of the public message areas ("echoes") from the network'standard EchoList (e.g. FidoNet's ''BACKBONE.NA'' file) into your new message group using the Message Group "Import Areas..." option in [[util:SCFG]]
 +<file> 
 +╔═════════════════════════════════════════╗ 
 +║         Import Area File Format         ║ 
 +╠═════════════════════════════════════════╣ 
 +║ │subs.txt        Synchronet Sub-boards  ║ 
 +║ │control.dat     QWK Conference List    ║ 
 +║ │areas.bbs       Generic Area File      ║ 
 +║ │areas.bbs       SBBSecho Area File     ║ 
 +->│backbone.na     FidoNet EchoList      <- 
 +║ │badareas.lst    SBBSecho Bad Area List ║ 
 +╚═════════════════════════════════════════╝ 
 +</file> 
 + 
 +===== Area File ===== 
 + 
 +By default, SBBSecho will try to open an //Area File// (by default, ''[[dir:data]]/areas.bbs''). The Area File can be used to associate FidoNet EchoTags with sub-boards configured in [[util:SCFGG]]. You can also specify downlinks and pass-through areas in an Area File, if need be. The Area File is optional, not strictly needed, when you have the "Automatically Add New Subs to Area List" option enabled and set to "List Only" in [[util:EchoCfg]]->EchoMail Settings. 
 + 
 +To successfully operate without an Area File, you must have your hub configured in [[util:EchoCfg]]->Linked Nodes with its "Uplink for Message Groups" setting set to the //short name// of the message group you created in [[util:SCFG]]->Message Areas for this network. 
 + 
 +You will need an Area File if you are to have any downlinks (nodes for which you are //their// hub to the network)
 + 
 +[[util:SCFG]] can also export a group of message areas (sub-boards) to an SBBSecho-compatible Area File using the Message Group "Export Areas..." option: 
 +<file> 
 +╔═══════════════════════════════════════╗ 
 +║        Export Area File Format        ║ 
 +╠═══════════════════════════════════════╣ 
 +║ │subs.txt       Synchronet Sub-boards ║ 
 +->│areas.bbs      SBBSecho Area File   <
 +║ │backbone.na    FidoNet EchoList      ║ 
 +╚═══════════════════════════════════════╝ 
 +</file>
  
 If the ''AutoAddSubs'' feature is enabled, sub-boards configured in SCFG->Message Areas may be //automatically// added to your Area File when the network hub (your uplink) has be configured in EchoCfg->Linked Nodes and the "Group Hub" setting for that link set to the name of the corresponding message group in SCFG->Message Areas. This Auto-Add procedure happens during SBBSecho initialization and is not dependent upon receiving any echomail messages for the configured message areas. If the ''AutoAddSubs'' feature is enabled, sub-boards configured in SCFG->Message Areas may be //automatically// added to your Area File when the network hub (your uplink) has be configured in EchoCfg->Linked Nodes and the "Group Hub" setting for that link set to the name of the corresponding message group in SCFG->Message Areas. This Auto-Add procedure happens during SBBSecho initialization and is not dependent upon receiving any echomail messages for the configured message areas.
  
-===== Area File Format =====+==== Format ====
  
 Each line of the SBBSecho Area File (e.g. ''areas.bbs'') represents an EchoMail message //area// in the following format: Each line of the SBBSecho Area File (e.g. ''areas.bbs'') represents an EchoMail message //area// in the following format:
Line 34: Line 92:
 Where each field is separated by white-space (space or tab characters) and the fields are: Where each field is separated by white-space (space or tab characters) and the fields are:
  
-==== CODE ====+=== CODE ===
 The ''CODE'' field is the internal code of the sub-board. The ''CODE'' field is the internal code of the sub-board.
  
 Internal codes consist of a combination of the Message Group's "code prefix" and the Sub-board's "code suffix". The full internal code may be as long as 16 characters and may not contain white-space or any invalid filename characters. Internal codes consist of a combination of the Message Group's "code prefix" and the Sub-board's "code suffix". The full internal code may be as long as 16 characters and may not contain white-space or any invalid filename characters.
  
-=== Pass-through Areas ===+== Pass-through Areas ==
 Any unrecognized internal codes are considered //pass-through// (not imported into your BBS's message areas). Using "''P''" for the internal code of pass-through areas will prevent warnings from being logged about the internal code not being found in your BBS's message base configuration (i.e. in ''[[util:SCFG]]''->Message Areas). Any unrecognized internal codes are considered //pass-through// (not imported into your BBS's message areas). Using "''P''" for the internal code of pass-through areas will prevent warnings from being logged about the internal code not being found in your BBS's message base configuration (i.e. in ''[[util:SCFG]]''->Message Areas).
  
-==== TAG ====+=== TAG ===
 The ''TAG'' field is the FTN area tag (or echo tag) as shown in your FTN network's agreed upon echo list file (e.g. ''BACKBONE.NA'' for the FidoNet North American backbone). Area tags may not contain white-space characters. The ''TAG'' field is the FTN area tag (or echo tag) as shown in your FTN network's agreed upon echo list file (e.g. ''BACKBONE.NA'' for the FidoNet North American backbone). Area tags may not contain white-space characters.
  
-=== Long Tags ===+== Long Tags ==
 Although standard FidoNet echo tags (AKA "area tag") may be as long as 35 characters, Synchronet's Sub-board //short names// are limited to a length of 25 characters. As of July 28, 2018, Synchronet v3.17a will import (e.g. from a ''BACKBONE.NA'' file) echo tags longer than 25 characters into the "Newsgroup" name of the sub-board. Each sub-board's "Newsgroup" name can accommodate a length of up to 63 characters (no spaces). Likewise, when exporting message areas from SCFG or SBBSecho (e.g. to an ''areas.bbs'' file), if a "Newsgroup" name is defined for a message area, it will be used for the exported echo tag of that exported area. Although standard FidoNet echo tags (AKA "area tag") may be as long as 35 characters, Synchronet's Sub-board //short names// are limited to a length of 25 characters. As of July 28, 2018, Synchronet v3.17a will import (e.g. from a ''BACKBONE.NA'' file) echo tags longer than 25 characters into the "Newsgroup" name of the sub-board. Each sub-board's "Newsgroup" name can accommodate a length of up to 63 characters (no spaces). Likewise, when exporting message areas from SCFG or SBBSecho (e.g. to an ''areas.bbs'' file), if a "Newsgroup" name is defined for a message area, it will be used for the exported echo tag of that exported area.
  
-=== Bad Echo Area ===+== Bad Echo Area ==
  
 If an area's ''TAG'' field value is a ''*'' (asterisk), then the area will be considered a "bad echo" area and will receive all messages for areas not otherwise specified in this file (sort of a 'catch-all' bin for 'unknown' areas). You can have **only one** "bad echo" area configured in your Area File. To //re-toss// (move) messages from the "bad echo" area into newly added or linked sub-boards, run SBBSecho with the ''-r'' command-line option.  If an area's ''TAG'' field value is a ''*'' (asterisk), then the area will be considered a "bad echo" area and will receive all messages for areas not otherwise specified in this file (sort of a 'catch-all' bin for 'unknown' areas). You can have **only one** "bad echo" area configured in your Area File. To //re-toss// (move) messages from the "bad echo" area into newly added or linked sub-boards, run SBBSecho with the ''-r'' command-line option. 
  
-==== LINK ====+=== LINK ===
 Each ''LINK'' field is an FTN address which you wish to import mail from and export mail to. At the very least, your uplink's (hub's) address should be listed here. Your address should **NOT** be listed here. If multiple link fields are specified, you should specify the full 3D or 4D address for each. Links can be remotely added or removed from the Area File by authenticated Nodes using AreaFix. Each ''LINK'' field is an FTN address which you wish to import mail from and export mail to. At the very least, your uplink's (hub's) address should be listed here. Your address should **NOT** be listed here. If multiple link fields are specified, you should specify the full 3D or 4D address for each. Links can be remotely added or removed from the Area File by authenticated Nodes using AreaFix.
  
 Lines beginning with a semicolon (;) are considered comments, and are ignored. Lines beginning with a semicolon (;) are considered comments, and are ignored.
-==== Area File Example ====+==== Example ====
  
 <file> <file>
Line 66: Line 124:
 The amount of spacing (white-space characters including horizontal tabs and spaces) between each element in the line is not important. Each line may be up to 1024 characters in length. The amount of spacing (white-space characters including horizontal tabs and spaces) between each element in the line is not important. Each line may be up to 1024 characters in length.
  
-===== Configuration =====+===== Configure =====
    
 In order to set up SBBSecho for your system you must: In order to set up SBBSecho for your system you must:
Line 200: Line 258:
 === Global Settings === === Global Settings ===
 <code> <code>
-╔══════════════════════════════════════════════╗ +═══════════════════════════════════════════════════╗ 
-║                Global Settings               ║ +║                  Global Settings                  ║ 
-╠══════════════════════════════════════════════╣ +═══════════════════════════════════════════════════╣ 
-║ │Mailer Type               Binkley/FLO       ║ +║ │Mailer Type                    Binkley/FLO       ║ 
-║ │Log Level                 Debugging         ║ +║ │Log Level                      Debugging         ║ 
-║ │Log Timestamp Format      %m/%d/%y %H:%M:%S ║ +║ │Log Timestamp Format           %m/%d/%y %H:%M:%S ║ 
-║ │Strict Packet Passwords   Enabled           ║ +║ │Strict Packet Passwords        Enabled           ║ 
-║ │BSY Mutex File Timeout    12 hours          ║ +║ │Config File Backups            10                ║ 
-║ │BSO Lock Attempt Delay    10 seconds        ║ +║ │Minimum Free Disk Space        10G bytes         ║ 
-║ │BSO Lock Attempt Limit    60                ║ +║ │Strip Incoming Soft CRs        No                ║ 
-║ │Config File Backups       100               ║ +║ │Strip Outgoing Line Feeds      No                ║ 
-║ │BinkP Capabilities                          ║ +║ │Use Outboxes for Mail Files    Yes               ║ 
-║ │BinkP Sysop Name                            ║ +║ │BSY Mutex File Timeout         12 hours          ║ 
-╚══════════════════════════════════════════════╝+║ │BSO Lock Attempt Delay         10 seconds        ║ 
 +║ │BSO Lock Attempt Limit         60                ║ 
 +║ │BinkP Capabilities                               ║ 
 +║ │BinkP Sysop Name               Your Name         ║ 
 +║ │BinkP Authentication           Plain or CRAM-MD5 ║ 
 +║ │BinkP Encryption               Supported         ║ 
 +═══════════════════════════════════════════════════╝
 </code> </code>
 === Mailer Type === === Mailer Type ===
Line 360: Line 424:
 ║ │Send Notify List               No          ║ ║ │Send Notify List               No          ║
 ║ │Uplink for Message Groups      FidoNet     ║ ║ │Uplink for Message Groups      FidoNet     ║
 +║ │Local Address (AKA)            Best Match  ║
 ║ │Route To                       Disabled    ║ ║ │Route To                       Disabled    ║
 ║ │Inbox Directory                            ║ ║ │Inbox Directory                            ║
Line 502: Line 567:
 == Inbox Directory == == Inbox Directory ==
 Inbox Directory is only used in BSO operating mode and is an optional Inbox Directory is only used in BSO operating mode and is an optional
-alternate directory to search for incoming files from this node   +alternate directory to search for incoming files from this node 
-(e.g. used in combination with BinkD's ibox setting).            +(e.g. used in combination with BinkD'''ibox'' setting). 
 + 
 +Note: [[module:BinkIT]] does **not support** inboxes at this time.
  
 == Outbox Directory == == Outbox Directory ==
-Outbox Directory is only used in BSO operating mode and is an optional  +Outbox Directory is only used in BSO operating mode and is an optional
 alternate directory to place outbound files for this node (e.g. used alternate directory to place outbound files for this node (e.g. used
-in combination with BinkD's obox setting).                          +in combination with BinkD'''obox'' setting). 
 + 
 +Note: [[module:BinkIT]] has //experimental support// for outboxes at this time.
  
 == BinkP Settings == == BinkP Settings ==
Line 515: Line 584:
  
 <file> <file>
-╔═════════════════════════════╗ +═════════════════════════════════════╗ 
-║   1:218/700 BinkP Settings  ║ +║       1:218/700 BinkP Settings      ║ 
-╠═════════════════════════════╣ +═════════════════════════════════════╣ 
-║ │Host                       ║ +║ │Host                               ║ 
-║ │Port                 24554 ║ +║ │Port                 24554         ║ 
-║ │Poll                 Yes   ║ +║ │Poll                 Yes           ║ 
-║ │Allow Plain Auth     No    ║ +║ │Authentication       CRAM-MD5 Only ║ 
-║ │Allow Plain Text     No    ║ +║ │Encryption           Supported     ║ 
-║ │Source Address             ║ +║ │Source Address                     ║ 
-╚═════════════════════════════╝+═════════════════════════════════════╝
 </file> </file>
 +
 +**Host** defines the TCP/IP address or host name with which to connect for sessions with this linked node.  If the host is not set, then a DNS-based look-up will be attempted (e.g. the IP address for 1:103/705 would be looked-up via host name f705.n103.z1.binkp.net). Nodelist-based look-ups are also supported.                         
 +                                                                        
 +**Port** defines the TCP port used by this linked node for BinkP sessions. The default BinkP TCP port is 24554.                                
 +                                                                        
 +**Poll** defines whether or not to periodically poll this linked node.
 +
 +**Authentication** determines what types of authentication will be supported during both inbound and outbound sessions with this linked node. The supported BinkP-auth methods are //Plain-Password// and //CRAM-MD5//.
 +                                                                        
 +**Encryption** determines whether unencrypted data transfers will be supported or required when communicating with this linked node. With this setting set to ''Required'', only BinkD-style-encrypted BinkP sessions will be supported. //CRAM-MD5// authentication must be used when encrypting BinkP sessions.
 +                                                                        
 +**Source** Address allows you to override the source FTN address used with outgoing BinkP mailer sessions with this linked node. Normally, this setting is left blank (not set).                     
  
 === Archive Types === === Archive Types ===
Line 628: Line 709:
 ║ │Ignore NetMail Destination Address      No    ║ ║ │Ignore NetMail Destination Address      No    ║
 ║ │Ignore NetMail 'Sent' Attribute         No    ║ ║ │Ignore NetMail 'Sent' Attribute         No    ║
 +║ │Ignore NetMail 'KillSent' Attribute     No    ║
 ║ │Ignore NetMail 'Received' Attribute     No    ║ ║ │Ignore NetMail 'Received' Attribute     No    ║
 ║ │Ignore NetMail 'Local' Attribute        No    ║ ║ │Ignore NetMail 'Local' Attribute        No    ║
Line 654: Line 736:
 ║ │Notify Users of Received EchoMail            Yes       ║ ║ │Notify Users of Received EchoMail            Yes       ║
 ║ │Convert Existing Tear Lines                  No        ║ ║ │Convert Existing Tear Lines                  No        ║
-║ │Strip Line Feeds from Outgoing Messages      No        ║ +║ │Automatically Add New Subs to Area List      List/File ║
-║ │Automatically Add New Subs to Area File      Yes       +
 ║ │Allow Nodes to Add Areas from Area File      Yes       ║ ║ │Allow Nodes to Add Areas from Area File      Yes       ║
 ║ │Maximum Backups to Maintain of Area File     100       ║ ║ │Maximum Backups to Maintain of Area File     100       ║
util/sbbsecho.txt · Last modified: 2024/01/07 15:25 by digital man
Back to top
CC Attribution 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0