Go to file
Henrique Dias 871836f16d Update README.md
Former-commit-id: 4fe7114715f354f410ca3956dbc671f982bcc080 [formerly b0af83a18ff048d6d8e09c033e7501a5907076b8] [formerly b455d3a3d25e839badc811acf0027aaf4d80d73f [formerly 03755f6846]]
Former-commit-id: 1c294630d2eea21c7438e507a434ba5a869d46bd [formerly 24652d34f513537a0b760f84f805bb93541928f9]
Former-commit-id: ed7637c24e927a527a42d5b6bd04a6ca739dc351
2017-07-19 07:48:48 +01:00
.github
assets Remove Save button when there are no plugins 2017-07-18 17:10:09 +01:00
caddy Build assets 2017-07-19 07:07:00 +01:00
variables
.babelrc
.editorconfig
.eslintignore
.eslintrc.js
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
LICENSE.md
README.md Update README.md 2017-07-19 07:48:48 +01:00
auth.go Start integrating Hugo in the new plugin 2017-07-11 16:58:18 +01:00
build.sh Fix bugs and such 2017-07-18 09:06:19 +01:00
command.go Start integrating Hugo in the new plugin 2017-07-11 16:58:18 +01:00
download.go Start integrating Hugo in the new plugin 2017-07-11 16:58:18 +01:00
file.go Start integrating Hugo in the new plugin 2017-07-11 16:58:18 +01:00
filemanager.go simplify 2017-07-19 07:43:04 +01:00
http.go simplify 2017-07-19 07:43:04 +01:00
package.json Fix some stuff 2017-07-06 08:52:39 +01:00
resource.go Add User Permission check 2017-07-14 07:51:32 +01:00
rice-box.go.REMOVED.git-id Build assets 2017-07-19 07:07:00 +01:00
search.go Start integrating Hugo in the new plugin 2017-07-11 16:58:18 +01:00
settings.go Plugins settings working 2017-07-18 14:43:16 +01:00
users.go Third party permissions working 2017-07-14 08:25:37 +01:00

README.md

filemanager

Build Go Report Card Documentation

filemanager 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

This is a library so it can be used on your own applications as a middleware or as a standalone app (examples are going to be added in the future).

The easiest way to get started is using this with Caddy web server. You just need to download Caddy from its official website with http.filemanager plugin enabled. For more information about the plugin itself, please refer to its 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

FileManager 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