Skip to content
This repository has been archived by the owner on Jul 15, 2019. It is now read-only.

vitaliy-kuzmich/filebrowser

 
 

Repository files navigation

ℹ INFO: Jun 2019 Project renamed : to https://github.com/browsefile ℹ INFO: Jan 2019

-modified share, now it is possible to view share like user's file(not only download), added separate menu. Possible to restrict share to the specific users, all registered users, or all users(even not registered).

-db and cli replaced with one single config file. When you create a new user for the first time, set "firstRun":true, this will read "open/not hashed" password, and replace it with hash.

-added possibility to auth by list of ip addresses. Change "auth.method":"ip" in order to enable. Available values:ip, proxy, none, default(login and password)

-updated build command, in order to reduce final binary size. Please rebuild with debug info before submit bug report.

-removed file type detection based on content.

-removed user commands after/before file upload ...

-removed thirdparty archive, now there is system dependency on zip tool. It will call bash and redirect zip output stream directly to the browser, bypass any buffers.

-successfully run on home router with MediaTek MT7621AT CPU

-currently preview generation limited by only images, and videos, you can disable it at all by changing "defaultUser.allowGeneratePreview".

-dependencies update: filebrowser.conf(path next to the binary, required), convert.sh(path next to the binary, only if you use previews), zip linux tool(only for downloads), and ffmpeg(only if you use previews)

ℹ INFO: Nov 25 2018, after tries to use nextcloud as a home cloud, it was not possible to use it due to performance issues. So I've decided to adopt filebrowser project to my needs. Here it is list of things I've done:

-added thumbnail generation, it requires ffmpeg as system dependencies, limited generation only for images and videos

-added thumbnails user path at settings, and by default it must be set with "-v" short command. This path, should be out of the user's file scope path, otherwise it will recursively generate previews for self!

-added better file type detection at the backend

-integrated photoswipe as image slider and aplayer as audio player, and left default slider for other file types.

-added possibility to play music folder recursively by selecting required folders, and press music icon at the top. Mentioned button will play current folder without recursion. APlayer hidden by default

-deleted staticgen

planned to do:

-share permanent folders as separate path in menu between all users

-make docker image with required dependencies

-make ARM/MIPS docker images

-focus modifications to fit ARM/MIPS(low resources) architectures

ℹ 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!

ℹ INFO: in Q2 2018, this project was renamed from filemanager to filebrowser, and the main repo was moved from hacdias/filemanager to filebrowser/filebrowser. At the same time, the official docker image was changed to filebrowser/filebrowser. Users are encouraged to check their sources and update them accordingly.


Preview

filebrowser

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.

Table of contents

Getting started

You can find the Getting Started guide on the documentation.

Features

Easy login system.

Login Page

Listings of your files, available in two styles: mosaic and list. You can delete, move, rename, upload and create new files, as well as directories. Single files can be downloaded directly, and multiple files as .zip, .tar, .tar.gz, .tar.bz2 or .tar.xz.

Mosaic Listing

File Browser editor is powered by Codemirror and if you're working with markdown files with metadata, both parts will be separated from each other so you can focus on the content.

Markdown Editor

On the settings page, a regular user can set its own custom CSS to personalize the experience and change its password. For admins, they can manage the permissions of each user, set commands which can be executed when certain events are triggered (such as before saving and after saving) and change plugin's settings.

Settings

We also allow the users to search in the directories and execute commands if allowed.

Users

We support multiple users and each user can have its own scope and custom stylesheet. The administrator is able to choose which permissions should be given to the users, as well as the commands they can execute. Each user also have a set of rules, in which he can be prevented or allowed to access some directories (regular expressions included!).

Users

Search

File Browser allows you to search through your files and it has some options. By default, your search will be something like this:

this are keywords

If you search for that it will look at every file that contains "this", "are" or "keywords" on their name. If you want to search for an exact term, you should surround your search by double quotes:

"this is the name"

That will search for any file that contains "this is the name" on its name. It won't search for each separated term this time.

By default, every search will be case insensitive. Although, you can make a case sensitive search by adding case:sensitive to the search terms, like this:

this are keywords case:sensitive

Contributing

The contributing guidelines can be found here.

Packages

No packages published

Languages

  • Go 93.3%
  • Shell 6.4%
  • Dockerfile 0.3%