Configuration Migration

Migrate your configuration from the original FileBrowser to Quantum.

Configuration Format Changes link

FileBrowser Quantum uses a YAML-based configuration file instead of command-line flags and database settings.

See About FileBrowser Quantum config file

Quantum v1.5.x stable and v2.x beta do not share listen or database keys. Copy the example that matches the release you are installing. v2 rejects unknown keys at startup, including server.port, server.address, server.database as a plain string, and auth.methods.passwordAuth.

Migration Process link

1. Export Current Settings link

If you are running original FileBrowser, note your current settings:

1
2
3
4
5

# Check command-line flags
ps aux | grep filebrowser

# Common flags to note:
# --port, --address, --baseurl, --database, --root

also reference your config.json

2. Create config.yaml link

Create a new config.yaml file with your settings.

v2.0.0-beta and later Listen settings are under http. The database is a SQLite file under server.database.path (standalone default filebrowser.sqlite). Password auth is auth.methods.password. Global share permission is userDefaults.account.permissions.share. File modify/create/delete/download/view defaults are server.sources[].config.defaultPermissions.

 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

http:
  port: 8080
  listen: "0.0.0.0"
  baseURL: "/"

server:
  database:
    path: "data/filebrowser.sqlite"
  sources:
    - name: "files"
      path: "/srv"
      config:
        defaultEnabled: true
        defaultPermissions:
          view: true
          download: true
          modify: true

auth:
  methods:
    password:
      enabled: true

userDefaults:
  account:
    permissions:
      share: true

v1.5.6-stable. Listen settings stay under server. The address key is server.listen, not server.address. The database is a string path (server.database, standalone default database.db), not server.database.path. Password auth is still auth.methods.password. On v1.5.6, http only has trustedHeaders and disableRateLimit.

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

server:
  port: 8080
  listen: "0.0.0.0"
  baseURL: "/"
  database: "data/database.db"
  sources:
    - name: "files"
      path: "/srv"

auth:
  methods:
    password:
      enabled: true

userDefaults:
  account:
    permissions:
      modify: true
      share: true

3. Map Old Flags to New Config link

Features Removed link

The following features from original FileBrowser are not available in Quantum:

• Terminal - Removed for security
• Runners - Removed (to be replaced with better job system)
• Command line user management - Use config file or API

Next Steps link

• Set up sources
• Configure authentication
• Customize frontend