Getting Started Cameras & Video Detection & Recording Automation & Events Actions Integration & Connectivity Network & Discovery AI & Remote Control MQTT Modbus ZeroMQ System & Administration Comparisons Use Cases Troubleshooting About & Legal
Home / Documentation / File Storage
Knowledge base

File Storage

File Storage manages repository folders for recordings, snapshots, uploaded files, cleanup policies, backup moves, and browser-side file access.

Choose a repository for recordings and media

In Banalytics, file storage provides the repository where recorded video files, snapshots, and other media assets are saved. Motion-activated video recording, continuous recording, event snapshots, backups, and other tasks depend on it to persist media.

Although file storage often resides on the same machine as the Banalytics server, it can also point to remote or networked drives, which gives you flexibility when scaling storage or backing up data.

File Storage submenu in Banalytics
01

Open the File Storage sub-menu

In the Banalytics server view, find the File storage section in the left panel and click the plus button to add a new storage instance.

02

Select the target folder

Choose the folder where Banalytics should store recordings, snapshots, uploaded files, or other media assets. You can create separate folders for continuous recording, motion recording, camera groups, dates, or evidence workflows.

03

Set access and retention rules

Choose whether the storage is Read only, writable, or managed with delete permissions. Add cleanup limits only when Banalytics is allowed to delete or move old files.

Configuration parameters

ParameterRequiredDescriptionDefault
ID
YesA unique, automatically generated identifier for this component instance. This value is not editable.Auto
Restart on failure
YesRestart mode after an error:
  • Stop on failure - not restarted until triggered manually.
  • Immediately - tries to restart automatically immediately after an error.
  • 10 sec - tries to restart automatically with a 10-second delay.
  • 30 sec - tries to restart automatically with a 30-second delay.
  • 1 min - tries to restart automatically with a 1-minute delay.
10 sec
Title
YesName of the file storage. A folder with the specified title will be created in the selected path, so choose a title that describes the type of content stored there, for example Motion recording or Continuous recording.None
File storage provider
YesLocal file system reference. Currently this is the supported file storage provider.None
Path
YesPath to the target folder in the selected file storage provider. Right-click in the folder picker to add or delete folders.Folder picker for File Storage pathNone
List order
YesFile ordering strategy used by the browser UI. Use descending natural order when users usually need the newest recordings first.Desc
Access mode
YesDefines permitted operations:
  • Read only. Allows users to browse and play files from the storage without adding, moving, or deleting them.
  • Read / Write. Allows tasks and users to add video files or other assets while still preventing cleanup based on deletion.
  • Read / Write / Delete. Enables cleanup workflows and manual delete/move scenarios. Use this mode when Banalytics must manage storage capacity by size, time, or object count.
Read / Write
Limit by
OptionalDefines the storage capacity limit. It is used for storages that allow deletion-based cleanup:
  • No limits - files are recorded until the storage reaches physical capacity.
  • By total size (MB) - keeps storage within the configured size in megabytes.
  • By Time (Hours) - removes files older than the configured number of hours.
  • By objects count - keeps only the configured number of newest files.
None
Clean up period
YesFrequency of the cleanup job. If the storage has not reached the configured capacity limit when the job runs, no files are removed or moved to backup storage.None
Limit level
YesDefines the folder hierarchy level where the capacity limit is applied:
  • 0 - the limit applies to the root folder of the file storage.
  • 1 - the limit applies to each direct subfolder of the root folder.
  • 2 - the limit applies to each second-level subfolder.
  • ...
  • 10 - the limit applies to each tenth-level subfolder.
Use this when recordings are grouped by camera, date, task, or event type.
None
Limit value
YesStorage capacity limit value in the unit selected by Limit by, for example megabytes, hours, or object count.1024
Enable upload
YesAllows users to upload files to the file storage from the device they use to access the Banalytics server. Available for writable storages.File upload in File Storage browserNone
Enable moving
YesAllows files and folders inside the file storage to be reorganized from the browser UI. Users can drag and drop files or folders and then confirm the operation.None
Allow text editing
YesAllows in-place editing for text files in writable storage folders. Enable it only for folders that intentionally contain editable text files such as notes, configuration snippets, or simple metadata files.None
Backup files instead of removing
OptionalReference to another file storage. When selected, the cleanup job moves recordings to that storage instead of deleting them.None
UI safe operations
YesWhen enabled, every move or delete operation requires confirmation, which helps prevent accidental file operations in the browser UI.Enabled
Enable UI file cache
YesCaches viewed files in the browser memory and can make repeated playback faster. This is useful for large video files when users move back and forth through the recordings list.Browser cache option for File StorageNone
UI file cache TTL
OptionalTime-to-live for the UI file cache, in minutes. After this period cached files are removed from the browser memory.None

Configure storage for the right operational role

File Storage is a shared Core dependency for tasks, actions, and business interfaces that need durable file persistence. The most important design choice is whether the storage is only a readable library, a writable recording target, or a managed repository where Banalytics can clean up and move old files.

COM

Reusable storage

Recording, snapshot, upload, archive, and media browsing workflows can all point to the same storage component or to separate purpose-specific folders.

CFG

Access control

The access mode defines whether users and tasks can only read files, create new files, or also delete and move data during cleanup.

OPS

Retention policy

Cleanup rules can limit storage by size, time, or object count, and can optionally move files into another storage instead of deleting them.

Storage roles and browser workflows

Storage role

Use File storage as a controlled storage area for recordings, snapshots, uploaded files, generated reports, and files shared through the remote UI. It wraps a lower-level File storage provider, restricts all operations to the configured Path, applies access rules, exposes browser options, and can automatically clean or archive old data.

TTL

Purpose-driven title

Set Title to the storage purpose, for example continuous recordings, motion events, snapshots, public downloads, or archive. If the title is empty, the UI title is derived from the destination folder name.

FS

File storage provider

Set File storage provider to the provider that owns the physical or virtual location. The default Local file system is appropriate for local disks and mounted volumes.

DIR

Dedicated root folder

Set Path to the root folder for this storage. For camera workloads, separate continuous video, motion video, and image snapshots into different storages so cleanup policies can be tuned independently.

Ordering, access, and cleanup

01

UI ordering

Use List order to control how files are presented in the UI. Desc is convenient for recordings and snapshots because the newest file names usually appear first when names contain timestamps.

02

Access boundary

Use Read only for browsing and downloading without writes or deletes. Use Read / Write when tasks and uploads should create files. Use Read / Write / Delete when operators or cleanup jobs should delete or move old files out of the primary storage.

03

Cleanup limits

Use Limit by, Clean up period, Limit level, and Limit value only for storages that are allowed to delete data. No limits keeps accumulating files, By total size (MB) keeps the newest files within an approximate total size budget, By Time (Hours) removes files by age, and By objects count keeps the newest files by count.

04

Hierarchy level

Use Limit level when files are grouped into folders, for example by camera, date, or event type. Level 0 applies the limit to the whole storage. Higher levels apply cleanup separately inside each folder at that depth.

05

Backup instead of delete

Use Backup files instead of removing when cleanup should move files into another storage instead of simply deleting them. This is useful for hot/cold storage: keep recent files on fast local disk, then move older files to a larger archive location.

Browser operations

01

Upload, move, and text editing

Use Enable upload, Enable moving, and Allow text editing to control what the browser UI allows for writable storages. Keep them disabled for recording folders that should be managed only by tasks.

02

Safe destructive operations

Keep UI safe operations enabled for storages where users can delete files. It makes destructive UI operations require stronger confirmation. Disable it only for trusted maintenance workflows where speed is more important than accidental deletion protection.

03

Browser cache

Use Enable UI file cache and UI file cache TTL for mostly immutable files that are downloaded or previewed repeatedly, such as completed recordings, images, or static documents. Keep cache disabled when files can be replaced under the same path.

Recommended profiles

01

Continuous video recording

Read / Write / Delete, Desc, cleanup by size or time, separate folder per camera or date, uploads/moves/text editing disabled, and optional archive storage for old recordings.

02

Motion/event evidence

Read / Write / Delete, cleanup by time with retention matching incident review needs, optional backup storage, and UI safe operations enabled for manual deletion.

03

Snapshot gallery

Read / Write / Delete, cleanup by object count or time, Desc, browser cache enabled when snapshots are immutable, and hierarchy cleanup by camera/date when many cameras share one storage.

04

Read only archive

Read only, no cleanup, browser cache enabled with a longer TTL, and no upload/move/edit UI controls.

05

Operator upload/exchange folder

Read / Write or Read / Write / Delete, upload enabled, move enabled only when users need organization tools, text editing enabled only for trusted text files, and safe delete confirmation enabled.

06

Hot/cold retention

Primary storage uses Read / Write / Delete with a size or time limit and Backup files instead of removing pointing to a larger archive storage. The archive can use read-only access or its own slower cleanup policy.

Operational notes

01

Free space validation

Writable storages validate free space on start and before writing. If free space is below the safety threshold, the storage stops instead of continuing to accept files.

02

Cleanup start conditions

Cleanup starts only when Access mode is Read / Write / Delete, Limit by is not No limits, and Clean up period is not Not applicable.

03

Transactional writes

File-writing tasks use output transactions, so partially written files can be rolled back and completed files are committed into the configured destination.

Related Core pages

Related components and pages