Go to file
Henrique Dias 8bf8bc3a15 chore: setting untracked version [ci skip] 2018-02-01 16:19:18 +00:00
.circleci chore: add circle ci and use external assets 2018-02-01 16:18:44 +00:00
.github fix #260 2017-10-30 15:24:06 +00:00
bolt refactor: moving repository 2018-02-01 13:38:43 +00:00
cmd/filebrowser refactor: moving repository 2018-02-01 13:38:43 +00:00
http chore: add circle ci and use external assets 2018-02-01 16:18:44 +00:00
staticgen refactor: moving repository 2018-02-01 13:38:43 +00:00
.dockerignore refactor: moving repository 2018-02-01 13:38:43 +00:00
.gitignore fix: allow user not to write .md or .markdown when creating file based on archetype #288 2017-12-27 16:02:36 +00:00
.goreleaser.yml refactor: moving repository 2018-02-01 13:38:43 +00:00
Docker.json change location of database docker 2017-09-07 14:19:05 +01:00
Dockerfile refactor: moving repository 2018-02-01 13:38:43 +00:00
LICENSE chore: add circle ci and use external assets 2018-02-01 16:18:44 +00:00
README.md chore: add circle ci and use external assets 2018-02-01 16:18:44 +00:00
build.sh chore: add circle ci and use external assets 2018-02-01 16:18:44 +00:00
doc.go refactor: moving repository 2018-02-01 13:38:43 +00:00
file.go refactor: moving repository 2018-02-01 13:38:43 +00:00
filebrowser.go chore: setting untracked version [ci skip] 2018-02-01 16:19:18 +00:00
package.json chore: add circle ci and use external assets 2018-02-01 16:18:44 +00:00
publish.sh chore: add circle ci and use external assets 2018-02-01 16:18:44 +00:00
rice-box.go chore: version 1.5.0 2018-02-01 16:19:05 +00:00

README.md

Preview

filebrowser

CircleCI Go Report Card Documentation Version

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 Manager 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

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 sensitive. Although, you can make a case insensitive search by adding case:insensitive to the search terms, like this:

this are keywords case:insensitive

Contributing

The contributing guidelines can be found here.