ℹ INFO: This project is not under active development ATM. A small group of developers keeps the project alive, but due to lack of time, we can't continue adding new features or doing deep changes. Please read #532 for more info!

filebrowser

filebrowser provides a file managing interface within a specified directory and it can be used to upload, delete, preview, rename and edit your files. It allows the creation of multiple users and each user can have its own directory. It can be used as a standalone app or as a middleware.

Table of contents

• Quick Start
• Features
• Installation
  • One-step script
  • Docker
• Usage
• Command line interface
• Contributing

Quick Start

The fastest way for beginners to start using File Browser is by following the instructions bellow. Although, there are other ways to install/use it.

• Download File Browser.
• Put the binary in your PATH.
• Run filebrowser -s /path/to/your/files.

Done! It will tell you the address in which File Browser is running. You only need to open it and use the following credentials (you should change them!):

• Username: admin
• Password: admin

Although this is the fastest way to run File Browser, we recommend you to take a look at its usage as it contains more information about what you can do.

Features

Installation

One-step script

If you're running a Linux distribution or macOS, you can use our special script - made by Kyle Frost - to download the latest version of File Browser and install it on /usr/local/bin.

curl -fsSL https://filebrowser.github.io/get.sh | bash

If you're on Windows, you can use PowerShell to install File Browser too. You should run the command as administrator because it needs perissions to add the executable to the PATH:

iwr -useb https://filebrowser.github.io/get.ps1 | iex

Docker

Usage

• Add info for recommended way to install.
• Add info about custom branding.
• Add info about command runner.
• Add info about

Command line interface

The command line interface is very extensive and you can use it to modify settings, modify users or even have a generator of File Browser installations. The main subcommands available are:

• cmds to manage the command runner.
• config to manage the configuration of the installation.
• users to manage your users.
• init is an alias to config init.

All commands have the --help (shorthand -h) flag available and we invite you to explore all the commands for your own use.

Contributing

The contributing guidelines can be found here.