diff --git a/configuration/auth.html b/configuration/auth.html index 73216a5..690f1e7 100644 --- a/configuration/auth.html +++ b/configuration/auth.html @@ -101,8 +101,18 @@
-

Configuring Auth service to use database

-

You can store your users inside mysql database (default is json file).

+

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.

+

Default handler accepts only file name parameter. This file should be writable by the server.

+
        'Filegator\Services\Auth\AuthInterface' => [
+            'handler' => '\Filegator\Services\Auth\Adapters\JsonFile',
+            'config' => [
+                'file' => __DIR__.'/private/users.json',
+            ],
+        ],
+
+

Configuring Auth service to use database

+

You can use mysql database to store your users.

First, create a table users with this sql:

CREATE TABLE `users` (
     `id` int(10) NOT NULL AUTO_INCREMENT,
@@ -131,6 +141,7 @@ VALUES
                 'database' => 'filegator',
             ],
         ],
+

Don't forget to enter correct mysql username, password, and database.

diff --git a/configuration/basic.html b/configuration/basic.html index aebac79..f8d1a65 100644 --- a/configuration/basic.html +++ b/configuration/basic.html @@ -114,7 +114,7 @@ ], ],

Frontend tweaks

-

To change default color scheme and other options, edit /frontend/App.vue and recompile with npm.

+

To change default color scheme and other options, edit /frontend/App.vue. When you're done, recompile with npm run build.

// Primary color
 $primary: #34B891;
 $primary-invert: findColorInvert($primary);
diff --git a/development.html b/development.html
index 1f4f0a2..f487641 100644
--- a/development.html
+++ b/development.html
@@ -101,7 +101,8 @@
 
                 
                 
-

Project setup for development

+

Project setup for development (Linux)

+

You must have git, php, npm, and composer installed.

git clone git@github.com:filegator/filegator.git
 cd filegator
 cp configuration_sample.php configuration.php
@@ -110,14 +111,15 @@ sudo chmod -R 777 repository/
 composer install
 npm install
 npm run build
-

Compiles and hot-reloads (backend and frontend on ports 8081 and 8080)

+

Compiles and hot-reloads

+

The following command will launch backend and frontend on ports 8081 and 8080:

npm run serve

Once everything is ready visit: http://localhost:8080

Run tests & static analysis

vendor/bin/phpunit
 vendor/bin/phpstan analyse ./backend

Deployment

-

Set the website document root to /dist directory.

+

Set the website document root to /dist directory. This is also known as 'public' folder.

diff --git a/install.html b/install.html index 10bcae1..f9ae1b0 100644 --- a/install.html +++ b/install.html @@ -110,11 +110,10 @@
  • Latest: v7.0.0-RC2
  • Unzip files and upload them to your PHP server
  • Make sure you webserver can read and write to /storage and /private folders
  • -
  • Set the website document root to /dist directory
  • +
  • Set the website document root to /dist directory. This is also known as 'public' folder.
  • Visit web page, if something goes wrong check /private/logs/app.log
  • Login with default credentials admin/admin123
  • Change default admin's password
  • -
  • Adjust configuration.php file