Skip to content

Latest commit

 

History

History
79 lines (51 loc) · 2.86 KB

README.md

File metadata and controls

79 lines (51 loc) · 2.86 KB

Preview

Travis Go Report Card Documentation Version Chat IRC

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.

Features

Please refer to our docs at https://filebrowser.org/features

Install

For installation instructions please refer to our docs at https://filebrowser.org/installation.

Build Frontend

//Navigate to frontend from root

cd frontend

//Install dependencies

npm install

//Build frontend

npm run build

Build backend

Requires the installation of go and rice

//From root, installs go dependencies

go mod download

//Utilize rice to bundle static assets

cd http
rice embed-go

Build Executable

//From root
go build

Running Filebrowser

//From root

//For Windows

filebrowser.exe

//For Mac

open filebrowser

Configuration

Authentication Method - You can change the way the user authenticates with the filebrowser server

Command Runner - The command runner is a feature that enables you to execute any shell command you want before or after a certain event.

Custom Branding - You can customize your File Browser installation by change its name to any other you want, by adding a global custom style sheet and by using your own logotype if you want.

Contributing

If you're interested in contributing to this project, our docs are best places to start https://filebrowser.org/contributing.