moon
/
enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

TIC attachment doc updates

This commit is contained in:
Bryan Ashby 2023-09-03 11:01:43 -06:00
parent 97ae34a971
commit f4a90900ae
1 changed files with 40 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/_docs/filebase/tic-support.md
View File

@ -3,7 +3,7 @@ layout: page
title: TIC Support title: TIC Support
--- ---
## TIC Support ## TIC Support
ENiGMA½ supports FidoNet-Style TIC file attachments by mapping TIC areas to local file areas. ENiGMA½ supports FidoNet-Style TIC file attachments by mapping external TIC area tags to local file areas.
Under a given node defined in the `ftn_bso` config section in `config.hjson` (see Under a given node defined in the `ftn_bso` config section in `config.hjson` (see
[BSO Import/Export](../messageareas/bso-import-export.md)), TIC configuration may be supplied: [BSO Import/Export](../messageareas/bso-import-export.md)), TIC configuration may be supplied:
@ -17,9 +17,9 @@ Under a given node defined in the `ftn_bso` config section in `config.hjson` (se
packetPassword: mypass packetPassword: mypass
encoding: cp437 encoding: cp437
archiveType: zip archiveType: zip
tic: { tic: { // <--- General TIC config for 46:*
password: TESTY-TEST password: TESTY-TEST
uploadBy: Agoranet TIC uploadBy: AgoraNet TIC
allowReplace: true allowReplace: true
} }
} }
@ -29,7 +29,15 @@ Under a given node defined in the `ftn_bso` config section in `config.hjson` (se
} }
``` ```
You then need to configure the mapping between TIC areas you want to carry, and the file base area and storage tag for them to be tossed to. Optionally you can also add hashtags to the tossed files to assist users in searching for files: Valid `tic` members:
| Item | Required | Description |
|--------|---------------|------------------|
| `password` | :-1: | TIC packet password, if required |
| `uploadedBy` | :-1: | Sets the "uploaded by" field for TIC attachments, for example "AgoraNet TIC" |
| `allowReplace` | :-1: | Set to `true` to allow TIC attachments to replace each other. This is especially handy for things like weekly node list attachments |
Next, we need to configure the mapping between TIC areas you want to carry, and the file base area (and, optionally, specific storage tag) for them to be tossed to. You can also add hashtags to the tossed files to assist users in searching for files:
```hjson ```hjson
ticAreas: { ticAreas: {
@ -41,10 +49,22 @@ ticAreas: {
} }
``` ```
Multiple TIC areas can be mapped to a single file base area.
> :information_source: Note that in the example above `agn_node` represents the **external** network area tag, usually represented in all caps. In this case, `AGN_NODE`.
Valid `ticAreas` members under a given node mapping are as follows:
| Item | Required | Description |
|--------|---------------|------------------|
| `areaTag` | :+1: | Specifies the local areaTag in which to place TIC attachments |
| `storageTag` | :-1: | Optionally, set a specific storageTag. If not set, the default for this area will be used. |
| `hashTags` | :-1: | One or more optional hash tags to assign TIC attachments in this area. |
💡 Multiple TIC areas can be mapped to a single file base area.
### Example Configuration ### Example Configuration
An example configuration linking file base areas, FTN BSO node configuration and TIC area configuration. Example configuration fragments mapping file base areas, FTN BSO node configuration and TIC area configuration.
```hjson ```hjson
fileBase: { fileBase: {
@ -79,11 +99,9 @@ scannerTossers: {
} }
} }
} }
}
}
ticAreas: { ticAreas: {
// here we map AgoraNet AGN_NODE -> local msgNetworks file area
agn_node: { agn_node: {
areaTag: msgNetworks areaTag: msgNetworks
storageTag: msg_network storageTag: msg_network
@ -95,6 +113,10 @@ ticAreas: {
hashTags: agoranet,infopack hashTags: agoranet,infopack
} }
} }
}
}
``` ```
## See Also ## See Also