zydronium/enigma-bbs
1
0
Fork 0
mirror of https://github.com/NuSkooler/enigma-bbs.git synced 2025-06-11 07:04:32 +02:00
Code Issues Projects Releases Packages Wiki Activity

Documentation updates

Browse source 
+ Add File Transfer Protocols section
* Minor updates
This commit is contained in:
Bryan Ashby 2018-02-03 23:03:50 -07:00
parent aa274bb354
commit 1f29905f30
3 changed files with 54 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/filebase/first-file-area.md
View file

@ -3,13 +3,13 @@ layout: page
title: Configuring a File Base
---
## ENiGMA½ File Base Key Concepts
Like many things in ENiGMA½, configuration of file base(s) is handled via `config.hjson` -- specifically
in the `fileBase` section. First, there are a couple of concepts you should understand.
Like many things in ENiGMA½, configuration of file base(s) is handled via `config.hjson` — specifically
in the `fileBase` section. First, there are a couple of concepts you should understand:
### Storage tags
**Storage Tags** define paths to a physical (file) storage locations that are referenced in a
**Storage Tags** define paths to physical (file) storage locations that are referenced in a
file *Area* entry. Each entry may be either a fully qualified path or a relative path. Relative paths
are relative to the value set by the `areaStoragePrefix` key (defaults to `<enigma_install_dir/file_base`).
Below is an example defining a both a relative and fully qualified path each attached to a storage tag:
@ -22,8 +22,7 @@ storageTags: {
}
```
Note that on their own, storage tags don't do anything - they are simply pointers to storage locations on
your system.
Note that on their own, storage tags don't do anything — they are simply pointers to storage locations on your system.
### Areas