This commit is contained in:
Milos Stojanovic
2019-06-18 16:07:18 +02:00
parent fff29ef124
commit 310da23496
5 changed files with 27 additions and 38 deletions

View File

@@ -46,48 +46,18 @@ You can also log in with john/john to see John's private files.
## Requirements
- PHP 7.1.3+
## Download precompiled build
- Latest: [v7.0.0-RC2](https://github.com/filegator/static/raw/master/builds/filegator_v7.0.0-RC2.zip)
- 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
## Documentation
[Check out the documentation](https://docs.filegator.io/)
## Project setup for development
```
git clone git@github.com:filegator/filegator.git
cd filegator
cp configuration_sample.php configuration.php
sudo chmod -R 777 private/
sudo chmod -R 777 repository/
composer install
npm install
npm run build
```
### Compiles and hot-reloads (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.
## Security
If you discover any security related issues, please email alcalbg@gmail.com instead of using the issue tracker.

View File

@@ -1,5 +1,20 @@
## 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 store your users inside mysql database (default is json file).
You can use mysql database to store your users.
First, create a table ```users``` with this sql:
```
@@ -39,3 +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.

View File

@@ -18,7 +18,7 @@ You can add additional html to the head and body like this:
```
## 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

View File

@@ -1,5 +1,7 @@
## 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
@@ -12,7 +14,9 @@ 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
@@ -28,5 +32,5 @@ 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.

View File

@@ -7,8 +7,7 @@
- Latest: [v7.0.0-RC2](https://github.com/filegator/static/raw/master/builds/filegator_v7.0.0-RC2.zip)
- 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