mirror of
https://github.com/VueFileManager/vuefilemanager.git
synced 2026-04-05 18:23:48 +00:00
v1.7 RC.1
This commit is contained in:
133
README.md
133
README.md
@@ -2,18 +2,29 @@
|
||||
|
||||
## Contents
|
||||
|
||||
- [Server Requirements](#server-requirements)
|
||||
- [Installation](#installation)
|
||||
- [Installation Failed](#installation-failed)
|
||||
- [Update VueFileManager](#update-vuefilemanager)
|
||||
- [For Developers](#for-developers)
|
||||
- [Supported Storages](#supported-storages)
|
||||
- [How to Create New Language](#how-to-create-new-language)
|
||||
- [Changelog](#changelog)
|
||||
- [GitHub Repository](#github-repository)
|
||||
- [Support](#support)
|
||||
- [Security Vulnerabilities](#security-vulnerabilities)
|
||||
- [Server Requirements](#server-requirements)
|
||||
- [Installation](#installation)
|
||||
- [PHP Configuration](#php-configuration)
|
||||
- [Nginx Configuration](#nginx-configuration)
|
||||
- [Apache Configuration](#apache-configuration)
|
||||
- [Recover Failed Installation](#installation-failed)
|
||||
- [Update VueFileManager from 1.6.x to 1.7 ](#update-vuefilemanager)
|
||||
- [Payments](#payments)
|
||||
- [Get your active plans](#get-your-active-plans)
|
||||
- [Manage Failed Payments](#manage-failed-payments)
|
||||
- [Technical Informations](#technical-informations)
|
||||
- [For Developers](#for-developers)
|
||||
- [Supported Storages](#supported-storages)
|
||||
- [How to Create New Language](#how-to-create-new-language)
|
||||
- [Others](#others)
|
||||
- [Changelog](#changelog)
|
||||
- [GitHub Repository](#github-repository)
|
||||
- [Support](#support)
|
||||
- [Security Vulnerabilities](#security-vulnerabilities)
|
||||
|
||||
|
||||
# Installation
|
||||
## Server Requirements
|
||||
|
||||
|
||||
@@ -54,6 +65,77 @@ At first step you have to verify your purchase code. **Subscription service with
|
||||
|
||||
That was the hardest part of installation proces. Please follow instructions in every step of Setup Wizard to successfully install VueFileManager.
|
||||
|
||||
## PHP Configuration
|
||||
There are several PHP settings good to know to setup before you try upload any file. Please set these values in your php.ini, we provide minimal setup for you. When you set `-1` then you set infinity limits.
|
||||
|
||||
```
|
||||
memory_limit = 512M
|
||||
upload_max_filesize = 1024M
|
||||
post_max_size = 1024M
|
||||
max_file_uploads = 50
|
||||
```
|
||||
|
||||
## Nginx Configuration
|
||||
If you running VueFileManager undex Nginx, don't forget set this value in your `nginx.conf` file:
|
||||
```
|
||||
http {
|
||||
client_max_body_size 1024M;
|
||||
}
|
||||
```
|
||||
|
||||
And example Nginx config for your domain:
|
||||
```
|
||||
server {
|
||||
listen 80;
|
||||
listen [::]:80;
|
||||
|
||||
# Log files for Debugging
|
||||
access_log /var/log/nginx/laravel-access.log;
|
||||
error_log /var/log/nginx/laravel-error.log;
|
||||
|
||||
# Webroot Directory for Laravel project
|
||||
root /var/www/vuefilemanager/public;
|
||||
index index.php index.html index.htm;
|
||||
|
||||
# Your Domain Name
|
||||
server_name example.com;
|
||||
location / {
|
||||
try_files $uri $uri/ /index.php?$query_string;
|
||||
}
|
||||
|
||||
# PHP-FPM Configuration Nginx
|
||||
location ~ \.php$ {
|
||||
try_files $uri =404;
|
||||
fastcgi_split_path_info ^(.+\.php)(/.+)$;
|
||||
fastcgi_pass unix:/run/php/php7.3-fpm.sock;
|
||||
fastcgi_index index.php;
|
||||
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
|
||||
include fastcgi_params;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Apache Configuration
|
||||
Make sure you have enabled mod_rewrite. There is an example config for running VueFileManager under apache:
|
||||
|
||||
```
|
||||
<VirtualHost example.com:80>
|
||||
DocumentRoot /var/www/vuefilemanager/public
|
||||
ServerName example.com
|
||||
|
||||
<Directory "/var/www/vuefilemanager/public">
|
||||
AllowOverride All
|
||||
allow from all
|
||||
Options +Indexes
|
||||
Require all granted
|
||||
</Directory>
|
||||
|
||||
RewriteEngine on
|
||||
RewriteCond %{SERVER_NAME} =example.com
|
||||
RewriteRule ^ https://%{SERVER_NAME}%{REQUEST_URI} [END,NE,R=permanent]
|
||||
</VirtualHost>
|
||||
```
|
||||
|
||||
## Installation Failed
|
||||
|
||||
What to do when installation fail and you can't continue, at first, try to fix issue why installation fail. Probably missing PHP extension or permissions wasn't set correctly.
|
||||
@@ -62,14 +144,40 @@ At worst scenarios, to reset Setup Wizard, delete all tables in your previously
|
||||
|
||||
After these steps, installation will be reseted.
|
||||
|
||||
## Update VueFileManager
|
||||
Don't forget create backup of your database and storage before make any changes in your production application.
|
||||
## Update VueFileManager from 1.6.x to 1.7
|
||||
`Don't forget create backup of your database and storage before make any changes in your production application.`
|
||||
|
||||
For those, who purchase extended licence, place these lines at the end of your `/.env` file:
|
||||
```
|
||||
CASHIER_LOGGER=stack
|
||||
CASHIER_CURRENCY=
|
||||
STRIPE_KEY=
|
||||
STRIPE_SECRET=
|
||||
STRIPE_WEBHOOK_SECRET=
|
||||
CASHIER_PAYMENT_NOTIFICATION=App\Notifications\ConfirmPayment
|
||||
```
|
||||
|
||||
Then follow this steps:
|
||||
|
||||
- Make sure you have PHP >= 7.2.5 version
|
||||
- Make a backup of the .env config file located on your server.
|
||||
- Upload and replace all the files on your server with what's inside the app folder.
|
||||
- Restore your `.env` config file on your server.
|
||||
- Go to https://your-domain.com/upgrade and follow the setup wizard instructions.
|
||||
|
||||
#Payments
|
||||
VueFileManager is packed with **Stripe** payment options. To configure Stripe, you will be asked in Setup Wizard to set up. Or, if you skip this installation process, you will find stripe set up in you admin `Dashboard / Settings / Payments`.
|
||||
|
||||
## Get your active plans
|
||||
Would you like to get your subscription plans for your custom front-end page? Create GET request and get all your active plans:
|
||||
```
|
||||
GET /api/public/pricing
|
||||
```
|
||||
|
||||
## Manage Failed Payments
|
||||
VueFileManager manage failed payments with additional email notification. But, there is more you can do for better User Experience. There is some additionals option in Stripe, look on [prevent failed payments](https://dashboard.stripe.com/settings/billing/automatic).
|
||||
|
||||
# Technical Informations
|
||||
## For Developers
|
||||
Installation process on your localhost is the same. But, there are some good hints.
|
||||
|
||||
@@ -160,6 +268,7 @@ To set your locale in app, go to `/config/app.php` and set your locale string in
|
||||
|
||||
**Small hint:** We use for translating localizations this awesome software, [check it](https://www.codeandweb.com/babeledit).
|
||||
|
||||
# Others
|
||||
## Changelog
|
||||
|
||||
Refer to the [Changelog](https://vuefilemanager.com/changelog) for a full history of the project.
|
||||
|
||||
Reference in New Issue
Block a user