Server Settings

minSearchLength link

Minimum length of search query to begin searching (default: 3)

1
2

server:
  minSearchLength: 3

searchResultsLimit link

v2.1.x — Maximum indexed matches returned for one advanced search request (default: 1000). The Advanced Search tool slider and GET /api/tools/search?limit=… are capped to this value. Quick search omits limit and stays at 100; File Size Analyzer (largest=true) stays at 200.

1
2

server:
  searchResultsLimit: 1000

See Advanced Search.

disableUpdateCheck link

Disable backend update check service

1
2

server:
  disableUpdateCheck: false

numImageProcessors link

Number of concurrent image processing jobs used to create previews. Default is number of CPU cores available.

1
2

server:
  numImageProcessors: 4

disablePreviews link

Disable all previews and thumbnails. Simple icons will be used instead.

1
2

server:
  disablePreviews: false

disablePreviewResize link

Disable resizing of previews for faster loading over slow connections.

1
2

server:
  disablePreviewResize: false

disableTypeDetectionByHeader link

Disable type detection by header. Useful if filesystem is slow.

1
2

server:
  disableTypeDetectionByHeader: false

cacheDirCleanup link

Whether to automatically cleanup the cache directory. Note: Docker must also mount a persistent volume to persist the cache (default: false).

1
2

server:
  cacheDirCleanup: false

filesystem link

Filesystem settings for file and directory creation permissions.

1
2
3
4

server:
  filesystem:
    createFilePermission: "644"      # Unix permissions like 644, 755, 2755 (default: 644)
    createDirectoryPermission: "755" # Unix permissions like 755, 2755, 1777 (default: 755)

indexSqlConfig link

Index database SQL configuration for performance tuning.

1
2
3
4
5
6
7

server:
  indexSqlConfig:
    batchSize: 1000           # Number of items to batch in a single transaction, typically 500-5000. Higher = faster but could use more memory.
    cacheSizeMB: 32         # Size of the SQLite cache in MB
    walMode: false          # WAL journaling mode: more memory, better for busy deployments
    disableReuse: false       # If true, always create a new indexing database on startup
    startupIntegrityCheck: quickCheck  # quickCheck | probe | off — how thoroughly to verify the index DB at startup (default: quickCheck)

startupIntegrityCheck (default: quickCheck):

If you notice long delays on startup, you could configure this to probe (recommended) or off to reduce the startup check time.

• quickCheck — Runs SQLite PRAGMA quick_check. Thorougher on very large databases.
• probe — Lightweight check (catalog / sample read); faster for huge indexes.
• off — Minimal check beyond opening the DB; fastest boot, least safety.

sources link

Configure file system sources. See Sources configuration for detailed information.

logging link

Configure logging output and levels. See Logging configuration for detailed information.

database link

SQLite database file path. See database path priority for defaults and env var overrides.

1
2
3
4

server:
  database:
    path: "data/filebrowser.sqlite"
    migrateFrom: "database.db.old"  # one-time v1 → v2 migration only

Default locations (v2.0.0+), when path is omitted:

• Standalone: ./filebrowser.sqlite
• Docker image: /home/filebrowser/data/database.sqlite (the image sets FILEBROWSER_DATABASE_PATH). A path in config replaces that value.

During upgrade from v1.x, set migrateFrom to your renamed BoltDB file. Remove it after migration — see v2 migration guide.

Storage quotas (v2.1.0+) (folder, per-user scope, and share caps) use additional SQLite tables added in v2.1.0. They are created automatically on upgrade; legacy Bolt imports do not carry over quota limits. See Storage quotas (v2.1.0+).

Optional quota counter flush tuning (v2.1.0+):

1
2
3
4
5
6

server:
  database:
    path: "data/filebrowser.sqlite"
    quotas:
      flushIntervalSeconds: 10   # batch write interval for tracked usage counters (default 10)
      flushMaxBuffers: 500       # flush when this many dirty counters are queued (default 500)

maxArchiveSize link

FileBrowser limits the maximum size of archive and unarchive operations (folder downloads, ZIP handling, etc.). The limit is the combined size of files involved, in gigabytes. Default is 20 GB. Set to 0 for no limit.

This cap exists because archiving uses temporary files under cacheDir and an unlimited value could exhaust disk or memory on the server.

Ensure you have enough free space in cacheDir if you raise this value. That space must be on disk-backed storage (see cacheDir below). Lowering maxArchiveSize only blocks oversized archives; it does not fix out-of-memory failures when cacheDir is on tmpfs.

1
2

server:
  maxArchiveSize: 20   # GB; 0 = no limit (default: 20)

cacheDir link

The cacheDir is a critical configuration that defines where FileBrowser stores temporary files during various operations. By default, a tmp folder is created in the same directory as the program is run, but this may not be ideal. For example unRAID uses a different user by default and that causes permission issues with the default cache directory creation process.

Important Considerations link

The cacheDir is used by:

• Image preview generation: Thumbnails and processed images are cached
• Archive operations: ZIP extraction and compression temporary files (folder downloads; chunked downloads spool full archives here)
• Search indexing: Index database files under cacheDir/sql
• Document processing: Temporary files during PDF/image conversion
• Video processing: Some media files during video operations

1
2

server:
  cacheDir: "tmp" # this is default when not configured.

Basic Docker Setup:

1
2
3
4
5
6
7
8
9

# docker-compose.yaml
services:
  filebrowser:
    image: ghcr.io/gtsteffaniak/filebrowser:stable
    volumes:
      - '/path/to/your/data:/srv'
      - '/var/cache/filebrowser:/tmp/filebrowser'  # Mount cache directory
    environment:
      FILEBROWSER_CONFIG: "/config/config.yaml"

Corresponding config.yaml:

1
2

server:
  cacheDir: /tmp/filebrowser # corrosponds to above