Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
util:sbbsecho [2018/09/08 15:25] – [EchoCfg] Updated the BinkP Settings docs (some copy/paste from the EchoCfg online help) digital man | util:sbbsecho [2024/11/08 23:33] (current) – [Area Manager Commands] update help to reflect SBBSecho v3.21 AreaMgr request format digital man | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== SBBSecho ====== | + | ====== SBBSecho |
Synchronet' | Synchronet' | ||
Line 16: | Line 16: | ||
The terminology used with FidoNet networking technology can be as confusing as it is particular. In our [[ref: | The terminology used with FidoNet networking technology can be as confusing as it is particular. In our [[ref: | ||
- | ===== Installation | + | ===== Install |
- | SBBSecho and its configuration program, EchoCfg, come with Synchronet BBS software (i.e. their executables can be found in your Synchronet '' | + | SBBSecho and its configuration program, EchoCfg, come with Synchronet BBS software (i.e. their executables can be found in your Synchronet '' |
- | SBBSecho expects to find an area file (e.g. '' | + | Things 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 | + | - Your hub/uplink's FidoNet address |
+ | - Your hub/uplink's Internet hostname or IP address | ||
+ | - Your own FidoNet address (use '' | ||
+ | - 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. '' | ||
- | [[util: | + | ==== Message Group ==== |
- | You may want to first import a network' | + | |
+ | Create a message group called " | ||
+ | < | ||
+ | ╔══════════════════════════════════════════════════════════╗ | ||
+ | ║ | ||
+ | ╠══════════════════════════════════════════════════════════╣ | ||
+ | ║ │Long Name FidoNet | ||
+ | ║ │Short Name | ||
+ | ║ │Internal Code Prefix | ||
+ | ║ │Access Requirements | ||
+ | ║ │Sort Group by Sub-board Index Position | ||
+ | ║ │Clone Options | ||
+ | ║ │Export Areas... ║ | ||
+ | ║ │Import Areas... | ||
+ | ║ │Message Sub-boards... | ||
+ | ╚══════════════════════════════════════════════════════════╝ | ||
+ | |||
+ | </ | ||
+ | |||
+ | ==== EchoList ==== | ||
+ | |||
+ | Now, import a list of the public message areas (" | ||
+ | < | ||
+ | ╔═════════════════════════════════════════╗ | ||
+ | ║ | ||
+ | ╠═════════════════════════════════════════╣ | ||
+ | ║ │subs.txt | ||
+ | ║ │control.dat | ||
+ | ║ │areas.bbs | ||
+ | ║ │areas.bbs | ||
+ | -> | ||
+ | ║ │badareas.lst | ||
+ | ╚═════════════════════════════════════════╝ | ||
+ | </ | ||
+ | |||
+ | An alternative method is to instead subscribe/ | ||
+ | ===== Area File ===== | ||
+ | |||
+ | By default, SBBSecho will try to open an //Area File// (by default, '' | ||
+ | |||
+ | To successfully | ||
+ | |||
+ | You will need an Area File if you are to have any downlinks (nodes for which you are // | ||
+ | |||
+ | [[util: | ||
+ | < | ||
+ | ╔═══════════════════════════════════════╗ | ||
+ | ║ Export Area File Format | ||
+ | ╠═══════════════════════════════════════╣ | ||
+ | ║ │subs.txt | ||
+ | -> | ||
+ | ║ │backbone.na | ||
+ | ╚═══════════════════════════════════════╝ | ||
+ | </ | ||
If the '' | If the '' | ||
- | ===== Area File Format | + | ==== Format ==== |
Each line of the SBBSecho Area File (e.g. '' | Each line of the SBBSecho Area File (e.g. '' | ||
Line 34: | Line 93: | ||
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 '' | The '' | ||
Internal codes consist of a combination of the Message Group' | Internal codes consist of a combination of the Message Group' | ||
- | === Pass-through Areas === | + | == Pass-through Areas == |
Any unrecognized internal codes are considered // | Any unrecognized internal codes are considered // | ||
- | ==== TAG ==== | + | === TAG === |
The '' | The '' | ||
- | === Long Tags === | + | == Long Tags == |
Although standard FidoNet echo tags (AKA "area tag") may be as long as 35 characters, Synchronet' | Although standard FidoNet echo tags (AKA "area tag") may be as long as 35 characters, Synchronet' | ||
- | === Bad Echo Area === | + | == Bad Echo Area == |
If an area's '' | If an area's '' | ||
- | ==== LINK ==== | + | === LINK === |
Each '' | Each '' | ||
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 ==== |
< | < | ||
Line 66: | Line 125: | ||
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: | ||
- | - Configure your fundamental FTN settings (e.g. system address) in [[util: | + | - Configure your fundamental FTN settings (e.g. system address) in [[util: |
- | - Use the '' | + | - Use the '' |
==== SCFG ==== | ==== SCFG ==== | ||
Line 123: | Line 182: | ||
=== Inbound File Directory === | === Inbound File Directory === | ||
- | Older versions of SCFG (e.g. v3.16) contained this FidoNet setting which was used to specify the directory where non-secure inbound FidoNet files would be received by your FTN mailer. SBBSecho v2 used this setting, however Synchronet itself did not, so it was deprecated with SBBSecho v3 (replaced with the '' | + | Older versions of SCFG (e.g. v3.16) contained this FidoNet setting which was used to specify the directory where non-secure inbound FidoNet files would be received by your FTN mailer. SBBSecho v2 used this setting, however Synchronet itself did not, so it was deprecated with SBBSecho v3 (replaced with the '' |
Line 200: | Line 259: | ||
=== Global Settings === | === Global Settings === | ||
< | < | ||
- | ╔══════════════════════════════════════════════╗ | + | ╔═══════════════════════════════════════════════════╗ |
- | ║ Global Settings | + | ║ Global Settings |
- | ╠══════════════════════════════════════════════╣ | + | ╠═══════════════════════════════════════════════════╣ |
- | ║ │Mailer Type | + | ║ │Mailer Type Binkley/ |
- | ║ │Log Level | + | ║ │Log Level Debugging |
- | ║ │Log Timestamp Format | + | ║ │Log Timestamp Format |
- | ║ │Strict Packet Passwords | + | ║ │Strict Packet Passwords |
- | ║ │BSY Mutex File Timeout | + | ║ │Config File Backups |
- | ║ │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 | + | ║ │Strip Outgoing Line Feeds No ║ |
- | ║ │BinkP | + | ║ │Use Outboxes for Mail Files Yes ║ |
- | ║ │BinkP | + | ║ │BSY Mutex File Timeout |
- | ╚══════════════════════════════════════════════╝ | + | ║ │BSO Lock Attempt Delay |
+ | ║ │BSO Lock Attempt Limit | ||
+ | ║ │BinkP Capabilities | ||
+ | ║ │BinkP Sysop Name | ||
+ | ║ │BinkP | ||
+ | ║ │BinkP | ||
+ | ╚═══════════════════════════════════════════════════╝ | ||
</ | </ | ||
=== Mailer Type === | === Mailer Type === | ||
Line 253: | Line 318: | ||
Log Timestmap Format defines the format of the date/ | Log Timestmap Format defines the format of the date/ | ||
along with each log message to the log file (e.g. '' | along with each log message to the log file (e.g. '' | ||
- | The timestamp format is defined using standard C '' | + | The timestamp format is defined using standard C '' |
The default format is: '' | The default format is: '' | ||
For SBBSecho v2 timestamp format, use '' | For SBBSecho v2 timestamp format, use '' | ||
Line 360: | Line 425: | ||
║ │Send Notify List | ║ │Send Notify List | ||
║ │Uplink for Message Groups | ║ │Uplink for Message Groups | ||
+ | ║ │Local Address (AKA) Best Match ║ | ||
║ │Route To | ║ │Route To | ||
║ │Inbox Directory | ║ │Inbox Directory | ||
Line 455: | Line 521: | ||
== AreaFix Password == | == AreaFix Password == | ||
- | AreaFix passwords are required to be included in the //Subject// line of received AreaFix requests (NetMail messages). | + | AreaFix passwords |
- | AreaFix Passwords are case insensitive. | + | AreaFix Passwords are case insensitive |
This setting may be managed by the node using AreaFix requests. | This setting may be managed by the node using AreaFix requests. | ||
Line 502: | Line 568: | ||
== 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' | + | (e.g. used in combination with BinkD' |
+ | |||
+ | Note: [[module: | ||
== 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' | + | in combination with BinkD' |
+ | |||
+ | Note: [[module: | ||
== BinkP Settings == | == BinkP Settings == | ||
Line 515: | Line 585: | ||
< | < | ||
- | ╔[■][?]═══════════════════════════════╗ | + | ╔═════════════════════════════════════╗ |
║ | ║ | ||
╠═════════════════════════════════════╣ | ╠═════════════════════════════════════╣ | ||
Line 525: | Line 595: | ||
║ │Source Address | ║ │Source Address | ||
╚═════════════════════════════════════╝ | ╚═════════════════════════════════════╝ | ||
- | |||
</ | </ | ||
Line 641: | Line 710: | ||
║ │Ignore NetMail Destination Address | ║ │Ignore NetMail Destination Address | ||
║ │Ignore NetMail ' | ║ │Ignore NetMail ' | ||
+ | ║ │Ignore NetMail ' | ||
║ │Ignore NetMail ' | ║ │Ignore NetMail ' | ||
║ │Ignore NetMail ' | ║ │Ignore NetMail ' | ||
Line 667: | Line 737: | ||
║ │Notify Users of Received EchoMail | ║ │Notify Users of Received EchoMail | ||
║ │Convert Existing Tear Lines No ║ | ║ │Convert Existing Tear Lines No ║ | ||
- | ║ │Strip Line Feeds from Outgoing Messages | + | ║ │Automatically Add New Subs to Area List List/File ║ |
- | ║ │Automatically Add New Subs to Area File | + | |
║ │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 | ║ │Maximum Backups to Maintain of Area File | ||
Line 703: | Line 772: | ||
from any additionally configured EchoLists which they have | from any additionally configured EchoLists which they have | ||
access to. | access to. | ||
+ | |||
+ | == Zone Blind SEEN-BY and PATH Lines == | ||
+ | Zone Blind SEEN-BY and PATH Lines when Enabled will cause SBBSecho to assume that node numbers are not duplicated across zones and that a net/node combination in either of these Kludge lines should be used to identify a spcific node regardless of which zone that node is located in (thus breaking the rules of FidoNet 3D addressing). | ||
+ | |||
+ | If you are having trouble with FidoNet echomail crossing Zone boundaries which does not add all the SEEN-BY and PATH nodes, then enable this option with the limit of " | ||
=== Paths and Filenames === | === Paths and Filenames === | ||
Line 876: | Line 950: | ||
== AreaFix Keys == | == AreaFix Keys == | ||
These are the keys required for a node to be able to gain | These are the keys required for a node to be able to gain | ||
- | access to this particular echo list. These flags are defined | + | access to this particular echo list. These keys are then given |
- | for each node from the ' | + | to chosen nodes in the ' |
Selecting this option will bring you to a sub-menu where you | Selecting this option will bring you to a sub-menu where you | ||
may add and remove keys for this EchoList. | may add and remove keys for this EchoList. | ||
Line 889: | Line 963: | ||
==== Instances ==== | ==== Instances ==== | ||
- | SBBSecho is designed to run only one instance at a time. A mutual-exclusion file ('' | + | SBBSecho is designed to run only one instance at a time. A mutual-exclusion file ('' |
If you get the following error message (on the console and/or the log file) and you can confirm that SBBSecho is not actually running, you can safely delete the mutex file to allow SBBSecho to again run normally: | If you get the following error message (on the console and/or the log file) and you can confirm that SBBSecho is not actually running, you can safely delete the mutex file to allow SBBSecho to again run normally: | ||
Line 954: | Line 1028: | ||
Remote area manager, or AreaFix, commands are used by linked nodes in order to | Remote area manager, or AreaFix, commands are used by linked nodes in order to | ||
turn echo areas off and on, list currently connected areas, and more. | turn echo areas off and on, list currently connected areas, and more. | ||
- | The following text is from the file '' | + | The following text is from the file '' |
SBBSecho, should be located in your Synchronet '' | SBBSecho, should be located in your Synchronet '' | ||
area manager commands available to the linked nodes which have been configured using | area manager commands available to the linked nodes which have been configured using | ||
the '' | the '' | ||
< | < | ||
- | Address all requests to ' | + | Address all Area Management |
- | Your Area Manager password goes on the subject | + | Your Area Manager password goes in the message |
+ | by -R, -L, or -Q for Rescan, List, or Query functions, respectively. | ||
- | In the body of the message | + | In the body of the message, one or more: |
- | [+]<areaname> | + | <areatag> |
- | -<areaname> | + | -<areatag> Disconnect an area |
%HELP | %HELP | ||
- | %LIST | + | %LIST |
%QUERY | %QUERY | ||
%UNLINKED | %UNLINKED | ||
- | %COMPRESSION < | + | %COMPRESSION < |
%PASSWORD < | %PASSWORD < | ||
%PKTPWD < | %PKTPWD < | ||
%TICPWD < | %TICPWD < | ||
%RESCAN | %RESCAN | ||
- | %RESCAN <areaname> Request a rescan of a single connected area | + | %RESCAN <areatag> |
+ | %ECHOSTATS < | ||
%ACTIVE | %ACTIVE | ||
%PASSIVE | %PASSIVE | ||
+ | %NOTIFY <ON | OFF> | ||
%FROM < | %FROM < | ||
%+ALL | %+ALL | ||
Line 991: | Line 1068: | ||
==== Changes in Version 3 ==== | ==== Changes in Version 3 ==== | ||
- | |||
- | For a detailed list of changes and code differences introduced in v3.0, see [[http:// | ||
The most major changes introduced in v3.0 are: | The most major changes introduced in v3.0 are: |