Skip to content

Commit 26400eb

Browse files
committed
doc: refactor Multi-User Mode area in config document
1 parent 7741ff6 commit 26400eb

File tree

1 file changed

+37
-9
lines changed

1 file changed

+37
-9
lines changed

docs/config.md

Lines changed: 37 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,45 @@
1111

1212
## Multi-User Mode:
1313

14-
| Key | Type | Description |
15-
|----------------------|---------|------------------------------------------------------------------------------------------------|
16-
| allow\_private\_folder | boolean | If true, private folders will be created for each signed-in user. |
17-
| allow\_shared\_folder | boolean | If true, share folder will be created. |
18-
| user_field | string | Private folders will be named by this. Can receive column name of `users` table or class name. |
14+
### allow\_private\_folder
1915

20-
### If you want to name private folders other than columns of users table, follow these steps:
21-
1. Run `php artisan vendor:publish --tag=lfm_handler`.
22-
2. Fill `App\Handler\ConfigHandler::class` into `user_field`.
23-
3. Edit `userField()` in the `App\Handler\ConfigHandler`
16+
* type: `boolean`
17+
* default: `true`
2418

19+
Only the owner(each signed-in user) of the private can upload and manage files within. Set to `false` to turn this feature off.
20+
21+
### private\_folder\_name
22+
23+
* type: `string`
24+
* default: user id
25+
26+
Privates folders for each user will be named by this config. Default to user id.
27+
28+
To change the behavior:
29+
30+
1. run `php artisan publish tag="lfm_handler"`
31+
2. rewrite `userField` function in App\Handler\ConfigHandler class
32+
3. set value of this config to App\Handler\ConfigHandler::class
33+
34+
### allow\_shared\_folder
35+
36+
* type: `boolean`
37+
* default: `true`
38+
39+
### shared\_folder\_name
40+
41+
* type: `string`
42+
* default: `"shares"`
43+
44+
Flexible way to customize client folders accessibility.
45+
46+
If you want to customize client folders:
47+
48+
1. run `php artisan publish tag="lfm_handler"`
49+
2. rewrite `userField` function in `App\Handler\ConfigHandler` class
50+
3. set value of this config to `App\Handler\ConfigHandler::class`
51+
52+
All users can upload and manage files within shared folders. Set to `false` to turn this feature off.
2553

2654
## Working Directory:
2755

0 commit comments

Comments
 (0)