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

More doc tidy

This commit is contained in:
Bryan Ashby 2020-05-14 21:20:27 -06:00
parent 82a1e22e42
commit b3abe3ad40
3 changed files with 24 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/filebase/index.md
View File

@ -20,3 +20,9 @@ ENiGMA½ has strayed away from the old familiar setup here and instead takes a m
* Duplicates are checked for by cryptographically secure [SHA-256](https://en.wikipedia.org/wiki/SHA-2) hashes.
* Support for many archive and file formats. External utilities can easily be added to the configuration to extend for additional formats.
* Much, much more!
### Modding
The default ENiGMA½ approach for file areas may not be for everyone. Remember that you can mod everything your setup! Some inspirational examples:
* A more traditional set of areas and scrolling file listings.
* An S/X style integration of message areas and file areas.
* Something completely different! Some tweaks are possible without any code while others may require creating new JavaScript modules to use instead of the defaults.

31
docs/filebase/tic-support.md
View File

@ -2,9 +2,10 @@
layout: page
title: TIC Support
---
ENiGMA½ supports TIC files. This is handled by mapping TIC areas to local file areas.
## TIC Support
ENiGMA½ supports FidoNet-Style TIC file attachments by mapping TIC areas 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)), TIC configuration may be supplied:
```hjson
@ -28,11 +29,9 @@ 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:
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:
````hjson
```hjson
ticAreas: {
agn_node: {
areaTag: msgNetworks
@ -41,21 +40,20 @@ ticAreas: {
}
}
````
Multiple TIC areas can be mapped to a single file base 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.
An example configuration linking filebase areas, FTN BSO node configuration and TIC area configuration.
````hjson
```hjson
fileBase: {
areaStoragePrefix: /home/bbs/file_areas/
storageTags: {
msg_network: "msg_network"
}
areas: {
msgNetworks: {
name: Message Networks
@ -97,4 +95,7 @@ ticAreas: {
hashTags: agoranet,infopack
}
}
````
```
## See Also
[Message Networks](/docs/messageareas/message-networks.md)

4
docs/filebase/uploads.md
View File

@ -3,9 +3,9 @@ layout: page
title: Uploads
---
## Uploads
The default ACS for file areas areas in ENiGMA½ is to allow read (viewing of the area), and downloads for users while only permitting SysOps to write (upload). See [File Base ACS](acs.md) for more information.
The default ACS for file areas in ENiGMA½ is to allow regular users 'read' and sysops 'read/write'. Read ACS includes listing and downloading while write allows for uploading. See [File Base ACS](acs.md) for more information.
To allow uploads to a particular area, change the ACS level for `write`. For example:
To change ACS for a particular area, create an `acs` block specifying ACS for `read` and/or `write`. For example, let's allow regular users (in the "users" group) to upload to an area:
```hjson
uploads: {
name: Uploads