-
Notifications
You must be signed in to change notification settings - Fork 16
3. File System
SecureFolderFS supports a variety of file system providers, enabling flexible integration across platforms. By default, the application automatically selects the most suitable provider when unlocking a vault based on the current platform. However, you can override this behavior by choosing a preferred file system provider in the application settings.
- WebDAV Server
- Dokany - Requires Dokany v2.3.0 or later to be installed manually
- Windows Projected File System - coming soon
- WebDAV Server
- FUSE
- WebDAV Server
- FUSE for macOS - coming soon
- Built-in file browser
- Android Storage Access Framework (SAF) via
DocumentsProvider
- Built-in file browser
- iOS File Provider via
NSFileProviderExtension
Note
On Android and iOS, users can browse their files using both available methods. However, choosing a different preferred file system provider is not supported on these platforms.
| Platform | File System Provider | Performance | Integration | Setup Effort | Recommended Use Case |
|---|---|---|---|---|---|
| Windows | WebDAV | ★★☆☆☆ | ★★★☆☆ | ★☆☆☆☆ | Quick access with minimal setup |
| Dokany | ★★★★☆ | ★★★★★ | ★★★☆☆ | Full-featured access with higher performance | |
| Projected File System (soon) | ★★★★★ | ★★★★★ | ★★☆☆☆ | Future default for performance and integration | |
| Linux | WebDAV | ★★☆☆☆ | ★★★☆☆ | ★☆☆☆☆ | Lightweight, simple environments |
| FUSE | ★★★★☆ | ★★★★★ | ★★★☆☆ | Advanced setups with heavy usage | |
| macOS | WebDAV | ★★☆☆☆ | ★★★☆☆ | ★☆☆☆☆ | Basic file operations |
| FUSE for macOS (soon) | ★★★★☆ | ★★★★☆ | ★★☆☆☆ | Improved experience once available | |
| Android | Built-in File Browser | ★★★☆☆ | ★★★★☆ | ★☆☆☆☆ | Best for most users; seamless in-app experience |
| SAF via DocumentsProvider | ★★☆☆☆ | ★★★★★ | ★☆☆☆☆ | When system-wide access is required | |
| iOS | Built-in File Browser | ★★★☆☆ | ★★★★☆ | ★☆☆☆☆ | Default for typical in-app usage |
| iOS File Provider | ★★★★☆ | ★★★★★ | ★☆☆☆☆ | When system-wide access is required |
You may use the built-in health check function to perform a scan of the contents in your vault. This can be particularly helpful in cases where files have become corrupted due to write failures or synchronization errors.
From the vault overview page, you can access the health widget and choose to scan either the vault structure alone or include file contents as well. In both cases, only the vault's file and folder structure is analyzed — vault configuration files are excluded from the scan.
The integrity check can help detect and address several common issues that may occur due to improper use of the vault:
- Broken encrypted file names: An option to assign a new name will be provided.
- Missing or invalid Directory ID file: You will have the option to regenerate the configuration file. Regenerating will remove all item names within that folder, requiring you to assign new names to the affected items.
- Corrupted portions of files: (coming soon) An option to reset the affected data blocks will be available. Data loss is inevitable.
Warning
Please note that full recovery of corrupted file contents is not always possible. If the file header is missing or does not match its format, the file is considered irrecoverable.
Each file system provider in SecureFolderFS includes its own implementation of the recycle bin feature. To use it, you must first enable the option from the "Vault Properties" page.
When a file or folder is deleted, it is moved to a special Recycle Bin directory instead of being permanently removed. This folder is hidden from the main file list and is accessible only through the app's user interface. An item will only be recycled if it meets the configured size limit, provided if one has been set by the user.
Note
The SecureFolderFS Recycle Bin should not be confused with the OS' recycle bin (e.g., Windows recycle bin, MacOS and Linux Trash folders)
Through the app interface, you can view, restore, or permanently delete items stored in the Recycle Bin.
When restoring an item, the app attempts to place it back in its original directory. If that directory has been moved, renamed, or deleted, you will be prompted to choose a new destination. The selected location must reside within the virtual file system's directory structure.
Permanently deleting an item from the Recycle Bin will remove it immediately, with no option for recovery. This action is irreversible, so proceed with caution when deleting sensitive or important files.
In certain cases, deleted files will bypass the Recycle Bin and be permanently removed:
- When the Recycle Bin feature is disabled
- When the size of the deleted item exceeds the remaining available space in the Recycle Bin
To prevent this, you can either delete existing items from the Recycle Bin to free up space or increase the configured size limit.