schedule Published: October 17, 2024
update Last updated: October 17, 2024

Overview

Conditional rules allow you to control which files and folders are indexed by FileBrowser Quantum. Use rules to exclude system files, temporary directories, or large archives while keeping your UI clean and search results relevant.

Basic Structure

Rules are configured under conditionals in your source configuration:

YAML 
1
2
3
4
5
6
7
8
9

sources:
  - path: "/data"
    config:
      conditionals:
        ignoreHidden: true
        ignoreZeroSizeFolders: false
        rules:
          - folderPath: "excluded"
          - fileNames: ".DS_Store"

Global Flags

These flags apply to the entire source:

ignoreHidden

YAML 
1
2

conditionals:
  ignoreHidden: true

Skip all hidden files and folders (those starting with .). Hidden items don’t appear in UI or search. Defaults to false. Useful for automatically excluding system files like .git and .DS_Store.

ignoreZeroSizeFolders

YAML 
1
2

conditionals:
  ignoreZeroSizeFolders: true

Skip folders with zero calculated size. Empty folders or folders containing only empty folders are ignored. Defaults to false. Cleans up UI by hiding empty directory structures.

Rule Types

Individual rules are specified in the rules array. Each rule targets specific files or folders.

Path-Based Rules

Target specific paths within your source.

folderPath

YAML 
1
2
3

rules:
  - folderPath: "temp"
  - folderPath: "cache/build"

Matches exact folder path relative to source root. For example, folderPath: "logs" matches /data/logs but not /data/project/logs. Use this to exclude specific known directories.

filePath

YAML 
1
2
3

rules:
  - filePath: "config/secrets.txt"
  - filePath: "data.db"

Matches exact file path relative to source root. For example, filePath: "data.db" matches /data/data.db but not /data/backup/data.db. Use this to exclude specific known files.

Name-Based Rules (Global)

These rules apply anywhere within the source.

folderNames

YAML 
1
2
3
4

rules:
  - folderNames: "node_modules"
  - folderNames: "__pycache__"
  - folderNames: ".git"

Matches any folder with this exact name, anywhere in the source. For example, folderNames: "node_modules" excludes all node_modules directories. Useful for excluding common folder names like cache or build directories.

fileNames

YAML 
1
2
3
4

rules:
  - fileNames: ".DS_Store"
  - fileNames: "Thumbs.db"
  - fileNames: "desktop.ini"

Matches any file with this exact name, anywhere in the source. For example, fileNames: ".DS_Store" excludes all .DS_Store files. Useful for excluding system or temporary files by name.

Pattern-Based Rules (Global)

Match files and folders based on name patterns.

folderStartsWith

YAML 
1
2
3
4

rules:
  - folderStartsWith: "tmp-"
  - folderStartsWith: "backup-"
  - folderStartsWith: "."

Matches folders whose names start with the specified prefix, anywhere in the source. For example, folderStartsWith: "tmp-" excludes tmp-cache, tmp-build, etc. Useful for excluding folders with naming conventions.

folderEndsWith

YAML 
1
2
3
4

rules:
  - folderEndsWith: ".git"
  - folderEndsWith: ".cache"
  - folderEndsWith: "-backup"

Matches folders whose names end with the specified suffix, anywhere in the source. For example, folderEndsWith: ".git" excludes .git folders. Useful for excluding folders by suffix pattern.

fileStartsWith

YAML 
1
2
3
4

rules:
  - fileStartsWith: "temp-"
  - fileStartsWith: "~"
  - fileStartsWith: "._"

Matches files whose names start with the specified prefix, anywhere in the source. For example, fileStartsWith: "._" excludes macOS metadata files. Useful for excluding temporary or system files.

fileEndsWith

YAML 
1
2
3
4

rules:
  - fileEndsWith: ".tmp"
  - fileEndsWith: ".log"
  - fileEndsWith: "~"

Matches files whose names end with the specified suffix, anywhere in the source. For example, fileEndsWith: ".tmp" excludes all temporary files. Useful for excluding files by extension or suffix.

Special Rules

includeRootItem

YAML 
1
2
3
4

rules:
  - includeRootItem: "public"
  - includeRootItem: "downloads"
  - includeRootItem: "README.md"

Only show specified items at the root level of the source. For example, with the rules above, only public and downloads folders appear at source root. Useful for restricting visibility to specific root directories or files.

neverWatchPath

YAML 
1
2
3

rules:
  - neverWatchPath: "archives"
  - neverWatchPath: "historical/2020"

Folder is indexed once initially, then never rescanned automatically. You can still manually refresh by viewing the folder in the UI. Useful for large, rarely-changing directories to save resources.

Example:

YAML 
1
2

rules:
  - neverWatchPath: "photo-archive"  # 500GB of old photos

viewable

YAML 
1
2
3
4
5

rules:
  - folderPath: "archive"
    viewable: true
  - folderPath: "temp"
    viewable: true

Can be added to any rule type. Folder/file appears in UI but is excluded from search and size calculations. Useful for showing directories for browsing without indexing their contents.

Example:

YAML 
1
2
3

rules:
  - folderPath: "old-projects"
    viewable: true

Users can browse old-projects but it won’t appear in search results or affect folder sizes.

Complete Examples

Clean Development Environment

Exclude common development artifacts:

YAML 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

sources:
  - path: "/projects"
    config:
      conditionals:
        ignoreHidden: true
        rules:
          # Node.js
          - folderNames: "node_modules"
          - folderNames: "dist"
          - folderNames: "build"
          
          # Python
          - folderNames: "__pycache__"
          - folderNames: ".pytest_cache"
          - folderEndsWith: ".egg-info"
          
          # General
          - folderNames: ".git"
          - fileNames: ".DS_Store"
          - fileEndsWith: ".log"

Media Library with Archives

Show archive folders but don’t index them:

YAML 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

sources:
  - path: "/media"
    config:
      conditionals:
        ignoreHidden: true
        ignoreZeroSizeFolders: true
        rules:
          # System files
          - fileNames: ".DS_Store"
          - fileNames: "Thumbs.db"
          - folderNames: "@eaDir"
          
          # Show but don't index archives
          - folderPath: "2020-archive"
            viewable: true
          - folderPath: "2021-archive"
            viewable: true
          
          # Never rescan large stable folders
          - neverWatchPath: "historical-collection"

Restricted Public Share

Only expose specific directories:

YAML 
1
2
3
4
5
6
7
8
9

sources:
  - path: "/shared"
    config:
      conditionals:
        rules:
          # Only these folders visible at root
          - includeRootItem: "public"
          - includeRootItem: "downloads"
          - includeRootItem: "README.md"

Enterprise File Server

Comprehensive exclusions for corporate environment:

YAML 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

sources:
  - path: "/fileserver"
    config:
      conditionals:
        ignoreHidden: true
        ignoreZeroSizeFolders: true
        rules:
          # Windows system files
          - fileNames: "desktop.ini"
          - fileNames: "Thumbs.db"
          - folderNames: "System Volume Information"
          - folderNames: "$RECYCLE.BIN"
          
          # macOS system files
          - fileNames: ".DS_Store"
          - fileStartsWith: "._"
          - folderNames: ".Trashes"
          
          # Synology NAS
          - folderNames: "@eaDir"
          - folderNames: "#recycle"
          
          # Temporary and backup files
          - fileEndsWith: "~"
          - fileEndsWith: ".tmp"
          - fileEndsWith: ".bak"
          - folderStartsWith: "~"
          
          # Archives - visible but not searchable
          - folderPath: "archives/2020"
            viewable: true
          - folderPath: "archives/2021"
            viewable: true

Rule Priority and Behavior

How Rules Are Applied

  1. Global flags first: ignoreHidden and ignoreZeroSizeFolders are checked first
  2. Rules are OR-based: If any rule matches an item, it’s excluded
  3. Path rules are exact: folderPath: "temp" only matches /temp, not /project/temp
  4. Name rules are global: folderNames: "temp" matches any temp folder anywhere
  5. Viewable overrides exclusion: Adding viewable: true shows the item in UI

Common Patterns

Exclude by Extension

YAML 
1
2
3
4

rules:
  - fileEndsWith: ".log"
  - fileEndsWith: ".tmp"
  - fileEndsWith: ".bak"

Removes temporary and log files.

Exclude System Files

YAML 
1
2
3
4

ignoreHidden: true
rules:
  - fileNames: ".DS_Store"
  - fileNames: "Thumbs.db"

Clean UI without system clutter.

Show Large Archives

YAML 
1
2
3
4

rules:
  - folderPath: "archive"
    viewable: true
  - neverWatchPath: "archive"

Browsable but not indexed or rescanned.

Development Projects

YAML 
1
2
3
4

rules:
  - folderNames: "node_modules"
  - folderNames: ".git"
  - folderEndsWith: ".cache"

Exclude build artifacts and dependencies.

Best Practices

  1. Start with hidden files: Enable ignoreHidden: true for cleaner UI
  2. Use global rules for common patterns: folderNames and fileNames work everywhere
  3. Path rules for specific exclusions: Use folderPath for known directories
  4. Consider viewable for archives: Show large stable folders without indexing overhead
  5. Test your rules: Verify excluded items don’t appear in search

Performance Tips

  • Use neverWatchPath for large, stable directories to save resources
  • Enable ignoreZeroSizeFolders if you have many empty directories
  • Exclude large development folders like node_modules to speed up scans
  • Use viewable for archives to show them without search overhead

Next Steps