Installation¶

File Browser is a single binary and can be used as standalone executable. However, it is also available as a Docker image. The installation and first time setup is quite straightforward independently of which system you use.

Binary¶

The quickest and easiest way to install File Browser is to use a package manager, or our download script, which automatically fetches the latest version of File Browser for your platform.

BrewUnixWindows

brew tap filebrowser/tap
brew install filebrowser
filebrowser -r /path/to/your/files

curl -fsSL https://raw.githubusercontent.com/filebrowser/get/master/get.sh | bash
filebrowser -r /path/to/your/files

iwr -useb https://raw.githubusercontent.com/filebrowser/get/master/get.ps1 | iex
filebrowser -r /path/to/your/files

File Browser is now up and running. Read some first boot for more information.

Docker¶

File Browser is available as two different Docker images, which can be found on Docker Hub.

Alpines6 overlay

The

docker run \
  -v /path/to/srv:/srv \
  -v /path/to/database:/database \
  -v /path/to/config:/config \
  -p 8080:80 \
  filebrowser/filebrowser

The default user has PID 1000 and GID 1000. Please make sure that this user has access to the different mounted volumes. To change the user running inside the Docker image, you need to use the --user flag.

The s6 image is based on LinuxServer and leverages the s6-overlay system for a standard, highly customizable image. It should be used as follows:

docker run \
  -v /path/to/srv:/srv \
  -v /path/to/database:/database \
  -v /path/to/config:/config \
  -e PUID=$(id -u) \
  -e PGID=$(id -g) \
  -p 8080:80 \
  filebrowser/filebrowser:s6

Where:

/path/to/srv contains the files root directory for File Browser
/path/to/config contains a settings.json file
/path/to/database contains a filebrowser.db file

Both settings.json and filebrowser.db will automatically be initialized if they don’t exist.

File Browser is now up and running. Read some first boot for more information.

First Boot¶

Your instance is now up and running. File Browser will automatically bootstrap a database, in which the configuration and the users are stored. You can find the address in which your instance is running, as well as the randomly generated password for the user admin, in the console logs.

Warning

The automatically generated password for the user admin is only displayed once. If you fail to remember it, you will need to manually delete the database and start File Browser again.

Although this is the fastest way to bootstrap an instance, we recommend you to take a look at other possible options, by checking config init --help and config set --help, to make the installation as safe and customized as it can be.

If your goal is to have a public-facing deployment, we recommend taking a look at the deployment page for more information on how you can secure your installation.