Add-on Documentation from JCOGS Design

Control Panel ConfigurationLast updated: 6 August 2026

The SFS Access Control Panel is arranged as a practical working sequence. The sidebar labels are designed to match the main setup and support tasks you will carry out.

Main SFS Access panels

  • Eligibility Pools - define groups of members who can be considered for assignment to secure areas.
  • Secure Areas (Enclaves) - define named secure file areas linked to above-webroot upload locations.
  • Memberships - assign members to secure areas.
  • Role Permissions - decide what each role is allowed to do in a secure area.
  • Access Check - verify what one member can currently do in one secure area.
  • Security Activity Log - review governance actions and denial reasons for audit and troubleshooting.
  • Global Settings - configure Secure Root and related global behaviour when required.

Recommended first-time setup order

  1. If you need to change Secure Root behaviour, review Global Settings first. If the default Secure Root is suitable, you may not need to change anything.
  2. Create eligibility pools first.
  3. Create secure areas and link them to the correct pools.
  4. Assign memberships.
  5. Set role permissions.
  6. Use Access Check to confirm expected outcomes.
  7. Review Security Activity Log after first live tests.

Design note

Eligibility pools do two useful jobs: they limit which members can normally be assigned to a secure area, and they make assignments easier by giving administrators a smaller relevant list to work from. If a member is later removed from a pool, that should be treated as a prompt to review their existing secure-area memberships.

OTP note

SFS Access works on its own. If you add the OTP Pro companion, selected higher-security changes can require an extra verification step before they are applied.

Companion panels for SFS Vault and SFS Gateway appear when those add-ons are installed. Companion-sensitive actions may be hidden until companion prerequisites are healthy.

Settings Overview

SFS Access includes a Global Settings panel for managing the Secure Root and checking that secure file storage is ready to use.

What to configure in Settings

  • secure_root_path - the filesystem base path used for secure storage operations.
  • create_if_missing_flag - whether SFS Access should create the Secure Root directory automatically if it does not already exist.
  • enforcement mode - how strictly SFS enforces health and readiness checks for secure location flows.

You do not always need to change these settings. Many sites can start with the default Secure Root behaviour and only revisit Global Settings if storage location, permissions, or health checks need attention.

Access on its own

SFS Access can be used without Vault or Gateway. Global Settings are still relevant because Secure Root health affects secure storage behaviour either way.

OTP note

OTP Pro is an optional companion. If it is installed, selected higher-security changes can require an extra verification step before they are saved.

Enclave Creation and Management

To create a secure area, first identify the above-webroot upload location where the files should live. Then define that location as an enclave by giving it a clear name.

A simple way to set up a secure area

  1. Choose the above-webroot upload location you want to use.
  2. Create the secure area and give it a name that will still make sense later.
  3. If useful, attach one or more eligibility pools to limit which members can be assigned access.
  4. Save the secure area and then move on to memberships and role permissions.

Naming guidance

  • Use names that describe the files or business purpose.
  • Avoid temporary project shorthand that may become unclear later.
  • Keep naming consistent across similar secure areas.

Design note

Good secure-area design makes later administration simpler. Clear names and sensible boundaries reduce confusion when assigning access, reviewing permissions, or responding to incidents.

Role-Based Permissions

Role Permissions is where you decide what a member can do after they have been assigned to a secure area.

In the sidebar, Memberships appears before Role Permissions, but many administrators will review both together: first decide who needs access, then decide exactly what each role is allowed to do.

Operation catalogue

  • file_list - see the files in the secure area
  • file_upload - add files to the secure area
  • file_download - download files from the secure area
  • file_delete - remove files from the secure area
  • membership_manage - change who has access to the secure area
  • policy_manage - change role permissions for the secure area
  • enclave_lockdown - apply emergency restrictions to the secure area
  • token_issue - issue a Vault token
  • token_revoke - revoke a Vault token
  • external_share_create - create a Gateway external share
  • external_share_revoke - revoke a Gateway external share

Default system role model

Role Default permissions
Viewer file_list, file_download
Contributor file_list, file_upload, file_download, token_issue, external_share_create
Enclave Admin All listed operations

Companion note

SFS Access works on its own for core file operations. Some Vault and Gateway actions only appear when the related companions are available.

Set permissions carefully and use Access Check after any role change so you can confirm the real outcome before live use.

Membership Assignment and Access Scope

Memberships is where you assign people to secure areas.

In the sidebar, Memberships appears before Role Permissions. In practice, this means you first decide who should have access, then decide exactly what their assigned roles allow them to do.

An eligibility pool helps limit who can normally be assigned to a secure area. Memberships then decide which of those people actually receive access.

How access scope is decided

  1. The member should be in scope through the relevant eligibility pool.
  2. The member must have an active enclave membership.
  3. The assigned role must allow the requested operation.

OTP companion note

SFS Access works without OTP Pro. If OTP Pro is installed, some higher-security membership changes can require an extra verification step before the change is applied.

Good governance practice

  • Assign access according to named responsibilities, not convenience.
  • Removing access promptly when roles change.
  • Revalidating access scope during periodic reviews.

This keeps policy intent aligned with real team structure and reduces hidden over-permissioning.

Lockdown and Restriction Controls

Lockdown controls are used when a secure area needs to be restricted quickly, for example during a suspected security incident or urgent review.

What lockdown does in practice

  • Marks the secure area as locked.
  • Prevents normal access until the secure area is unlocked again.
  • Gives administrators a fast way to contain a problem while they investigate.

OTP companion note

SFS Access works without OTP Pro. If OTP Pro is installed, lock and unlock actions can require an extra verification step before they are applied.

Recommended incident pattern

  1. Lock the secure area to contain risk.
  2. Confirm the result using Access Check.
  3. Review Security Activity Log for impacted operations.
  4. Apply remediation and policy corrections.
  5. Unlock only when the problem has been dealt with.

Use a simple internal runbook so administrators know when to trigger lockdown, what user impact to expect, and when restoration is appropriate.

Settings and Secure Root Management

SFS Access includes a Global Settings page for Secure Root management. If you are using SFS Access on its own, this is where you manage Secure Root behaviour directly.

When this page matters

If you are using the default Secure Root and it works as expected, you may not need to spend much time here. If you need to change the storage path or fix health issues, this is the place to do it.

Key settings

  • secure_root_path - absolute filesystem path used as secure root anchor.
  • create_if_missing_flag - allows SFS Access to create the Secure Root directory automatically if it does not already exist.
  • enforcement_mode - monitor or enforce behaviour for health checks and operational strictness.

Simple configuration sequence

  1. Set secure_root_path to the intended secure root location.
  2. Set create_if_missing_flag according to your operational policy.
  3. Choose enforcement mode for your rollout stage.
  4. Save settings and run health validation.
  5. Only proceed with secure location creation when health status is acceptable.

Health outcomes and action

  • If health is good, continue with enclave and location workflows.
  • If health fails, resolve the reported reason before retrying location creation flows.
  • If settings save but health fails, treat the save as incomplete from an operations point of view.

Operational note

Secure Root settings affect readiness for secure location workflows even in standalone Access mode. Validate health before running first live tests.

Vault convenience note

If you later add SFS Vault, it uses the same Secure Root foundation. That means moving from Access on its own to Access with Vault can involve less configuration change than starting again with a different storage model.

Effective Access Check

Access Check shows what one member can currently do in one secure area.

This is useful when you want to confirm whether a user should be able to see files, upload files, download files, or carry out other actions before you ask them to test it themselves.

It is also useful when something does not behave as expected and you need a quick way to see what SFS Access is currently allowing or blocking.

Inputs

  • Select an enclave.
  • Select a member.
  • Run the check to produce operation decisions.

Output model

The result shows each operation with:

  • whether it is allowed or denied
  • a reason code
  • technical source detail

How to use reason codes

  • Use reason codes as the starting point for troubleshooting.
  • Cross-check the same reason in Security Activity Log events.
  • Re-run checks after each corrective change to confirm outcome drift is resolved.

Typical use cases

  1. Validate a new role-permission design before rollout.
  2. Confirm membership assignment gives expected scope.
  3. Confirm lockdown behaviour during incident containment.
  4. Validate companion-sensitive operation visibility after OTP or companion changes.