Skip to content

Commit 3be039b

Browse files
streamtwstreamtw
committed
documents for v2.0.0-alpha4
1 parent 65ebbf7 commit 3be039b

File tree

3 files changed

+56
-36
lines changed

3 files changed

+56
-36
lines changed

‎README.md‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Laravel Filemanager
22
[![Travis CI](https://img.shields.io/travis/UniSharp/laravel-filemanager.svg)](https://travis-ci.org/UniSharp/laravel-filemanager)
33
[![Total Downloads](https://poser.pugx.org/unisharp/laravel-filemanager/downloads)](https://packagist.org/packages/unisharp/laravel-filemanager)
4-
[![Latest Unstable Version](https://img.shields.io/badge/unstable-v2.0.0--alpha3-orange.svg)](https://packagist.org/packages/unisharp/laravel-filemanager)
4+
[![Latest Unstable Version](https://img.shields.io/badge/unstable-v2.0.0--alpha4-orange.svg)](https://packagist.org/packages/unisharp/laravel-filemanager)
55
[![Latest Stable Version](https://poser.pugx.org/unisharp/laravel-filemanager/v/stable)](https://packagist.org/packages/unisharp/laravel-filemanager)
66
[![License](https://poser.pugx.org/unisharp/laravel-filemanager/license)](https://packagist.org/packages/unisharp/laravel-filemanager)
77

@@ -14,6 +14,17 @@
1414
* [Upgrade](http://unisharp.github.io/laravel-filemanager/upgrade)
1515
* Demo : [Laravel Filemanager container](https://github.com/UniSharp/laravel-filemanager-example-5.3)
1616

17+
## Installing alpha version
18+
The alpha version of `v2.0` contains support of cloud storage and fresh new UI with RWD.
19+
20+
* Run `composer require unisharp/laravel-filemanager:dev-master` to get the latest code.
21+
* Run `composer require unisharp/laravel-filemanager:v2.0.0-alpha4` to get the latest release of alpha version.
22+
23+
## Errors with namespace
24+
We have changed namespace from `Unisharp` to `UniSharp`, and change the first character of every namespace into capital.
25+
26+
If you are updating this package and encounter any errors like `Class not found`, please remove this package entirely and reinstall again.
27+
1728
## v1.8 released
1829
* Please follow the intructions in [upgrade document](https://unisharp.github.io/laravel-filemanager/upgrade).
1930
* Important changes :

‎docs/config.md‎

Lines changed: 35 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22

33
## Routing:
44

5-
| Key | Type | Description |
6-
|--------------------|---------|--------------------------------------------------------------------------------------------------------------|
5+
| Key | Type | Description |
6+
|----------------------|---------|--------------------------------------------------------------------------------------------------------------|
77
| use\_package\_routes | boolean | Use routes from package or not. If false, you will need to define routes to all controllers of this package. |
8-
| middlewares | array | Middlewares to be applied to default routes. For laravel 5.1 and before, remove 'web' from the array. |
9-
| url_prefix | string | The url prefix to this package. Change it if necessary. |
8+
| middlewares | array | Middlewares to be applied to default routes. For laravel 5.1 and before, remove 'web' from the array. |
9+
| url_prefix | string | The url prefix to this package. Change it if necessary. |
1010

1111

1212
## Multi-User Mode:
1313

14-
| Key | Type | Description |
15-
|--------------------|---------|------------------------------------------------------------------------------------------------|
14+
| Key | Type | Description |
15+
|----------------------|---------|------------------------------------------------------------------------------------------------|
1616
| allow\_multi\_user | boolean | If true, private folders will be created for each signed-in user. |
1717
| allow\_share\_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. |
18+
| user_field | string | Private folders will be named by this. Can receive column name of `users` table or class name. |
1919

2020
### If you want to name private folders other than columns of users table, follow these steps:
2121
1. Run `php artisan vendor:publish --tag=lfm_handler`.
@@ -25,9 +25,9 @@
2525

2626
## Working Directory:
2727

28-
| Key | Type | Description |
29-
|--------------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
30-
| base_directory | string | Which folder to store files in project, fill in 'public', 'resources', 'storage' and so on. Does not support path relative path like `../public_html` or `public/upload/user/`. |
28+
| Key | Type | Description |
29+
|----------------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
30+
| base_directory | string | Which folder to store files in project, fill in 'public', 'resources', 'storage' and so on. Does not support path relative path like `../public_html` or `public/upload/user/`. |
3131
| images\_folder\_name | string | Does not support path relative path like `../public_html` or `public/upload/user/`. |
3232
| files\_folder\_name | string | Does not support path relative path like `../public_html` or `public/upload/user/`. |
3333
| shared\_folder\_name | string | Does not support path relative path like `../public_html` or `public/upload/user/`. |
@@ -36,52 +36,53 @@
3636

3737
## Startup Views:
3838

39-
| Key | Type | Description |
40-
|---------------------|--------|-----------------------------------------------------------------|
39+
| Key | Type | Description |
40+
|-----------------------|--------|-----------------------------------------------------------------|
4141
| images\_startup\_view | string | The default display type for images. Supported: "grid", "list". |
4242
| files\_startup\_view | string | The default display type for files. Supported: "grid", "list". |
4343

4444

4545
## Upload / Validation:
4646

47-
| Key | Type | Description |
48-
|-------------------------|---------|--------------------------------------------------------------------------|
49-
| rename_file | string | If true, the uploaded file will be renamed to uniqid() + file extension. |
50-
| alphanumeric_filename | string | If true, non-alphanumeric file name will be replaced with `_`. |
51-
| alphanumeric_directory | boolean | If true, non-alphanumeric folder name will be rejected. |
52-
| should\_validate\_size | boolean | If true, the size of uploading file will be verified. |
53-
| max\_image\_size | int | Specify max size of uploading image. |
54-
| max\_file\_size | int | Specify max size of uploading file. |
55-
| should\_validate\_mime | boolean | If true, the mime type of uploading file will be verified. |
56-
| valid\_image\_mimetypes | array | Array of mime types. Available since v1.3.0 . |
57-
| should\_create\_thumbnails | boolean | If true, thumbnails will be created for faster loading. |
58-
| raster\_mimetypes | array | Array of mime types. Thumbnails will be created only for these mimetypes. |
59-
| create\_folder\_mode | int | Permission setting for folders created by this package. |
60-
| create\_file\_mode | int | Permission setting for files uploaded to this package. |
61-
| should\_change\_file\_mode | boolean | If true, it will attempt to chmod the file after upload |
62-
| valid\_file\_mimetypes | array | Array of mime types. Available since v1.3.0 . |
47+
| Key | Type | Description |
48+
|----------------------------|---------|---------------------------------------------------------------------------|
49+
| disk (Alpha version only) | string | Correspond to `disks` section in `config/filesystems.php`. |
50+
| rename_file | string | If true, the uploaded file will be renamed to uniqid() + file extension. |
51+
| alphanumeric_filename | string | If true, non-alphanumeric file name will be replaced with `_`. |
52+
| alphanumeric_directory | boolean | If true, non-alphanumeric folder name will be rejected. |
53+
| should\_validate\_size | boolean | If true, the size of uploading file will be verified. |
54+
| max\_image\_size | int | Specify max size of uploading image. |
55+
| max\_file\_size | int | Specify max size of uploading file. |
56+
| should\_validate\_mime | boolean | If true, the mime type of uploading file will be verified. |
57+
| valid\_image\_mimetypes | array | Array of mime types. Available since v1.3.0 . |
58+
| should\_create\_thumbnails | boolean | If true, thumbnails will be created for faster loading. |
59+
| raster\_mimetypes | array | Array of mime types. Thumbnails will be created only for these mimetypes. |
60+
| create\_folder\_mode | int | Permission setting for folders created by this package. |
61+
| create\_file\_mode | int | Permission setting for files uploaded to this package. |
62+
| should\_change\_file\_mode | boolean | If true, it will attempt to chmod the file after upload |
63+
| valid\_file\_mimetypes | array | Array of mime types. Available since v1.3.0 . |
6364

6465

6566
## Thumbnail dimensions:
6667

67-
| Key | Type | Description |
68-
|------------------|--------|--------------------------------------------------|
68+
| Key | Type | Description |
69+
|--------------------|--------|--------------------------------------------------|
6970
| thumb\_img\_width | string | Width of thumbnail made when image is uploaded. |
7071
| thumb\_img\_height | string | Height of thumbnail made when image is uploaded. |
7172

7273

7374
## File Extension Information
7475

75-
| Key | Type | Description |
76-
|-----------------|-------|---------------------------------------------|
76+
| Key | Type | Description |
77+
|-------------------|-------|---------------------------------------------|
7778
| file\_type\_array | array | Map file extension with display names. |
7879
| file\_icon\_array | array | Map file extension with icons(font-awsome). |
7980

8081

8182
## php.ini override
8283

83-
| Key | Type | Description |
84-
|-------------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------|
84+
| Key | Type | Description |
85+
|---------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------|
8586
| php\_ini\_overrides | array or boolean | These values override your php.ini settings before uploading files. Set these to false to ingnore and apply your php.ini settings |
8687

8788
### Caveats

‎docs/installation.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
Code above is for Laravel 5.1.
3434
In Laravel 5.0 should leave only quoted class names.
3535

36-
1. Edit `routes/web.php` :
36+
1. (Alpha version only) Edit `routes/web.php` :
3737

3838
Create route group to wrap package routes
3939

@@ -59,6 +59,14 @@
5959
6060
1. Ensure that the files & images directories (in `config/lfm.php`) are writable by your web server (run commands like `chown` or `chmod`).
6161
62+
1. Create symbolic link :
63+
64+
```bash
65+
php artisan storage:link
66+
```
67+
68+
1. Edit `APP_URL` in `.env`.
69+
6270
## What's next
6371
6472
1. Check the [integration document](http://unisharp.github.io/laravel-filemanager/integration) to see how to apply this package.

0 commit comments

Comments
 (0)