User Management

Configure users, permissions, and default user settings.

User Management link

Users can be managed through:

• Web UI (User Management section)
• CLI commands
• API

Default User Settings link

There’s two main areas that user settings are configured.

User Source configuration link

Configure defaults applied to new users:

1
2
3
4
5
6

server:
  sources:
    - path: "/data"
      config:
        defaultEnabled: true         # Give to all new users
        defaultUserScope: "/"       # Default access path under the source

User Defaults link

User defaults are configured on the config.yaml and are the default initial values for users when they are created.

 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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

userDefaults:
  editorQuickSave: false
  hideSidebarFileActions: false
  disableQuickToggles: false
  disableSearchOptions: false
  stickySidebar: true
  hideFilesInTree: false
  darkMode: true
  locale: "en"
  viewMode: "normal"
  singleClick: false
  showHidden: false
  dateFormat: false
  gallerySize: 3
  themeColor: "var(--blue)"
  quickDownload: false
  disablePreviewExt: ""
  disableViewingExt: ""
  lockPassword: false
  disableSettings: false
  preview:
    disableHideSidebar: false
    image: true
    video: true
    audio: true
    motionVideoPreview: true
    office: true
    popup: true
    autoplayMedia: true
    defaultMediaPlayer: false
    folder: true
    models: true
  permissions:
    api: false
    admin: false
    share: false
    realtime: false
    # v2.0.0+: the keys below seed DEFAULT per-source permissions for new scopes
    # (not global user permissions after the user is created)
    modify: false
    delete: false
    create: false
    download: true
  loginMethod: "password"
  disableUpdateNotifications: false
  deleteWithoutConfirming: false
  deleteAfterArchive: true
  fileLoading:
    maxConcurrentUpload: 10
    uploadChunkSizeMb: 10
    clearAll: false
    downloadChunkSizeMb: 0
  disableOnlyOfficeExt: ".md .txt .pdf .html .xml"
  customTheme: ""
  showSelectMultiple: false
  debugOffice: false
  preferEditorForMarkdown: false

For what each fileLoading field does (matching Settings → Uploads & Downloads), see Uploads & Downloads (user preferences).

permissions under userDefaults are not editable by non-admin users in the profile UI. Global flags (admin, api, share, realtime) live on the user; file-operation defaults apply when a new scope is added unless you set explicit per-source permissions in User Management.

Creating Users link

Via Web UI link

1. Log in as admin
2. Go to User Management
3. Click Create User
4. Set username, password, global permissions, and per-source permissions on each scope
5. Assign sources and scope paths

Via CLI link

1

./filebrowser user set username --password secret -c config.yaml

Create as admin:

1

./filebrowser user set username --password secret -a -c config.yaml

Promote an existing user to admin without changing their password:

1

./filebrowser user promote username -c config.yaml

For scripted password resets, pipe stdin:

1

echo 'newpassword' | ./filebrowser user set username --password -c config.yaml

User Permissions link

Global permissions (all sources) link

Configure on the user record; apply everywhere:

Admins receive full file-operation access on every source automatically.

Per-source file permissions (v2.0.0+) link

Configure per scope in User Management when editing a user — expand a source row to set:

Omitting permissions on a scope when saving via API lets the server apply Access management default permissions for that source. Explicit values override defaults. See User permissions.

API user shape (v2.0.0+) link

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

{
  "username": "demo",
  "password": "demo123",
  "permissions": {
    "admin": false,
    "api": true,
    "share": true,
    "realtime": false
  },
  "scopes": [
    {
      "name": "files",
      "scope": "/",
      "permissions": {
        "view": true,
        "download": true,
        "modify": true,
        "create": true,
        "delete": true
      }
    }
  ]
}

Legacy API payloads that put modify, create, delete, or download only under top-level permissions are migrated on upgrade; new integrations should use scopes[].permissions.

User Scopes link

Scopes define which sources and paths a user can access.

Assign Scope link

In User Management:

1. Edit user
2. Select source(s)
3. Set scope path (e.g., /, /subfolder, /users/john)
4. Expand each source row and set per-source permissions (view, download, modify, create, delete)
5. Save

Auto-Create User Directories link

Per-user directories are created under each source’s defaultUserScope using the username (the old createUserDir toggle is deprecated):

1
2
3
4
5
6

server:
  sources:
    - path: "/home/users"
      config:
        defaultEnabled: true
        defaultUserScope: "/"

User Groups link

Groups are currently managed and provided by the LDAP or OIDC provider. Adding groups manually in technically supported via API (see swagger), but not yet implemented as a feature in the UI. Stay tuned.

Password Management link

Set Password Requirements link

Minimum password length for password authentication:

1
2
3
4

auth:
  methods:
    password:
      minLength: 12

Reset User Password link

1

./filebrowser user set username --password newpassword -c config.yaml

Or pipe the password from a script:

1

echo 'newpassword' | ./filebrowser user set username --password -c config.yaml

Two-Factor Authentication link

Users can enable 2FA in their profile settings:

1. Go to Profile → Security
2. Click Enable 2FA
3. Scan QR code
4. Enter verification code

API Tokens link

Users with API permission can create tokens:

1. Go to Settings → API Management
2. Click Create Token
3. Copy and save securely

Next Steps link

• Configure access rules
• Set up groups
• Configure authentication