More doc updates
This commit is contained in:
Bryan Ashby
parent
f56e30442a
commit
ec994211e0
|
|
@ -291,17 +291,32 @@ Actions:
|
|||
|
||||
import-areas PATH Import areas using FidoNet *.NA or AREAS.BBS file
|
||||
|
||||
qwk-dump PATH Dumps a QWK packet to stdout.
|
||||
qwk-export [AREA_TAGS] PATH Exports one or more configured message area to a QWK
|
||||
packet in the directory specified by PATH. The QWK
|
||||
BBS ID will be obtained by the final component of PATH.
|
||||
|
||||
import-areas arguments:
|
||||
--conf CONF_TAG Conference tag in which to import areas
|
||||
--network NETWORK Network name/key to associate FTN areas
|
||||
--uplinks UL1,UL2,... One or more uplinks (comma separated)
|
||||
--type TYPE Area import type
|
||||
|
||||
Valid types are "bbs" and "na"
|
||||
Valid types are "bbs" and "na".
|
||||
|
||||
qwk-export arguments:
|
||||
--user USER User in which to export for. Defaults to the SysOp.
|
||||
--after TIMESTAMP Export only messages with a timestamp later than
|
||||
TIMESTAMP.
|
||||
--no-qwke Disable QWKE extensions.
|
||||
--no-synchronet Disable Synchronet style extensions.
|
||||
```
|
||||
|
||||
| Action | Description | Examples |
|
||||
|-----------|-------------------|---------------------------------------|
|
||||
| `import-areas` | Imports areas using a FidoNet style *.NA or AREAS.BBS formatted file. Optionally maps areas to FTN networks. | `./oputil.js config import-areas /some/path/l33tnet.na` |
|
||||
| `areafix` | Utility for sending AreaFix mails without logging into the system | |
|
||||
| `qwk-dump` | Dump a QWK packet to stdout | `./oputil.js mb qwk-dump /path/to/XIBALBA.QWK` |
|
||||
| `qwk-export` | Export messages to a QWK packet | `./oputil.js mb qwk-export /path/to/XIBALBA.QWK` |
|
||||
|
||||
When using the `import-areas` action, you will be prompted for any missing additional arguments described in "import-areas args".
|
||||
|
|
|
|||
|
|
@ -4,14 +4,14 @@ title: FidoNet-Style Networks (FTN)
|
|||
---
|
||||
|
||||
## FidoNet-Style Networks (FTN)
|
||||
|
||||
TODO: preamble
|
||||
[FidoNet](https://en.wikipedia.org/wiki/FidoNet) proper and other FidoNet-Style networks are supported by ENiGMA½. A bit of configuration and you'll be up and running in no time!
|
||||
|
||||
### Configuration
|
||||
Getting a fully running FTN enabled system requires a few configuration points:
|
||||
|
||||
1. `messageNetworks.ftn.networks`: declares available networks.
|
||||
2. `messageNetworks.ftn.areas`: establishes local area mappings and per-area specifics.
|
||||
3. `scannerTossers.ftn_bso`: general configuration for the scanner/tosser (import/export). This is also where we configure per-node settings.
|
||||
1. `messageNetworks.ftn.networks`: Declares available networks. That is, networks you wish to sync up with.
|
||||
2. `messageNetworks.ftn.areas`: Establishes local area mappings (ENiGMA½ to/from FTN area tags) and per-area specific configurations.
|
||||
3. `scannerTossers.ftn_bso`: General configuration for the scanner/tosser (import/export) process. This is also where we configure per-node (uplink) settings.
|
||||
|
||||
:information_source: ENiGMA½'s `ftn_bso` module is **not a mailer** and makes **no attempts** to perform packet transport! An external utility such as Binkd is required for this task.
|
||||
|
||||
|
|
|
|||
|
|
@ -3,18 +3,17 @@ layout: page
|
|||
title: Message Networks
|
||||
---
|
||||
## Message Networks
|
||||
ENiGMA½ considers all non-ENiGMA½, non-local messages (and their networks, such as FidoNet-Style (FTN) "external". That is, messages are only imported and exported from/to such a networks. Configuring such external message networks in ENiGMA½ requires three sections in your `config.hjson`.
|
||||
ENiGMA½ supports external networks such as FidoNet-Style (FTN) and QWK by the way of importing and exporting to/from it's own internal format. This allows for a very flexible system that can easily be extended by creating new network modules.
|
||||
|
||||
All message network configuration occurs under the `messageNetworks.<name>` block in `config.hjson` (where name is something such as `ftn` or `qwk`). Similarly, if a scanner/tosser module exists for the network it can be configured under `scannerTossers.<name>`. An example of this is the [FTN/BSO scanner/tosser](bso-import-export.md) module where name is `ftn_bso`.
|
||||
|
||||
The most basic of external message network configurations generally comprises of two sections within `config.hjson`:
|
||||
All message network configuration occurs under the `messageNetworks.<name>` block in `config.hjson` (where name is something such as `ftn` or `qwk`). The most basic of external message network configurations generally comprises of two sections:
|
||||
|
||||
1. `messageNetworks.<name>.networks`: Global/general configuration for a particular network where `<name>` is for example `ftn` or `qwk`.
|
||||
2. `messageNetworks.<name>.areas`: Provides mapping of ENiGMA½ **area tags** to their external counterparts.
|
||||
|
||||
Finally, a related section under `scannerTossers.<name>` may provide configuration for scanning (importing) and tossing (exporting) messages for a particular network type. As an example, FidoNet-Style networks often work with BinkleyTerm Style Outbound (BSO) and thus the [FTN/BSO scanner/tosser](bso-import-export.md) module.
|
||||
:information_source: A related section under `scannerTossers.<name>` may provide configuration for scanning (importing) and tossing (exporting) messages for a particular network type. As an example, FidoNet-Style networks often work with BinkleyTerm Style Outbound (BSO) and thus the [FTN/BSO scanner/tosser](bso-import-export.md) (`ftn_bso`) module.
|
||||
|
||||
### Supported Networks
|
||||
### Currently Supported Networks
|
||||
The following networks are supported out of the box. Remember that you can create modules to add others if desired!
|
||||
|
||||
#### FidoNet-Style (FTN)
|
||||
FidoNet and FidoNet style (FTN) networks as well as a [FTN/BSO scanner/tosser](bso-import-export.md) (`ftn_bso` module) are configured via the `messageNetworks.ftn` and `scannerTossers.ftn_bso` blocks in `config.hjson`.
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: QWK Support
|
|||
---
|
||||
|
||||
## QWK and QWK-Net Style Networks
|
||||
As like all other such as FidoNet-Style (FTN) networks, ENiGMA½ considers QWK external to the system but can import and export the format.
|
||||
As like all other networks such as FidoNet-Style (FTN) networks, ENiGMA½ considers QWK external to the system but can import and export the format.
|
||||
|
||||
### Supported Standards
|
||||
QWK must be considered a semi-standard as there are many implementations. What follows is a short & incomplete list of such standards ENiGMA½ supports:
|
||||
|
|
@ -18,8 +18,6 @@ QWK configuration occurs in the `messageNetworks.qwk` config block of `config.hj
|
|||
|
||||
:information_source: During a regular, non QWK-Net exports, conference numbers can be auto-generated. Note that for QWK-Net style networks, you will need to create mappings however.
|
||||
|
||||
:TODO: information on QWK-Net type setup here
|
||||
|
||||
Example:
|
||||
```hjson
|
||||
{
|
||||
|
|
@ -36,13 +34,10 @@ Example:
|
|||
```
|
||||
|
||||
### oputil
|
||||
The `oputil.js` utility can export packet files, dump the messages of a packet to stdout, etc.
|
||||
|
||||
TODO: Examples, etc.
|
||||
TODO: Link to oputil, update --help there.
|
||||
The `oputil.js` utility can export packet files, dump the messages of a packet to stdout, etc. See [the oputil documentation](/docs/admin/oputil.md) for more information.
|
||||
|
||||
### Offline Readers
|
||||
A few of the offline readers that have been tested with QWK packet files produced by ENiGMA:
|
||||
A few of the offline readers that have been tested with QWK packet files produced by ENiGMA½:
|
||||
|
||||
| Software | Status | Notes |
|
||||
|----------|--------|-------|
|
||||
|
|
|
|||
Loading…
Reference in New Issue