Skip to content

Commit 4dc85dc

Browse files
hacdiasgitbook-bot
hacdias
authored and
gitbook-bot
committed
GitBook: [master] 27 pages modified
1 parent 389a584 commit 4dc85dc

27 files changed

+308
-347
lines changed

‎cli/filebrowser-cmds-add.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ description: Add a command to run on a specific event
88

99
Add a command to run on a specific event.
1010

11-
```
11+
```text
1212
filebrowser cmds add <event> <command> [flags]
1313
```
1414

1515
## Options
1616

1717
| Name | Shorthand | Usage |
18-
|------|-----------|-------|
19-
|help|h|help for add|
18+
| :--- | :--- | :--- |
19+
| help | h | help for add |
2020

2121
### Inherited
2222

2323
| Name | Shorthand | Usage |
24-
|------|-----------|-------|
25-
|config|c|config file path|
26-
|database|d|database path|
24+
| :--- | :--- | :--- |
25+
| config | c | config file path |
26+
| database | d | database path |
2727

‎cli/filebrowser-cmds-ls.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,21 @@ description: List all commands for each event
88

99
List all commands for each event.
1010

11-
```
11+
```text
1212
filebrowser cmds ls [flags]
1313
```
1414

1515
## Options
1616

1717
| Name | Shorthand | Usage |
18-
|------|-----------|-------|
19-
|event|e|event name, without 'before' or 'after'|
20-
|help|h|help for ls|
18+
| :--- | :--- | :--- |
19+
| event | e | event name, without 'before' or 'after' |
20+
| help | h | help for ls |
2121

2222
### Inherited
2323

2424
| Name | Shorthand | Usage |
25-
|------|-----------|-------|
26-
|config|c|config file path|
27-
|database|d|database path|
25+
| :--- | :--- | :--- |
26+
| config | c | config file path |
27+
| database | d | database path |
2828

‎cli/filebrowser-cmds-rm.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,24 @@ description: Removes a command from an event hooker
66

77
## Synopsis
88

9-
Removes a command from an event hooker. The provided index
10-
is the same that's printed when you run 'cmds ls'. Note
11-
that after each removal/addition, the index of the
12-
commands change. So be careful when removing them after each
13-
other.
9+
Removes a command from an event hooker. The provided index is the same that's printed when you run 'cmds ls'. Note that after each removal/addition, the index of the commands change. So be careful when removing them after each other.
1410

15-
You can also specify an optional parameter (index_end) so
16-
you can remove all commands from 'index' to 'index_end',
17-
including 'index_end'.
11+
You can also specify an optional parameter \(index\_end\) so you can remove all commands from 'index' to 'index\_end', including 'index\_end'.
1812

19-
```
13+
```text
2014
filebrowser cmds rm <event> <index> [index_end] [flags]
2115
```
2216

2317
## Options
2418

2519
| Name | Shorthand | Usage |
26-
|------|-----------|-------|
27-
|help|h|help for rm|
20+
| :--- | :--- | :--- |
21+
| help | h | help for rm |
2822

2923
### Inherited
3024

3125
| Name | Shorthand | Usage |
32-
|------|-----------|-------|
33-
|config|c|config file path|
34-
|database|d|database path|
26+
| :--- | :--- | :--- |
27+
| config | c | config file path |
28+
| database | d | database path |
3529

‎cli/filebrowser-cmds.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ Command runner management utility.
1111
## Options
1212

1313
| Name | Shorthand | Usage |
14-
|------|-----------|-------|
15-
|help|h|help for cmds|
14+
| :--- | :--- | :--- |
15+
| help | h | help for cmds |
1616

1717
### Inherited
1818

1919
| Name | Shorthand | Usage |
20-
|------|-----------|-------|
21-
|config|c|config file path|
22-
|database|d|database path|
20+
| :--- | :--- | :--- |
21+
| config | c | config file path |
22+
| database | d | database path |
2323

‎cli/filebrowser-config-cat.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ description: Prints the configuration
88

99
Prints the configuration.
1010

11-
```
11+
```text
1212
filebrowser config cat [flags]
1313
```
1414

1515
## Options
1616

1717
| Name | Shorthand | Usage |
18-
|------|-----------|-------|
19-
|help|h|help for cat|
18+
| :--- | :--- | :--- |
19+
| help | h | help for cat |
2020

2121
### Inherited
2222

2323
| Name | Shorthand | Usage |
24-
|------|-----------|-------|
25-
|config|c|config file path|
26-
|database|d|database path|
24+
| :--- | :--- | :--- |
25+
| config | c | config file path |
26+
| database | d | database path |
2727

‎cli/filebrowser-config-export.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,22 @@ description: Export the configuration to a file
66

77
## Synopsis
88

9-
Export the configuration to a file. The path must be for a
10-
json or yaml file. This exported configuration can be changed,
11-
and imported again with 'config import' command.
9+
Export the configuration to a file. The path must be for a json or yaml file. This exported configuration can be changed, and imported again with 'config import' command.
1210

13-
```
11+
```text
1412
filebrowser config export <path> [flags]
1513
```
1614

1715
## Options
1816

1917
| Name | Shorthand | Usage |
20-
|------|-----------|-------|
21-
|help|h|help for export|
18+
| :--- | :--- | :--- |
19+
| help | h | help for export |
2220

2321
### Inherited
2422

2523
| Name | Shorthand | Usage |
26-
|------|-----------|-------|
27-
|config|c|config file path|
28-
|database|d|database path|
24+
| :--- | :--- | :--- |
25+
| config | c | config file path |
26+
| database | d | database path |
2927

‎cli/filebrowser-config-import.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,26 @@ description: Import a configuration file
66

77
## Synopsis
88

9-
Import a configuration file. This will replace all the existing
10-
configuration. Can be used with or without unexisting databases.
9+
Import a configuration file. This will replace all the existing configuration. Can be used with or without unexisting databases.
1110

12-
If used with a nonexisting database, a key will be generated
13-
automatically. Otherwise the key will be kept the same as in the
14-
database.
11+
If used with a nonexisting database, a key will be generated automatically. Otherwise the key will be kept the same as in the database.
1512

1613
The path must be for a json or yaml file.
1714

18-
```
15+
```text
1916
filebrowser config import <path> [flags]
2017
```
2118

2219
## Options
2320

2421
| Name | Shorthand | Usage |
25-
|------|-----------|-------|
26-
|help|h|help for import|
22+
| :--- | :--- | :--- |
23+
| help | h | help for import |
2724

2825
### Inherited
2926

3027
| Name | Shorthand | Usage |
31-
|------|-----------|-------|
32-
|config|c|config file path|
33-
|database|d|database path|
28+
| :--- | :--- | :--- |
29+
| config | c | config file path |
30+
| database | d | database path |
3431

‎cli/filebrowser-config-init.md

Lines changed: 39 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -6,58 +6,54 @@ description: Initialize a new database
66

77
## Synopsis
88

9-
Initialize a new database to use with File Browser. All of
10-
this options can be changed in the future with the command
11-
'filebrowser config set'. The user related flags apply
12-
to the defaults when creating new users and you don't
13-
override the options.
9+
Initialize a new database to use with File Browser. All of this options can be changed in the future with the command 'filebrowser config set'. The user related flags apply to the defaults when creating new users and you don't override the options.
1410

15-
```
11+
```text
1612
filebrowser config init [flags]
1713
```
1814

1915
## Options
2016

2117
| Name | Shorthand | Usage |
22-
|------|-----------|-------|
23-
|address|a|address to listen on|
24-
|auth.header||HTTP header for auth.method=proxy|
25-
|auth.method||authentication type|
26-
|baseurl|b|base url|
27-
|branding.disableExternal||disable external links such as GitHub links|
28-
|branding.files||path to directory with images and custom styles|
29-
|branding.name||replace 'File Browser' by this name|
30-
|cert|t|tls certificate|
31-
|commands||a list of the commands a user can execute|
32-
|help|h|help for init|
33-
|key|k|tls key|
34-
|locale||locale for users|
35-
|lockPassword||lock password|
36-
|log|l|log output|
37-
|perm.admin||admin perm for users|
38-
|perm.create||create perm for users|
39-
|perm.delete||delete perm for users|
40-
|perm.download||download perm for users|
41-
|perm.execute||execute perm for users|
42-
|perm.modify||modify perm for users|
43-
|perm.rename||rename perm for users|
44-
|perm.share||share perm for users|
45-
|port|p|port to listen on|
46-
|recaptcha.host||use another host for ReCAPTCHA. recaptcha.net might be useful in China|
47-
|recaptcha.key||ReCaptcha site key|
48-
|recaptcha.secret||ReCaptcha secret|
49-
|root|r|root to prepend to relative paths|
50-
|scope||scope for users|
51-
|shell||shell command to which other commands should be appended|
52-
|signup|s|allow users to signup|
53-
|sorting.asc||sorting by ascending order|
54-
|sorting.by||sorting mode (name, size or modified)|
55-
|viewMode||view mode for users|
18+
| :--- | :--- | :--- |
19+
| address | a | address to listen on |
20+
| auth.header | | HTTP header for auth.method=proxy |
21+
| auth.method | | authentication type |
22+
| baseurl | b | base url |
23+
| branding.disableExternal | | disable external links such as GitHub links |
24+
| branding.files | | path to directory with images and custom styles |
25+
| branding.name | | replace 'File Browser' by this name |
26+
| cert | t | tls certificate |
27+
| commands | | a list of the commands a user can execute |
28+
| help | h | help for init |
29+
| key | k | tls key |
30+
| locale | | locale for users |
31+
| lockPassword | | lock password |
32+
| log | l | log output |
33+
| perm.admin | | admin perm for users |
34+
| perm.create | | create perm for users |
35+
| perm.delete | | delete perm for users |
36+
| perm.download | | download perm for users |
37+
| perm.execute | | execute perm for users |
38+
| perm.modify | | modify perm for users |
39+
| perm.rename | | rename perm for users |
40+
| perm.share | | share perm for users |
41+
| port | p | port to listen on |
42+
| recaptcha.host | | use another host for ReCAPTCHA. recaptcha.net might be useful in China |
43+
| recaptcha.key | | ReCaptcha site key |
44+
| recaptcha.secret | | ReCaptcha secret |
45+
| root | r | root to prepend to relative paths |
46+
| scope | | scope for users |
47+
| shell | | shell command to which other commands should be appended |
48+
| signup | s | allow users to signup |
49+
| sorting.asc | | sorting by ascending order |
50+
| sorting.by | | sorting mode \(name, size or modified\) |
51+
| viewMode | | view mode for users |
5652

5753
### Inherited
5854

5955
| Name | Shorthand | Usage |
60-
|------|-----------|-------|
61-
|config|c|config file path|
62-
|database|d|database path|
56+
| :--- | :--- | :--- |
57+
| config | c | config file path |
58+
| database | d | database path |
6359

0 commit comments

Comments
 (0)