8.6 KiB
Private Cloud Storage Build on Laravel & Vue.js
Contents
Installation
Server Requirements
For running app make sure you have installed:
- PHP >= 8.0.2 version
- MySQL 5.6+
- Nginx or Apache
These PHP Extensions are require:
- Intl
- GD
- BCMath
- PDO
- SQLite
- Ctype
- Fileinfo
- JSON
- Mbstring
- OpenSSL
- Tokenizer
- XML
- Exif
Installation
1. Upload files on your server
Upload project files to web root folder of your domain. It's mostly located in html, www or public_html folder name.
2. Configure your web root folder
Configure your web server's document root to point to the public directory of the files you previously uploaded. For example, if you've uploaded the files in html folder, your domain root directory should be changed to html/project_files/public folder or anything else where domain root is in project /public directory.
Please don't try go to yourdomain.com/public URL address, you will have issue to verify your purchase code, this is not correct domain root setup, you must do this in your webhosting settings panel.
3. Check your .env file
Make sure .env file was uploaded. This type of file can be hidden in default.
4. Set write permissions
Set 755 permission (CHMOD) to these file and folders directory within all children subdirectories:
- /bootstrap/cache
- /storage
- /.env
5. Open your application in your web browser
Then open your application in web browser. If everything works fine, you will be redirect to setup wizard installation process.
At first step you have to verify your purchase code. Subscription service with stripe payments is available only for Extended License. If you can't verify your purchase code, check, if you did previously steps correctly.
6. Follow setup wizard steps
That was the hardest part of installation proces. Please follow instructions in every step of Setup Wizard to successfully install VueFileManager.
7. Set up Cron
Add the following Cron entry to your server. Just update your php path (if it's different) and project path:
* * * * * /usr/local/bin/php /path-to-your-project/artisan schedule:run >> /dev/null 2>&1
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 = 128M
post_max_size = 128M
max_file_uploads = 50
max_execution_time = 3600
Chunk & Multipart Upload
VueFileManager in default supporting chunk upload. Default chunk upload size is 128MB. If you wish change this default value, go to your .env and change CHUNK_SIZE attribute.
When you use external storage, and upload large files, to prevent failing upload process make sure you have enough space in your application space and set higher max_execution_time in your php.ini to move your files to external storage.
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>
Upgrade Guide
Common Instructions
Don't forget create backup of your database before make any changes in your production application. If you serve your files in local storage driver pay attention and don't delete your /storage folder!
These instructions is applicable for all updates. Please follow this step:
- Just rewrite all project files with new excluded
/.envfile and/storagefolder. These items must be preserved!
Developers
Running development environment on your localhost
To start server on your localhost, run command below. Then go to your generated localhost URL by terminal, and follow Setup Wizard steps to configure VueFileManager.
php artisan serve
For developing Vue front-end, you have to install npm modules by this command:
npm install
To compiles and hot-reloads for front-end development. Then run this command:
npm run hot
To compiles for production build, run this command
npm run prod
Supported Storages
VueFileManager support these storages for your files:
- Amazon Web Services S3
- Digital Ocean Spaces
- Object Cloud Storage by Wasabi
- Backblaze B2 Cloud Storage
- Your local disk
In case of installation process, you will be able to set storage driver and credentials. After this, you can change your credentials later in /.env file.
To set or change your storage driver, you have to edit FILESYSTEM_DRIVER in your /.env file. Supported drivers are s3, spaces, wasabi,backblaze or local:
FILESYSTEM_DRIVER=local
Then you can find corresponding credentials options for your storage driver like key, secret, region in /.env file.
Others
Changelog
Refer to the Changelog for a full history of the project.
GitHub Repository
Join our GitHub repository to submit your issues or suggestions, track VueFileManager progress and get new updates as fast as possible.
Support
The following support channels are available at your fingertips:
Supporting VueFileManager
Hi, we are trying make the best experience with VueFileManager. There is a lot things to do, and a lot of features we can make.
But, it can't be done without you, development is more and more complicated and we have to hire new colleagues to help with it. There is couple way you can support us, and then, we support you with all great new features which can be. Thanks you for participating on this awesome software!
Security Vulnerabilities
If you discover a security vulnerability within this project, please send an e-mail to peterpapp@makingcg.com. All security vulnerabilities will be promptly addressed.