mirror of
https://github.com/filebrowser/filebrowser.git
synced 2024-06-07 23:00:43 +00:00
731cc45e05
Former-commit-id: 3c5dc2c840b4ea82d2b88503b89515d8d6e1b590 [formerly aa5a9564be7917bc2bca82870eb61ccc2cc75347] [formerly f8f01920e7b54e52b012f469d917fb6f7e94d94a [formerly 300b55f2c7]]
Former-commit-id: daae1ff5c473b6fa583e270538830a046831eb2c [formerly 73ef7dac5d799cb3e321ba1b4969b125aa71c52b]
Former-commit-id: 715ce711701440e20da9512272fcd31922435323
76 lines
4.0 KiB
Markdown
76 lines
4.0 KiB
Markdown
|
|
|
|
# filemanager
|
|
|
|
[](https://travis-ci.org/hacdias/filemanager)
|
|
[](https://goreportcard.com/report/hacdias/filemanager)
|
|
[](http://godoc.org/github.com/hacdias/filemanager)
|
|
[](https://github.com/hacdias/filemanager/releases/latest)
|
|
|
|
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](#getting-started)
|
|
+ [Features](#features)
|
|
- [Users](#users)
|
|
- [Search](#search)
|
|
+ [Contributing](#contributing)
|
|
+ [Donate](#donate)
|
|
|
|
# Getting started
|
|
|
|
You can find the Getting Started guide on the [documentation](https://henriquedias.com/filemanager/quick-start/).
|
|
|
|
# Features
|
|
|
|
Easy login system.
|
|
|
|
|
|
|
|
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*.
|
|
|
|
|
|
|
|
File Manager editor is powered by [Codemirror](https://codemirror.net/) 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.
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
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!).
|
|
|
|
|
|
|
|
## Search
|
|
|
|
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
|
|
```
|
|
|
|
# Contributing
|
|
|
|
The contributing guidelines can be found [here](https://github.com/hacdias/filemanager/blob/master/CONTRIBUTING.md).
|