readme update [ci skip]

Former-commit-id: e38254d0c413453a1aa786b4bab74363f3242f5a [formerly 2335fdf01307d7a5a6ab85159fcb14eade8a9cf6] [formerly 995060a68f7edb6cfb85ffd1439c1693dad369bd [formerly 15ebe3fc4a]]
Former-commit-id: 580f51a4606742686787b94f113c86d033eaa44c [formerly 2af22981e9127144b8cfe4150f177fc59c793896]
Former-commit-id: 7853c71fb43365a8ad61c367e4c56f07e12f135c
This commit is contained in:
Henrique Dias 2017-07-20 09:21:24 +01:00 committed by GitHub
parent 0f7995bbf3
commit 7b304e9c02
1 changed files with 27 additions and 0 deletions

View File

@ -9,6 +9,8 @@ filemanager provides a file managing interface within a specified directory and
# Table of contents
+ [Getting started](#getting-started)
- [Caddy](#caddy)
- [Standalone](#standalone)
+ [Features](#features)
- [Users](#users)
- [Search](#search)
@ -29,6 +31,10 @@ The easiest way to get started is using this with Caddy web server. You just nee
## Standalone
You can use filemanager as a standalone executable. You just need to download it from the [releases page](https://github.com/hacdias/filemanager/releases), where you can find multiple releases. The 'latest' always corresponds to the latest commit made to the master branch so it might not be stable.
You can either use flags or a JSON configuration file, which should have the following appearance:
```json
{
"port": 80,
@ -44,6 +50,27 @@ The easiest way to get started is using this with Caddy web server. You just nee
}
```
The `scope`, `allowCommands`, `allowEdit`, `allowNew` and `commands` options are the defaults for new users. To set a configuration file, you will need to pass the path with a flag, like this: `filemanager --config=/path/to/config.json`.
Otherwise, you may not want to use a configuration file, which can be done using the following flags:
```
-allow-commands
Default allow commands option (default true)
-allow-edit
Default allow edit option (default true)
-allow-new
Default allow new option (default true)
-commands string
Space separated commands available for new users (default "git svn hg")
-database string
Database path (default "./filemanager.db")
-port string
HTTP Port (default "80")
-scope string
Defualt scope for new users (default ".")
```
# Features
Easy login system.