diff --git a/docs/configuration/auth.md b/docs/configuration/auth.md index 47d1796..d232aef 100644 --- a/docs/configuration/auth.md +++ b/docs/configuration/auth.md @@ -1,7 +1,7 @@ ## Default Auth service -By default, users are stored in json file. For some use-cases, this is more than enough. It also makes this app lightweight since no database is required. +By default, users are stored in json file. For some use-cases, this is enough. It also makes this app lightweight since no database is required. -Default handler accepts only file name parameter. This file should be writable by the server. +Default handler accepts only file name parameter. This file should be writable by the web server. ``` 'Filegator\Services\Auth\AuthInterface' => [ @@ -14,7 +14,7 @@ Default handler accepts only file name parameter. This file should be writable b ``` ## Configuring Auth service to use database -You can use mysql database to store your users. +You can also mysql database to store your users. First, create a table ```users``` with this sql: ``` @@ -39,7 +39,7 @@ VALUES ('admin', 'Admin', 'admin', 'read|write|upload|download|batchdownload|zip', '/', '$2y$10$Nu35w4pteLfc7BDCIkDPkecjw8wsH8Y2GMfIewUbXLT7zzW6WOxwq'); ``` -At the end, open ```configuration.php``` and update Auth handler under section ```services``` to something like this: +At the end, open ```configuration.php``` and update AuthInterface handler to: ``` 'Filegator\Services\Auth\AuthInterface' => [ @@ -54,4 +54,4 @@ At the end, open ```configuration.php``` and update Auth handler under section ` ], ``` -Don't forget to enter correct mysql username, password, and database. +Don't forget to enter correct database details. diff --git a/docs/configuration/basic.md b/docs/configuration/basic.md index e95c7c2..ce2bd4a 100644 --- a/docs/configuration/basic.md +++ b/docs/configuration/basic.md @@ -1,6 +1,6 @@ ## Basic -Edit ```configuration.php``` file to change basic things like logo, title, language and upload restrictions. +You can edit ```configuration.php``` to change the basic things like logo image, title, language and upload restrictions. NOTE: if you've made a mistake in configuration file, forgot to close a quote, the script will throw an error. Please use provided default ```configuration_sample.php``` to verify this. diff --git a/docs/configuration/session.md b/docs/configuration/session.md index c24d9ab..6cb0e10 100644 --- a/docs/configuration/session.md +++ b/docs/configuration/session.md @@ -12,7 +12,7 @@ CREATE TABLE `sessions` ( ) CHARSET=utf8 COLLATE=utf8_bin; ``` -Then, open ```configuration.php``` and update Auth handler under section ```services``` to something like this: +Then, open ```configuration.php``` and update Session handler to: ``` 'Filegator\Services\Session\SessionStorageInterface' => [ @@ -32,12 +32,12 @@ Then, open ```configuration.php``` and update Auth handler under section ```serv ], ``` -Don't forget to enter correct mysql username, password, and database. +Don't forget to enter correct database details. ## Tweaking session options -The underying Symfony's session [component](https://github.com/symfony/symfony/blob/4.4/src/Symfony/Component/HttpFoundation/Session/Storage/NativeSessionStorage.php) accepts array of options. +The underying [session component](https://github.com/symfony/symfony/blob/4.4/src/Symfony/Component/HttpFoundation/Session/Storage/NativeSessionStorage.php) accepts array of options. For example you can pass ```cookie_lifetime``` parameter to extend default session lifetime: ``` 'Filegator\Services\Session\SessionStorageInterface' => [ diff --git a/docs/configuration/storage.md b/docs/configuration/storage.md index f5375c5..b89541b 100644 --- a/docs/configuration/storage.md +++ b/docs/configuration/storage.md @@ -1,10 +1,12 @@ ## Adapters Different storage adapters are provided through the awesome [Flysystem](https://github.com/thephpleague/flysystem) library. -You can use local filesystem (default), FTP, S3, Dropbox and many others. Please check Flysystem docs for the exact setup required for each adapter. +You can use local filesystem (default), FTP, S3, Dropbox and many others. + +Please check the Flysystem [docs](https://github.com/thephpleague/flysystem) for the exact setup required for each adapter. ## Default Local Disk Adapter -With default adapter you just need to configure where your ```repository``` folder is. This folder will serve as root for everything else. +With default adapter you just need to configure where your ```repository``` folder is. This folder will serve as a root for everything else. ``` 'Filegator\Services\Storage\Filesystem' => [ diff --git a/docs/demo.md b/docs/demo.md index db733a5..33cd519 100644 --- a/docs/demo.md +++ b/docs/demo.md @@ -2,4 +2,5 @@ [https://demo.filegator.io](https://demo.filegator.io) This is read-only demo with guest account enabled. + You can also log in with john/john to see John's private files. diff --git a/docs/index.md b/docs/index.md index ae0f754..632b608 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,13 +4,13 @@ You can manage files inside your local repository folder (on your server's hard drive) or connect to other storage adaptes (see below). -FileGator has multi-user support so you can have admins and other users managing files with different access permissions, roles and home folders. +FileGator has multi-user support so you can have admins and other users managing the files with different access permissions, roles and home folders. All basic file operations are supported: copy, move, rename, create, delete, zip, unzip, download, upload. If allowed, users can download multiple files or folders at once. -File upload supports drag&drop, progress bar, pause and resume. Upload is chunked so you should be able to upload large files regardless of your server configuration. +File upload supports drag&drop, progress bar, pause and resume. Upload is chunked so you should be able to upload large files regardless of your server's configuration.