CLI

There are only a few commands available:

1. Running the program, as shown in the install step. The only argument used is the config file if you choose to override the default "config.yaml"
2. Setup command to create a new config file via ./filebrowser setup
3. Checking the version info via ./filebrowser version
4. Updating the DB, which currently only supports adding users via ./filebrowser set -u username,password [-a]

Note: Always shut down any running service before performing any CLI operations. Only one process can access the same database file at once.

Using CLI with Docker

Firstly, shutdown any running service, using docker compose down if needed.

To enter CLI commands on docker, you'll need to enter a command line session inside a docker container with your database mounted.

docker run -it -v $(pwd)/path/to/database.db:/home/filebrowser/database.db --entrypoint="" gtstef/filebrowser sh

The above will enter you into a docker shell which you can run CLI commands.

Perform Password Reset

Here is an example password reset command:

./filebrowser set -u admin,newpassword -c path/to/custom-config.yaml

Create new user

here is an example user creation:

./filebrowser set -u joe,password -c path/to/custom-config.yaml

Note: Be sure to include your config path if it is not the default -- so user defaults get applied

Promote a user to admin

You can also "promote" a user to admin via command line, (which also means a password reset at this time):

./filebrowser set -u joe,newpassword -a -c path/to/custom-config.yaml