mirror_html/filegator
1
0
Fork 0
mirror of https://github.com/filegator/filegator.git synced 2025-08-16 13:34:36 +02:00
Code Issues Projects Releases Wiki Activity

docs upd

Browse Source
This commit is contained in:
Milos Stojanovic
2019-06-18 18:37:28 +02:00
parent a39d2c5331
commit f43d0cd23d
6 changed files with 16 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/configuration/auth.md
View File

@@ -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.

2
docs/configuration/basic.md
View File

@@ -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.

6
docs/configuration/session.md
View File

@@ -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' => [

6
docs/configuration/storage.md
View File

@@ -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' => [