filebrowser/configuration.md

# Configuration Help

This document covers the available configuration options, their defaults, and how they affect the functionality of filebrowser.

## All possible configurations

Here is an expanded config file which includes all possible configurations:

```
adminUsername: admin
adminPassword: admin
server:
  CreateUserDir: false
  UserHomeBasePath: ""
  indexingInterval: 5
  numImageProcessors: 4
  socket: ""
  tlsKey: ""
  tlsCert: ""
  enableThumbnails: false
  resizePreview: true
  typeDetectionByHeader: true
  port: 8080
  baseURL: "/"
  address: ""
  log: "stdout"
  database: "/database/database.db"
  root: "/srv"
auth:
  recaptcha:
    host: ""
    key: ""
    secret: ""
  header: ""
  method: json
  command: ""
  signup: false
  shell: ""
frontend:
  name: ""
  disableExternal: false
  disableUsedPercentage: true
  files: ""
  color: ""
userDefaults:
  settingsAllowed: true
  darkMode: false
  scope: ""
  locale: "en"
  viewMode: ""
  singleClick: true
  sorting:
    by: ""
    asc: true
  permissions:
    admin: true
    execute: true
    create: true
    rename: true
    modify: true
    delete: true
    share: true
    download: true
  commands: []
  hideDotfiles: false
  dateFormat: false
```

Here are the defaults if nothing is set:

```
adminUsername: admin
adminPassword: admin
server:
  enableThumbnails: true
  enableExec: false
  indexingInterval: 5
  port: 8080
  numImageProcessors: 4
  baseURL: ""
  database: database.db
  log: stdout
  root: /srv
auth:
  method: password
  recaptcha:
    host: ""
userDefaults:
  settingsAllowed: true
  darkMode: false
  scope: ""
  locale: "en"
  scope: "."
  lockPassword: false
  hideDotfiles: true
  permissions:
    create: true
    rename: true
    modify: true
    delete: true
    share: true
    download: true
```

## About each configuration

# Configuration Settings Documentation

## About each configuration

### Server configuration settings

- `indexingInterval`: This is the time in minutes the system waits before checking for filesystem changes. Default: `5`

- `numImageProcessors`: This is the number of image processors available. Default: `4`

- `socket`: This is the socket configuration.

- `tlsKey`: This is the TLS key configuration.

- `tlsCert`: This is the TLS certificate configuration.

- `enableThumbnails`: This boolean value determines whether thumbnails are enabled on ui. Default: `true`

- `resizePreview`: This boolean value determines whether preview resizing is enabled. Default: `false`

- `typeDetectionByHeader`: This boolean value determines whether type detection is based on headers.

- `port`: This is the port number on which the server is running. Default: `8080`

- `baseURL`: This is the base URL for the server. Default: `""`

- `address`: This is the server address configuration. Default: `0.0.0.0`

- `log`: This specifies the log destination. Default: `stdout`

- `database`: This is the database file path + filename that will be created if it does not already exist. If it exists, it will use the existing file. Default `database.db`

- `root`: This is the root directory path. Default: `/srv`

- `CreateUserDir`: Boolean to create user directory on user creation. Default: `false`

- `UserHomeBasePath`: String to define user home directory base path. Default: `""`

### Auth configuration settings

- `recaptcha`:

  - `host`: This is the host for reCAPTCHA.

  - `key`: This is the reCAPTCHA key.

  - `secret`: This is the reCAPTCHA secret.

- `header`: This is the authentication header.

- `method`: This is the authentication method used (e.g., "json"). Possible values:
  - `password` - username and password
  - `hook` - hook authentication
  - `proxy` - proxy authentication
  - `oath` - oath authentication
  - `noauth` - no authentication/login required.

- `command`: Deprecated: This is the authentication command.

- `shell`: This is the shell configuration.

- `Signup`: This boolean value indicates whether user signup is enabled on the login page. NOTE: Be mindful of `userDefaults` settings if enabled. Default: `false`

- `AdminUsername`: This is the username of the admin user. Default: `admin`

- `AdminPassword`: This is the password of the admin user. Default: `admin`

### Frontend configuration settings

- `name`: This is the name of the frontend.

- `disableExternal`: This boolean value determines whether external access is disabled.

- `disableUsedPercentage`: This boolean value determines whether used percentage is disabled.

- `files`: This is the files configuration.

- `theme`: This is the theme configuration.

- `color`: This is the color configuration.

### UserDefaults configuration settings

- `darkMode`: Determines whether dark mode is enabled for the user (`true` or `false`)

- `settingsAllowed`: Determines whether settings page is enabled for the user (`true` or `false`)

- `scope`: This is a scope of the permissions, "." or "./" means all directories, "./downloads" would mean only the downloads folder.

- `locale`: String locale configuration. Default: `en`

- `viewMode`: This is the view mode configuration. Possible values: `normal`, `compact`, `list`, and `gallery`. default: `normal`

- `singleClick`: This boolean value determines whether single-click is enabled. (`true` or `false`)

- `sorting`:

  - `by`: This is the sorting method used (e.g., "asc").

  - `asc`: This boolean value determines the sorting order is ascending or descending. (`true` or `false`)

- `permissions`:

  - `admin`: This boolean value determines whether admin permissions are granted.

  - `execute`: This boolean value determines whether execute permissions are granted.

  - `create`: This boolean value determines whether create permissions are granted.

  - `rename`: This boolean value determines whether rename permissions are granted.

  - `modify`: This boolean value determines whether modify permissions are granted.

  - `delete`: This boolean value determines whether delete permissions are granted.

  - `share`: This boolean value determines whether share permissions are granted.

  - `download`: This boolean value determines whether download permissions are granted.

- `commands`: Deprecated: This is a list of commands.

- `hideDotfiles`: This boolean value determines whether dotfiles are hidden. (`true` or `false`)

- `dateFormat`: This boolean value determines whether date formatting is enabled. (`true` or `false`)