Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
util:sbbsecho [2017/11/06 03:23] – [Running SBBSecho] Added detail about the required env var. digital man | util:sbbsecho [2022/11/30 13:44] – [Area Manager Commands] update link to areamgr.hlp in repo (from cvs to git) digital man | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== SBBSecho ====== | + | ====== SBBSecho |
Synchronet' | Synchronet' | ||
===== Introduction ===== | ===== Introduction ===== | ||
- | SBBSecho is an FTN echomail program (tosser/ | + | SBBSecho is an FTN echomail program (tosser/ |
As of SBBSecho v2.30 (Nov-2015), SBBSecho will also export FTN NetMail from the Synchronet mail base ('' | As of SBBSecho v2.30 (Nov-2015), SBBSecho will also export FTN NetMail from the Synchronet mail base ('' | ||
- | * This feature allows the gating of SMTP (Internet e-mail) to FTN netmail by sending email to " | + | * This feature allows the gating of SMTP (Internet e-mail) to FTN netmail by sending email to " |
- | * This feature allows FidoNet netmail to be sent using JavaScript methods (e.g. via the [[server: | + | * This feature allows FidoNet netmail to be sent using JavaScript methods (e.g. via the [[server: |
In 2016, SBBSecho was overhauled and christened //version 3//. The documentation here is in the process of being updated to reflect all the changes in SBBSecho version 3. For more details about SBBSecho version 3, see [[#Version 3]]. | In 2016, SBBSecho was overhauled and christened //version 3//. The documentation here is in the process of being updated to reflect all the changes in SBBSecho version 3. For more details about SBBSecho version 3, see [[#Version 3]]. | ||
Line 14: | Line 14: | ||
===== Terminology ===== | ===== Terminology ===== | ||
- | The terminology used with FidoNet networking technology can be as confusing as it is particular. | + | The terminology used with FidoNet networking technology can be as confusing as it is particular. |
- | ==== FTN ==== | + | ===== Install ===== |
- | FidoNet Technology Network: Any network using FidoNet standards for addressing, | + | |
- | mail packets, mail sessions, node lists, etc. | + | |
- | ==== Zones, Nets, Nodes, and Points? ==== | + | SBBSecho and its configuration program, EchoCfg, come with Synchronet BBS software |
- | FTN node addresses are like phone numbers, they are made up of multiple | + | |
- | components | + | |
- | The main four components are: zone, net, node, and point. | + | Things you should have before you proceed: |
- | Each component is specified by a decimal | + | - Your hub/ |
- | (no spaces): | + | - Your hub/ |
+ | - Your own FidoNet address (use ''<// | ||
+ | - Your hub-agreed-upon BinkP session password | ||
+ | - Your hub-agreed-upon packet password | ||
+ | | ||
+ | - An // | ||
- | Zone: | + | ==== Message Group ==== |
- | The zone represents the continent | + | Create a message group called " |
- | FTN network). All FidoNet nodes in North America have a zone 1 address. When | + | < |
- | the zone is specified in an address, it is the first component and must be | + | ╔══════════════════════════════════════════════════════════╗ |
- | followed | + | ║ |
- | system' | + | ╠══════════════════════════════════════════════════════════╣ |
+ | ║ │Long Name FidoNet | ||
+ | ║ │Short Name | ||
+ | ║ │Internal Code Prefix | ||
+ | ║ │Access Requirements | ||
+ | ║ │Sort Group by Sub-board | ||
+ | ║ │Clone Options | ||
+ | ║ │Export Areas... ║ | ||
+ | ║ │Import Areas... ║ | ||
+ | ║ │Message Sub-boards... | ||
+ | ╚══════════════════════════════════════════════════════════╝ | ||
- | The net represents the network number of the FTN node. Duplicate net numbers | + | </ |
- | may exist between zones. If the net number is not present, the local system' | + | |
- | net is assumed. | + | |
- | The node number specifies an exact FTN node within a network. The node number | + | ==== EchoList ==== |
- | is the only required element of an FTN node address. | + | |
- | The point is an optional component which specifies a sub-node that does not | + | |
- | directly receive mail and is also not listed in the main FTN node list, but | + | |
- | instead gets all its mail from its boss-node (zone: | + | |
- | is not specified, 0 (zero) is assumed (i.e. '' | + | |
- | which indicates the system with that address is **not** a point node. | + | |
- | Zones can be grouped into named domains | + | Now, import a list of the public message areas (" |
- | are pretty rarely used in the twenty-first century. | + | < |
+ | ╔═════════════════════════════════════════╗ | ||
+ | ║ | ||
+ | ╠═════════════════════════════════════════╣ | ||
+ | ║ │subs.txt | ||
+ | ║ │control.dat QWK Conference List ║ | ||
+ | ║ │areas.bbs | ||
+ | ║ │areas.bbs | ||
+ | -> | ||
+ | ║ │badareas.lst | ||
+ | ╚═════════════════════════════════════════╝ | ||
+ | </ | ||
- | A 2D (2 dimensional) address refers | + | An alternative method is to instead subscribe/ |
- | net and node numbers | + | ===== Area File ===== |
- | A 3D (3 dimensional) address refers | + | By default, SBBSecho will try to open an //Area File// |
- | net, and node numbers | + | |
- | if it exists. | + | |
- | A 4D (4 dimensional) address refers to an FTN address containing the zone, | + | To successfully operate without |
- | net, node, and optional point numbers (e.g. '' | + | |
- | A 5D (5 dimensional) address refers to an FTN address consisting of a standard | + | You will need an Area File if you are to have any downlinks |
- | 3D or 4D address with an appended " | + | |
- | ==== Node ==== | + | [[util: |
- | All FidoNet node-listed systems are // | + | < |
+ | ╔═══════════════════════════════════════╗ | ||
+ | ║ Export Area File Format | ||
+ | ╠═══════════════════════════════════════╣ | ||
+ | ║ │subs.txt | ||
+ | -> | ||
+ | ║ │backbone.na | ||
+ | ╚═══════════════════════════════════════╝ | ||
+ | </ | ||
- | **Normal Nodes** do not have a //point// value, so a '' | + | If the '' |
- | **Point Nodes** (nodes with non-zero point value) may only directly connect and communicate with their //boss node//. The boss node of a point node with the address '' | + | ==== Format ==== |
- | A **Boss Node** is just a normal node that has one or more //point nodes// for which they are responsible to deliver and receive messages and files. | + | Each line of the SBBSecho Area File (e.g. '' |
+ | CODE TAG LINK [LINK] [...] | ||
+ | Where each field is separated by white-space (space or tab characters) and the fields are: | ||
- | A **Linked Node** | + | === CODE === |
+ | The '' | ||
- | ==== Uplink ==== | + | Internal codes consist of a combination of the Message Group' |
- | An //Uplink// is a Linked Node which is your system' | + | == Pass-through Areas == |
+ | Any unrecognized internal codes are considered | ||
- | ==== Downlink ==== | + | === TAG === |
+ | The '' | ||
- | A //Downlink// is a Linked Node which your system | + | == Long Tags == |
+ | Although standard FidoNet echo tags (AKA "area tag") may be as long as 35 characters, Synchronet' | ||
- | ==== Attach or FLO Mailer? ==== | + | == Bad Echo Area == |
- | If you are using FrontDoor, InterMail, D'bridge, SEAdog, Dutchie, or any other | + | If an area's '' |
- | ArcMail | + | |
- | "ArcMail/ | + | |
- | If you are using BinkD (Binkley daemon), Argus/ | + | === LINK === |
+ | Each '' | ||
- | It is very important that you select the correct " | + | Lines beginning with a semicolon |
+ | ==== Example ==== | ||
- | ==== NetMail ==== | + | < |
+ | FIDO_SBBS SYNCHRONET 1: | ||
+ | FIDO_SYNCDATA SYNCDATA 1: | ||
+ | FIDO_SYNC_SYS SYNC_SYSOPS 1: | ||
+ | </ | ||
- | Point-to-point | + | The amount of spacing |
- | ==== EchoMail | + | ===== Configure |
+ | |||
+ | In order to set up SBBSecho for your system you must: | ||
+ | - Configure your fundamental FTN settings (e.g. system address) in [[util: | ||
+ | - Use the '' | ||
- | Group or conference messages of a particular subject matter (a.k.a. Message Area). Usually | + | ==== SCFG ==== |
- | distributed on a regional or continental scale (e.g. FidoNet Zone 1 backbone). | + | |
- | FTN style echomail areas have a unique name associated with them to | + | |
- | distinguish each area from the others. These agreed upon area names are called //Area Tags// or //Echo Tags//. | + | |
- | ==== Toss ==== | + | The fundamental FTN-related system settings are configured via [[SCFG]]-> |
+ | < | ||
+ | ╔══════════════════════════════════════════════════════════╗ | ||
+ | ║ | ||
+ | ╠══════════════════════════════════════════════════════════╣ | ||
+ | ║ │System Addresses | ||
+ | ║ │Default Origin Line ║ | ||
+ | ║ │NetMail Semaphore | ||
+ | ║ │EchoMail Semaphore | ||
+ | ║ │NetMail Directory | ||
+ | ║ │Allow Sending of NetMail | ||
+ | ║ │Allow File Attachments | ||
+ | ║ │Send NetMail Using Alias | ||
+ | ║ │NetMail Defaults to Crash No ║ | ||
+ | ║ │NetMail Defaults to Direct No ║ | ||
+ | ║ │NetMail Defaults to Hold | ||
+ | ║ │Kill NetMail After Sent Yes ║ | ||
+ | ║ │Cost to Send NetMail | ||
+ | ╚══════════════════════════════════════════════════════════╝ | ||
+ | </ | ||
- | To //toss// EchoMail packets or messages means to //import// the packed messages into your BBS's local message bases where your users can read and reply to the messages. FidoNet EchoMail programs, like SBBSecho, are often referred to as " | + | The settings from this SCFG menu used by SBBSecho include: |
- | ==== Scan ==== | + | * System Addresses (Main and AKAs) |
+ | * NetMail Directory | ||
+ | * Default Origin Line | ||
- | To //scan// message bases means to //export// locally-posted messages from your BBS's local message bases into EchoMail packets to be sent to your upstream link (hub) and any downstream linked nodes you may have. | + | At the minimum, you will need to configure your //Main// FTN System Address here. |
- | ==== Packet ==== | + | === System Addresses |
+ | Set your main/ | ||
- | An FTN packet is a group of one or more messages contained in a single | + | Only 3D (zone: |
- | uncompressed file. Packets may contain echomail | + | |
- | Packets files usually have a '' | + | |
- | Binkley/FLO Mailers will have '' | + | |
- | first eight characters of the filename may be anything, but are usually decimal or hexadecimal | + | |
- | digits representing the date and time the packet was created. | + | |
- | You can use the [[person:digital man]]'s '' | + | === NetMail Directory === |
+ | This is the path to a directory on your local system where both inbound and outbound FTN NetMail will be stored. The only files placed in this directory should be FTN [[ref:fidonet_files# | ||
- | === Bad Packet === | + | Synchronet |
- | If SBBSecho cannot process an inbound packet file, it will rename the file, giving it a '' | + | |
- | == Identifying Bad Packets | + | SBBSecho will create '' |
- | | + | The other NetMail-related settings on this [[util: |
- | - Packet terminator ('' | + | |
- | - File read failure (e.g. permissions or file locking issue) | + | |
- | - Source address does not match expected address (e.g. for packets found in // | + | |
- | - Packet header cannot be parsed (e.g. is not a '' | + | |
- | - Packet header contains incorrect packet password | + | |
- | - Packet contains one or more " | + | |
- | ==== Bundle ==== | + | |
- | An FTN bundle is a single file archive of one or more (usually compressed) | + | === Default Origin Line === |
- | packets. Bundles will have file extensions where the first two characters | + | Standard |
- | represent | + | |
- | and SU) and the third character of the extension | + | |
- | first eight characters of the filename may be anything, but are usually | + | |
- | hexadecimal digits representing | + | |
- | the system that created the bundle. SBBSecho | + | |
- | inbound bundles | + | |
- | ==== AreaFix/ | + | It is possible to over-ride this default Origin Line for specific message areas (sub-boards), |
- | AreaFix is a synonym for area manager | + | === Inbound File Directory === |
- | program was called " | + | Older versions of SCFG (e.g. v3.16) contained this FidoNet setting which was used to specify |
- | of areas, changing compression type, etc) are built into SBBSecho, | + | |
- | no external area manager program is required. If you are not an FTN hub, then | + | |
- | the area manager portion | + | |
- | system. | + | |
- | ===== Installation | + | ==== EchoCfg |
- | + | ||
- | SBBSecho expects to find an area file (e.g. '' | + | |
- | directory. You will need to create the Area File in order for SBBSecho to do anything with EchoMail message areas. | + | |
- | + | ||
- | [[util: | + | |
- | You may want to import a network' | + | |
- | + | ||
- | ===== Area File Format ===== | + | |
- | + | ||
- | Each line of the SBBSecho Area File (e.g. '' | + | |
- | CODE TAG LINK [LINK] [...] | + | |
- | Where each field is separated by white-space (space or tab characters) and the fields are: | + | |
- | + | ||
- | ==== CODE ==== | + | |
- | The '' | + | |
- | + | ||
- | Internal codes consist of a combination of the Message Group' | + | |
- | + | ||
- | === Pass-through Areas === | + | |
- | Any unrecognized internal codes are considered // | + | |
- | + | ||
- | ==== TAG ==== | + | |
- | The '' | + | |
- | + | ||
- | === Long Tags === | + | |
- | Although standard FidoNet echo tags may be as long as 35 characters, Synchronet' | + | |
- | + | ||
- | === Bad Echo Area === | + | |
- | + | ||
- | If an area's '' | + | |
- | + | ||
- | ==== LINK ==== | + | |
- | Each '' | + | |
- | + | ||
- | Lines beginning with a semicolon (;) are considered comments, and are ignored. | + | |
- | ==== Area File Example ==== | + | |
- | + | ||
- | < | + | |
- | FIDO_SBBS SYNCHRONET 1: | + | |
- | FIDO_SYNCDATA SYNCDATA 1: | + | |
- | FIDO_SYNC_SYS SYNC_SYSOPS 1: | + | |
- | </ | + | |
- | + | ||
- | 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 ===== | + | |
- | + | ||
- | In order to set up SBBSecho for your system you must run the included '' | + | |
- | ==== Using echocfg | + | The SBBSecho Config program ('' |
=== Command-line Syntax === | === Command-line Syntax === | ||
Line 213: | Line 193: | ||
Multiple configuration files can be used (but isn't usually required) for | Multiple configuration files can be used (but isn't usually required) for | ||
multi-mailer systems. The default SBBSecho configuration filename is '' | multi-mailer systems. The default SBBSecho configuration filename is '' | ||
- | and located in your Synchronet '' | + | and located in your Synchronet '' |
the name and location of the configuration file on the '' | the name and location of the configuration file on the '' | ||
command lines if desired. | command lines if desired. | ||
- | If you do not specify a configuration file, '' | + | If you do not specify a configuration file, '' |
< | < | ||
Line 245: | Line 225: | ||
< | < | ||
╔═════════════════════════╗ | ╔═════════════════════════╗ | ||
- | ║ Configure | + | ║ Configure |
╠═════════════════════════╣ | ╠═════════════════════════╣ | ||
║ │Global Settings... | ║ │Global Settings... | ||
Line 253: | Line 233: | ||
║ │EchoMail Settings... | ║ │EchoMail Settings... | ||
║ │Paths and Filenames... ║ | ║ │Paths and Filenames... ║ | ||
+ | ║ │Domains... | ||
║ │EchoLists... | ║ │EchoLists... | ||
╚═════════════════════════╝ | ╚═════════════════════════╝ | ||
+ | |||
</ | </ | ||
- | ==== Saving Changes | + | === Saving Changes === |
When any unsaved changes have been made to the configuration, | When any unsaved changes have been made to the configuration, | ||
< | < | ||
Line 275: | Line 257: | ||
EchoCfg will normally automatically make a backup of an existing configuration file before over-writing it. For example, '' | EchoCfg will normally automatically make a backup of an existing configuration file before over-writing it. For example, '' | ||
- | ==== Global Settings | + | === Global Settings === |
< | < | ||
- | ╔══════════════════════════════════════════════╗ | + | ╔═══════════════════════════════════════════════════╗ |
- | ║ Global Settings | + | ║ Global Settings |
- | ╠══════════════════════════════════════════════╣ | + | ╠═══════════════════════════════════════════════════╣ |
- | ║ │Mailer Type | + | ║ │Mailer Type Binkley/ |
- | ║ │Log Level Informational | + | ║ │Log Level |
- | ║ │Log Timestamp Format | + | ║ │Log Timestamp Format |
- | ║ │Strict Packet Passwords | + | ║ │Strict Packet Passwords |
- | ║ │Use | + | ║ │Config File Backups |
- | ║ │BSY Mutex File Timeout | + | ║ │Minimum Free Disk Space 10G bytes ║ |
- | ║ │BSO Lock Attempt Delay 10 seconds | + | ║ │Strip Incoming Soft CRs No ║ |
- | ║ │BSO Lock Attempt Limit 60 ║ | + | ║ │Strip Outgoing Line Feeds No |
- | ║ │Config File Backups | + | ║ │Use |
- | ╚══════════════════════════════════════════════╝ | + | ║ │BSY Mutex File Timeout |
+ | ║ │BSO Lock Attempt Delay | ||
+ | ║ │BSO Lock Attempt Limit | ||
+ | ║ │BinkP Capabilities | ||
+ | ║ │BinkP Sysop Name | ||
+ | ║ │BinkP Authentication | ||
+ | ║ │BinkP Encryption | ||
+ | ╚═══════════════════════════════════════════════════╝ | ||
</ | </ | ||
=== Mailer Type === | === Mailer Type === | ||
Line 301: | Line 290: | ||
Selecting this menu item will toggle between the mailer types supported | Selecting this menu item will toggle between the mailer types supported | ||
by SBBSecho, either ArcMail/ | by SBBSecho, either ArcMail/ | ||
- | mailer type. | + | mailer type (e.g. [[module: |
- | === Log Level === | + | == Log Level == |
The //Log Level// menu option will allow you to determine the minimum severity of log entries that will be written to your SBBSecho log file (e.g. '' | The //Log Level// menu option will allow you to determine the minimum severity of log entries that will be written to your SBBSecho log file (e.g. '' | ||
Line 323: | Line 312: | ||
Log Level should normally be set to '' | Log Level should normally be set to '' | ||
experiencing problems with SBBSecho and would like more verbose log | experiencing problems with SBBSecho and would like more verbose log | ||
- | output, set this to Debugging. If you want less verbose logging, | + | output, set this to '' |
set to higher-severity levels to reduce the number of log messages. | set to higher-severity levels to reduce the number of log messages. | ||
- | === Log Timestamp Format | + | == Log Timestamp Format == |
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 '' | ||
- | === Strict Packet Passwords | + | == Strict Packet Passwords == |
Strict Packet Passwords, when enabled, requires that Packet Passwords | Strict Packet Passwords, when enabled, requires that Packet Passwords | ||
must match the password for the linked-node from which the packet | must match the password for the linked-node from which the packet | ||
Line 341: | Line 330: | ||
Default: Enabled | Default: Enabled | ||
- | === Use FTN Domain/Zone Map === | + | == BSY Mutex File Timeout == |
- | Use FTN Domain/Zone Map, when enabled, uses the configuration file | + | |
- | '' | + | |
- | and FTN zones and the relevant BSO outbound directory. | + | |
- | Default: Disabled | + | |
- | + | ||
- | === BSY Mutex File Timeout | + | |
BSY Mutex File Timeout determines the maximum age of an existing | BSY Mutex File Timeout determines the maximum age of an existing | ||
mutex file (*.bsy) before SBBSecho will act as though the mutex | mutex file (*.bsy) before SBBSecho will act as though the mutex | ||
Line 355: | Line 338: | ||
Default: 12 hours | Default: 12 hours | ||
- | === BSO Lock Attempt Delay === | + | == BSO Lock Attempt Delay == |
BSO Lock Attempt Delay determines the amount of time between BSO | BSO Lock Attempt Delay determines the amount of time between BSO | ||
node lock attempts (via *.bsy files in the relevant outbound | node lock attempts (via *.bsy files in the relevant outbound | ||
Line 361: | Line 344: | ||
Default: 10 seconds | Default: 10 seconds | ||
- | === BSO Lock Attempt Limit === | + | == BSO Lock Attempt Limit == |
BSO Lock Attempt Limit determines the maximum number of BSO node lock | BSO Lock Attempt Limit determines the maximum number of BSO node lock | ||
attempts before SBBSecho will give-up and move on to another node | attempts before SBBSecho will give-up and move on to another node | ||
Line 368: | Line 351: | ||
Default: 60 attempts | Default: 60 attempts | ||
- | === Config File Backups | + | == Config File Backups == |
Config File Backups determines the number of automatic backups of your | Config File Backups determines the number of automatic backups of your | ||
SBBSecho configuration file (e.g. '' | SBBSecho configuration file (e.g. '' | ||
maintained by SBBSecho Config and SBBSecho AreaFix. | maintained by SBBSecho Config and SBBSecho AreaFix. | ||
- | ==== Linked Nodes ==== | + | == BinkP Capabilities == |
+ | Set this value if you need to override the the text in the BinkP '' | ||
+ | |||
+ | == BinkP Sysop Name == | ||
+ | Set this value if you'd like to over-ride the BinkP Sysop Name ('' | ||
+ | |||
+ | === Linked Nodes === | ||
This menu item allows you to add, remove, and configure nodes that you | This menu item allows you to add, remove, and configure nodes that you | ||
will be sending mail to and accepting mail from. Selecting this option will bring you to | will be sending mail to and accepting mail from. Selecting this option will bring you to | ||
Line 389: | Line 378: | ||
add a new node, pressing the DELete key will remove the currently | add a new node, pressing the DELete key will remove the currently | ||
highlighted node. A //Node// here does not necessarily identify a single FidoNet node, but can also be used to identify a group of nodes by using the '' | highlighted node. A //Node// here does not necessarily identify a single FidoNet node, but can also be used to identify a group of nodes by using the '' | ||
+ | |||
+ | **Note:**\\ | ||
+ | The hexadecimal numbers in parentheses are provided as an aide when correlating FidoNet files and BSO directories with node numbers. | ||
< | < | ||
- | ╔═══════════════════════════════════╗ | + | ╔══════════════════════════════════════════════════╗ |
- | ║ Linked Nodes | + | ║ |
- | ╠═══════════════════════════════════╣ | + | ╠══════════════════════════════════════════════════╣ |
- | ║ │2:280/464 | + | ║ │ALL Everyone |
- | ║ │3: | + | ║ │21:ALL |
- | ║ │1:218/700 | + | ║ │1:218/700 (00da02bc) |
- | ║ │ALL | + | ║ │3: |
- | ║ │ | + | ║ │2: |
- | ╚═══════════════════════════════════╝ | + | ║ │1:124/5016 |
+ | ║ │1: | ||
+ | ║ │1: | ||
+ | ║ │1: | ||
+ | ║ │21: | ||
+ | ║ │ | ||
+ | ╚══════════════════════════════════════════════════╝ | ||
</ | </ | ||
- | Pressing ENTER on the currently | + | Pressing ENTER on a currently |
highlighted node will allow you to edit the settings for that particular | highlighted node will allow you to edit the settings for that particular | ||
node from a menu like the following (note that the node number you are | node from a menu like the following (note that the node number you are | ||
Line 408: | Line 406: | ||
< | < | ||
╔═════════════════════════════════════════════╗ | ╔═════════════════════════════════════════════╗ | ||
- | ║ Linked Node - Kurt Weiske | + | ║ |
╠═════════════════════════════════════════════╣ | ╠═════════════════════════════════════════════╣ | ||
║ │Address | ║ │Address | ||
- | ║ │Comment | + | ║ │Domain |
+ | ║ │Name | ||
+ | ║ │Comment | ||
║ │Archive Type | ║ │Archive Type | ||
║ │Packet Type 2+ ║ | ║ │Packet Type 2+ ║ | ||
║ │Packet Password | ║ │Packet Password | ||
+ | ║ │Session Password | ||
║ │TIC File Password | ║ │TIC File Password | ||
+ | ║ │AreaFix Support | ||
║ │AreaFix Password | ║ │AreaFix Password | ||
- | ║ │AreaFix | + | ║ │EchoList |
║ │Status | ║ │Status | ||
║ │Direct | ║ │Direct | ||
Line 423: | 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 | ||
║ │Outbox Directory | ║ │Outbox Directory | ||
+ | ║ │BinkP Settings... | ||
╚═════════════════════════════════════════════╝ | ╚═════════════════════════════════════════════╝ | ||
</ | </ | ||
- | === Address | + | == Address == |
This is the address of the node you are editing, selecting it | This is the address of the node you are editing, selecting it | ||
will allow you to change this to a different address. Using | will allow you to change this to a different address. Using | ||
Line 438: | Line 442: | ||
as '' | as '' | ||
- | === Comment | + | == Comment == |
Comment is a note to yourself about this node. Setting this to the | Comment is a note to yourself about this node. Setting this to the | ||
user or sysop name corresponding with the configured node can be | user or sysop name corresponding with the configured node can be | ||
a helpful reminder to yourself later. | a helpful reminder to yourself later. | ||
- | === Archive Type === | + | == Archive Type == |
Archive Type is the name of an archive type corresponding with one of | Archive Type is the name of an archive type corresponding with one of | ||
your configured archive types or ' | your configured archive types or ' | ||
Line 478: | Line 482: | ||
- | === Packet Type === | + | == Packet Type == |
- | This is the packet | + | This is the type of [[ref: |
packets for this node. The default packet type used by SBBSecho | packets for this node. The default packet type used by SBBSecho | ||
- | is 2+. If you are a " | + | is 2+. If you are a " |
- | should use either a type 2+ or 2.2 packet since type 2 packets | + | should use either a type 2+, 2e, or 2.2 packet since type 2 packets |
do not support point numbers. Selecting this option will allow | do not support point numbers. Selecting this option will allow | ||
you to choose from a menu of currently supported packet types: | you to choose from a menu of currently supported packet types: | ||
- | |||
< | < | ||
╔═════════════╗ | ╔═════════════╗ | ||
Line 497: | Line 500: | ||
</ | </ | ||
- | === Packet Password | + | == Packet Password == |
Packet Password is an optional password that may be added to outbound | Packet Password is an optional password that may be added to outbound | ||
packets for this node. Incoming packet passwords are compared with | packets for this node. Incoming packet passwords are compared with | ||
Line 505: | Line 508: | ||
This setting may be managed by the node using AreaFix requests. | This setting may be managed by the node using AreaFix requests. | ||
- | === TIC File Password | + | == Session Password == |
+ | When using [[module: | ||
+ | |||
+ | == TIC File Password == | ||
TIC File Password is an optional password that may be configured here | TIC File Password is an optional password that may be configured here | ||
(and in your sbbsecho.ini file) for use by ticket.js when creating | (and in your sbbsecho.ini file) for use by ticket.js when creating | ||
Line 511: | Line 517: | ||
This setting may be managed by the node using AreaFix requests. | This setting may be managed by the node using AreaFix requests. | ||
- | === AreaFix | + | == AreaFix Support |
- | AreaFix | + | Remote area management (via AreaFix |
- | NetMail | + | |
+ | == AreaFix Password | ||
+ | AreaFix | ||
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. | ||
- | === Areafix | + | == EchoList |
When echo lists have been defined (from the | When echo lists have been defined (from the | ||
' | ' | ||
which EchoLists can be used by this node when processing Area Manager add requests. | which EchoLists can be used by this node when processing Area Manager add requests. | ||
- | === Status | + | == Status == |
This option determines the netmail status that will be set | This option determines the netmail status that will be set | ||
when SBBSecho sends out an areafix message or a file attach. | when SBBSecho sends out an areafix message or a file attach. | ||
Line 528: | Line 536: | ||
status. | status. | ||
- | === Direct | + | == Direct == |
When set to '' | When set to '' | ||
to messages that SBBSecho sends out (or create DLO/DUT files | to messages that SBBSecho sends out (or create DLO/DUT files | ||
for FLO mailers). | for FLO mailers). | ||
- | === Passive | + | == Passive == |
Setting this option to ' | Setting this option to ' | ||
sent to this node without the need for altering the Area | sent to this node without the need for altering the Area | ||
Line 540: | Line 548: | ||
via an area manager request. | via an area manager request. | ||
- | === Send Notify List === | + | == Send Notify List == |
This determines whether or not this node is sent a Notify List | This determines whether or not this node is sent a Notify List | ||
when using that command line option in SBBSecho. | when using that command line option in SBBSecho. | ||
Line 547: | Line 555: | ||
areas. | areas. | ||
- | === Uplink for Message Groups | + | == Uplink for Message Groups == |
Uplink for Message Groups is an optional list of Message Groups (short | Uplink for Message Groups is an optional list of Message Groups (short | ||
names) for which this node is a hub/uplink for your system. | names) for which this node is a hub/uplink for your system. | ||
Line 553: | Line 561: | ||
to auto-link hubs with the newly added areas in your Area File. | to auto-link hubs with the newly added areas in your Area File. | ||
- | === Route To === | + | == Route To == |
When configured for Binkley/ | When configured for Binkley/ | ||
Attach-style mailers have their own routing configuration and that is why this option is not available in '' | Attach-style mailers have their own routing configuration and that is why this option is not available in '' | ||
- | === 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' |
- | === Outbox Directory | + | Note: [[module: |
- | Outbox Directory is only used in BSO operating mode and is an optional | + | |
+ | == Outbox Directory == | ||
+ | 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 are settings specific to BinkP/ | ||
+ | |||
+ | < | ||
+ | ╔═════════════════════════════════════╗ | ||
+ | ║ | ||
+ | ╠═════════════════════════════════════╣ | ||
+ | ║ │Host | ||
+ | ║ │Port | ||
+ | ║ │Poll | ||
+ | ║ │Authentication | ||
+ | ║ │Encryption | ||
+ | ║ │Source Address | ||
+ | ╚═════════════════════════════════════╝ | ||
+ | </ | ||
+ | |||
+ | **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 // | ||
+ | |||
+ | **Encryption** determines whether unencrypted data transfers will be supported or required when communicating with this linked node. With this setting set to '' | ||
+ | |||
+ | **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 === |
This option allows you to add or remove archive programs from SBBSecho. | This option allows you to add or remove archive programs from SBBSecho. | ||
Line 607: | Line 648: | ||
</ | </ | ||
- | === Archive Type === | + | == Archive Type == |
This is the identifying name of the archive file type. Usually this name | This is the identifying name of the archive file type. Usually this name | ||
corresponds with the common file extension or suffix denoting this type | corresponds with the common file extension or suffix denoting this type | ||
Line 617: | Line 658: | ||
remotely. | remotely. | ||
- | === Signature | + | == Signature == |
This is the identifying signature of the archive file format (in | This is the identifying signature of the archive file format (in | ||
hexadecimal notation). | hexadecimal notation). | ||
Line 623: | Line 664: | ||
program to extract (unarchive) inbound EchoMail bundle files. | program to extract (unarchive) inbound EchoMail bundle files. | ||
- | === Signature Offset | + | == Signature Offset == |
This is the byte-offset of the identifying signature of the archive file | This is the byte-offset of the identifying signature of the archive file | ||
format. | format. | ||
Line 629: | Line 670: | ||
(unarchive) inbound EchoMail bundle files. | (unarchive) inbound EchoMail bundle files. | ||
- | === Pack Command Line === | + | == Pack Command Line == |
This is the command-line to execute to create an archive file of the | This is the command-line to execute to create an archive file of the | ||
selected type. The following command-line specifiers may be used for | selected type. The following command-line specifiers may be used for | ||
Line 647: | Line 688: | ||
| '' | | '' | ||
- | === Unpack Command Line === | + | == Unpack Command Line == |
This is the command-line to execute to extract an archive file of the | This is the command-line to execute to extract an archive file of the | ||
selected type. | selected type. | ||
Line 656: | Line 697: | ||
- | ==== NetMail Settings | + | === NetMail Settings === |
< | < | ||
Line 669: | 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 674: | Line 716: | ||
╚════════════════════════════════════════════════╝ | ╚════════════════════════════════════════════════╝ | ||
</ | </ | ||
- | === Fuzzy Zone Operation | + | == Fuzzy Zone Operation == |
Some mail programs do not create netmail messages with zone | Some mail programs do not create netmail messages with zone | ||
information (INTL kludge line) or may only do so when sending | information (INTL kludge line) or may only do so when sending | ||
Line 684: | Line 726: | ||
address in netmail message. | address in netmail message. | ||
- | ==== EchoMail Settings | + | === EchoMail Settings === |
< | < | ||
╔═════════════════════════════════════════════════════════╗ | ╔═════════════════════════════════════════════════════════╗ | ||
Line 695: | 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 707: | Line 748: | ||
</ | </ | ||
- | === Area Manager | + | == Area Manager == |
This is the name or alias of the BBS user where notification of AreaFix | This is the name or alias of the BBS user where notification of AreaFix | ||
failures should be sent (default: '' | failures should be sent (default: '' | ||
Line 713: | Line 754: | ||
the like. Setting this option to a blank string will disable the notification feature. | the like. Setting this option to a blank string will disable the notification feature. | ||
- | === Maximum Packet Size === | + | == Maximum Packet Size == |
This menu item allows you to set the maximum size of each outgoing | This menu item allows you to set the maximum size of each outgoing | ||
echomail packet. | echomail packet. | ||
- | === Maximum Bundle Size === | + | == Maximum Bundle Size == |
Mail packets are normally packed into what are called " | Mail packets are normally packed into what are called " | ||
a node is set up to receive uncompressed mail packets). | a node is set up to receive uncompressed mail packets). | ||
allows you to specify the maximum size of each outgoing mail bundle. | allows you to specify the maximum size of each outgoing mail bundle. | ||
- | === Secure Operation | + | == Secure Operation == |
- | When set to '' | + | Secure Operation tells SBBSecho |
- | incoming mail packets | + | |
- | as messages are imported. If a packet password has been | + | |
- | defined for that node, it will also be compared | + | |
- | password contained in the mail packet. Packets and messages | + | |
- | failing | + | |
- | + | == Allow Nodes to Add Areas from Area File == | |
- | === Allow Nodes to Add Areas from Area File === | + | |
When set to '' | When set to '' | ||
(via area manager) which are listed in your Area File. | (via area manager) which are listed in your Area File. | ||
Line 738: | Line 773: | ||
access to. | access to. | ||
- | ==== Paths and Filenames | + | == 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 === | ||
This menu item allows you to configure the paths and filenames which are | This menu item allows you to configure the paths and filenames which are | ||
used by SBBSecho. | used by SBBSecho. | ||
Line 747: | Line 787: | ||
║ Paths and Filenames | ║ Paths and Filenames | ||
╠═══════════════════════════════════════════════════════╣ | ╠═══════════════════════════════════════════════════════╣ | ||
- | ║ │Non-secure Inbound Directory | + | ║ │Non-secure Inbound Directory |
- | ║ │Secure Inbound Directory | + | ║ │Secure Inbound Directory |
- | ║ │Outbound Directory | + | ║ │Outbound Directory |
║ │Area File ../ | ║ │Area File ../ | ||
║ │Bad Area File ../ | ║ │Bad Area File ../ | ||
Line 755: | Line 795: | ||
║ │Echo Statistics File | ║ │Echo Statistics File | ||
║ │Temporary File Directory | ║ │Temporary File Directory | ||
- | ║ │Outgoing Semaphore File ║ | + | ║ │Outgoing Semaphore File |
╚═══════════════════════════════════════════════════════╝ | ╚═══════════════════════════════════════════════════════╝ | ||
</ | </ | ||
- | === Non-secure Inbound Directory | + | == Non-secure Inbound Directory == |
This is the path where your FTN mailer stores, and where SBBSecho will | This is the path where your FTN mailer stores, and where SBBSecho will | ||
look for, incoming files (potentially including message bundles and | look for, incoming files (potentially including message bundles and | ||
Line 766: | Line 806: | ||
Default value is '' | Default value is '' | ||
- | === Secure Inbound Directory | + | == Secure Inbound Directory == |
This is the path where your FTN mailer stores, and where SBBSecho will | This is the path where your FTN mailer stores, and where SBBSecho will | ||
look for, incoming message bundles and packets for Secure (password | look for, incoming message bundles and packets for Secure (password | ||
Line 774: | Line 814: | ||
- | === Outbound Directory | + | == Outbound Directory == |
This is the path where your FTN mailer will look for, and where SBBSecho | This is the path where your FTN mailer will look for, and where SBBSecho | ||
will place, outgoing message bundles and packets. | will place, outgoing message bundles and packets. | ||
Line 783: | Line 823: | ||
Default value is '' | Default value is '' | ||
- | === Area File === | + | == Area File == |
This is the path and filename of the file that SBBSecho will | This is the path and filename of the file that SBBSecho will | ||
use as it's EchoMail Message Area File. By default SBBSecho looks for | use as it's EchoMail Message Area File. By default SBBSecho looks for | ||
the file '' | the file '' | ||
- | === Bad Area File === | + | == Bad Area File == |
This is the path of the file SBBSecho will use to record the names | This is the path of the file SBBSecho will use to record the names | ||
Line 801: | Line 841: | ||
* SBBSecho will automatically sort and maintain this list, removing areas if they are added to your configuration (SCFG-> | * SBBSecho will automatically sort and maintain this list, removing areas if they are added to your configuration (SCFG-> | ||
- | === Log File === | + | == Log File == |
This is the path of the file SBBSecho will use to log information each | This is the path of the file SBBSecho will use to log information each | ||
time it is run (default is '' | time it is run (default is '' | ||
- | === Echo Statistics File === | + | == Echo Statistics File == |
This is the path of the file SBBSecho will use to track statistics for | This is the path of the file SBBSecho will use to track statistics for | ||
EchoMail message areas (default is '' | EchoMail message areas (default is '' | ||
- | === Temporary File Directory | + | == Temporary File Directory == |
| | ||
This is the directory where SBBSecho will store temporary files that | This is the directory where SBBSecho will store temporary files that | ||
it creates and uses during its run-time (default is '' | it creates and uses during its run-time (default is '' | ||
- | === Outgoing Semaphore File === | + | == Outgoing Semaphore File == |
| | ||
This is an optional file to create/ | This is an optional file to create/ | ||
- | files created or updated by SBBSecho. | + | files created or updated by SBBSecho. |
- | ==== EchoLists | + | === Domains |
+ | |||
+ | Here you can configure the so-called "5th dimension" | ||
+ | |||
+ | These are the domain-> | ||
+ | |||
+ | < | ||
+ | ╔══════════════════════╗ | ||
+ | ║ Domains | ||
+ | ╠══════════════════════╣ | ||
+ | ║ │fidonet | ||
+ | ║ │fsxnet | ||
+ | ║ │ ║ | ||
+ | ╚══════════════════════╝ | ||
+ | </ | ||
+ | |||
+ | Selecting a node to configure will display a dialog like the following: | ||
+ | < | ||
+ | ╔══════════════════════════════════════════════════════╗ | ||
+ | ║ | ||
+ | ╠══════════════════════════════════════════════════════╣ | ||
+ | ║ │Name | ||
+ | ║ │Zones | ||
+ | ║ │DNS Suffix | ||
+ | ║ │Outbound Root ../ | ||
+ | ║ │NodeList | ||
+ | ╚══════════════════════════════════════════════════════╝ | ||
+ | </ | ||
+ | |||
+ | === EchoLists | ||
This menu item allows you to add and remove additional echo lists which | This menu item allows you to add and remove additional echo lists which | ||
can be used by SBBSecho for area manager add requests. Normally these | can be used by SBBSecho for area manager add requests. Normally these | ||
Line 856: | Line 925: | ||
</ | </ | ||
- | === EchoList Path/ | + | == EchoList Path/Name == |
This is the full path and filename of the echo list you are | This is the full path and filename of the echo list you are | ||
defining. | defining. | ||
Line 862: | Line 931: | ||
at least one space. | at least one space. | ||
- | === Hub Address | + | == Hub Address == |
This is the address of the hub of the conferences contained | This is the address of the hub of the conferences contained | ||
in this list. If an area is remotely added from this list | in this list. If an area is remotely added from this list | ||
(using Areafix) this address is automatically added to the | (using Areafix) this address is automatically added to the | ||
- | AREAS.BBS file. | + | Area File. |
- | === Forward Password | + | == Forward Password == |
This is the area manager password to use when forwarding | This is the area manager password to use when forwarding | ||
requests. | requests. | ||
- | === Forward Requests | + | == Forward Requests == |
Setting this option to ' | Setting this option to ' | ||
request to the Hub Address specified to turn on an area from | request to the Hub Address specified to turn on an area from | ||
this list. This happens when users remotely add areas using | this list. This happens when users remotely add areas using | ||
- | Areafix | + | AreaFix |
- | conferences in this list (i.e.: from Planet Connect). | + | conferences in this list. |
- | === 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 flags are defined | ||
Line 891: | Line 960: | ||
==== Environment Variable ==== | ==== Environment Variable ==== | ||
SBBSecho requires that the system '' | SBBSecho requires that the system '' | ||
+ | |||
==== 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 958: | 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 |