mirror of
https://github.com/filebrowser/filebrowser.git
synced 2024-06-07 23:00:43 +00:00
5079f405fc
Remove old disclaimer and add new one.
Former-commit-id: 26caff0046abe585e1dc58c7f6ca728254b57883 [formerly 9915c1da01cdf3742c49625028de3646f4cc0218] [formerly aad017cd8c74480cfc978c830f83346c5e410bc3 [formerly dae992d4a9]]
Former-commit-id: 0fb7d01241ec6fe633624710bd7d4a2a713ca119 [formerly defcc61802d496705a16de97c30ad5ca2e7d8497]
Former-commit-id: 2dffe9f988673bc9c4b83638190f70ac579b9e38
87 lines
4.9 KiB
Markdown
87 lines
4.9 KiB
Markdown
ℹ 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](https://github.com/hacdias/filemanager) to [filebrowser/filebrowser](https://github.com/filebrowser/filebrowser). At the same time, the official docker image was changed to [`filebrowser/filebrowser`](https://hub.docker.com/r/filebrowser/filebrowser/). Users are encouraged to check their sources and update them accordingly.
|
||
|
||
---
|
||
|
||
<p align="center">
|
||
<img src="https://raw.githubusercontent.com/filebrowser/logo/master/banner.png" width="550"/>
|
||
</p>
|
||
|
||
|
||
|
||
# filebrowser
|
||
|
||
[](https://travis-ci.com/filebrowser/filebrowser)
|
||
[](https://goreportcard.com/report/github.com/filebrowser/filebrowser)
|
||
[](http://godoc.org/github.com/filebrowser/filebrowser)
|
||
[](https://github.com/filebrowser/filebrowser/releases/latest)
|
||
[](http://webchat.freenode.net/?channels=%23filebrowser)
|
||
|
||
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](#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://filebrowser.github.io/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 Browser 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
|
||
|
||
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](https://github.com/filebrowser/community).
|