From e1862e6916af70a478c734549ebc4504af9a045a Mon Sep 17 00:00:00 2001 From: Bryan Ashby Date: Tue, 27 Nov 2018 23:22:09 -0700 Subject: [PATCH] Improve ACS & uploads docs around FB --- docs/filebase/acs.md | 16 +++++++++++----- docs/filebase/uploads.md | 21 +++++++++++++++++++-- 2 files changed, 30 insertions(+), 7 deletions(-) diff --git a/docs/filebase/acs.md b/docs/filebase/acs.md index 63884c71..618c1843 100644 --- a/docs/filebase/acs.md +++ b/docs/filebase/acs.md @@ -3,9 +3,10 @@ layout: page title: ACS --- ## File Base ACS -[ACS Codes](/docs/configuration/acs.md) may be used to control acess to File Base areas by specifying an `acs` string in a file area's definition. If no `acs` is supplied in a file area definition, the following defaults apply to an area: -* `read` (list, download, etc.): `GM[users]` -* `write` (upload): `GM[sysops]` +[ACS Codes](/docs/configuration/acs.md) may be used to control access to File Base areas by specifying an `acs` string in a file area's definition. If no `acs` is supplied in a file area definition, the following defaults apply to an area: +* `read` : `GM[users]`: List/view the area and it's contents. +* `write` : `GM[sysops]`: Upload. +* `download` : `GM[users]`: Download. To override read and/or write ACS, supply a valid `acs` member. @@ -18,8 +19,13 @@ areas: { desc: Oldschool PC/DOS storageTags: [ "retro_pc", "retro_pc_bbs" ] acs: { - write: GM[users] + // only users of the "l33t" group or those who have + // uploaded 10+ files can download from here... + download: GM[l33t]|UP10 } } } -``` \ No newline at end of file +``` + +## See Also +[Access Condition System (ACS)](/docs/configuration/acs.md) diff --git a/docs/filebase/uploads.md b/docs/filebase/uploads.md index 4b1e9c38..8e1e2530 100644 --- a/docs/filebase/uploads.md +++ b/docs/filebase/uploads.md @@ -2,7 +2,24 @@ 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. -Note that `storageTags` may contain *1:n* storage tag references. +To allow uploads to a particular area, change the ACS level for `write`. For example: +```hjson +uploads: { + name: Uploads + desc: User Uploads + storageTags: [ + "uploads" + ] + acs: { + write: GM[users] + } +} +```` + +:information_source: Remember that uploads in a particular area are stored **using the first storage tag defined in that area.** + +:information_source: Any ACS checks are allowed. See [ACS](/docs/acs.md) -**Uploads in a particular area are stored in the first storage tag defined in an area.**