For running app make sure you have:
- PHP >= 8.1
- MySQL 5.6+
- Nginx or Apache (Nginx recommended)
These PHP Extensions are require:
- finfo
- Intl
- GD
- BCMath
- PDO
- SQLite3
- Ctype
- Fileinfo
- JSON
- Mbstring
- OpenSSL
- Tokenizer
- XML
- Exif
Upload project files to the web root folder of your domain. It's mostly located in html, www or public_html folder name.
Configure your domain document root to the point of the files you previously uploaded directly into /public folder. So, if you uploaded files into /public_html folder, your document root must be set as /public_html/public. It should look like this
Don't forget to enable Force HTTPS Redirect.
Set 755 permission (CHMOD) to these files and folders directory within all children subdirectories:
- /bootstrap
- /storage
- /.env
Then open your application in web browser. If everything works fine, you will be redirected to the setup wizard installation process.
On the first page you will see server check. Make sure all items are green. If not, then correct your server setup by recommended values and refresh your setup wizard page.
That was the hardest part of installation process. Please follow instructions in every step of Setup Wizard to successfully install VueFileManager.
- Create new cron job
- Set execution cycle for every minute
- Login to the VueFileManager as admin and go to the admin dashboard, you will see command which you have to copy and paste into the command input.
- Go to the terminal and run command
crontab -e - Login to the VueFileManager as admin and go to the admin dashboard, you will see command which you have to copy and paste into the end of file.
- Leave crontab and save the file.
In your s3 bucket settings you should have option to set up your CORS (Cross-Origin Resource Sharing). It's basically adding your app url to the list of allowed CORS. This step is required for reading pdf documents from s3 in your VueFileManager app without loading issues.
- Replace all files where the app is located except
/storagefolder and.envfile. - Clear the application cache (Admin / Settings / Application).
- In 5 minutes the app update stuff automatically on the background if needed.
If you running VueFileManager under 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;
}
}
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>
If you move your VueFileManager application into another domain or subdomain, you have to manually change values in your .env file.
- Open your
/.envfile. - Find
APP_URLvariable and write your new domain location. Don't forget start with defininghttps://protocol. - Find
SANCTUM_STATEFUL_DOMAINSvariable and write your new domain location without http protocol. - Remove your cached config file which is located
/bootstrap/cache/config.php.
If you'd like to allow your users to authenticate via their social accounts, the setup is pretty convenient. Just don't forget to set up redirect url and required permissions.
- Name and profile picture
Database backups should run automatically every day with default set up.
If you spot that database backups aren't showing in your admin settings/server location after a 2 days (make sure your cron is running), you have to find path to mysqldump program on your hosted server. Most of the servers has placed this program in location /usr/local/bin/ but yours can be different.
If you don't know where the mysqldump extension is, please contact your webhosting provider. If you find the correct path, then open your /.env file and update DB_MYSQLDUMP_PATH variable. The backups should run on the next days.
To set up your subscription, please follow these steps below.
- If you didn't set up your subscription type in Setup Wizard, go to the
Admin / Settings / Applicationand find subscription widget. Next set value asFixed. - Go to the
Admin / Billingsand fill the inputs with your billing information. - Go to the
Admin / Paymentsand turn on the switchAllow Subscription Payments. - Set up credentials for all payment gateway you want. If you set production mode, make sure you fill your credentials with production keys, and vice versa. If needed, don't forget to turn on
live modefor PayPal. - Set up your webhooks, you can find your webhook url in payment gateway widget.
- Go to the
Admin / Plansand create your first plan. Make sure all payment gateways support the currency you want, especially for Paystack, it supports onlyGHS, NGN, USD and ZAR.
- Go to the
Admin / Paymentsand set up credentials for all payment gateway you want with production keys type. Don't forget to turn onlive modefor PayPal. - Go to the
Admin / Plansand delete all your previously created plans. They will be archived. - Create new production plans you want offer.
- CustomerSubscriptionCreated
- CustomerSubscriptionUpdated
- CustomerSubscriptionDeleted
- InvoicePaymentSucceeded
- InvoicePaymentActionRequired
- PaymentMethodAttached
- PaymentIntentSucceeded
- BillingSubscriptionCreated
- BillingSubscriptionActivated
- BillingSubscriptionUpdated
- BillingSubscriptionCancelled
- PaymentSaleCompleted
- CheckoutOrderApproved
Broadcasting is responsible for real time app experience. If broadcasting is set, you will be able to get just in time updates in your app.
For example, remote upload works on the background, while the files are downloading and showing in your view immediately after they are ready without refreshing the app. Or, you will get immediately notifications about new events like team invitations, file requests and many more.
More real time features will be implemented in incoming updates.
VueFileManager support 2 types of connections:
- Pusher - Suitable for all users and all hosting platforms
- VueFileManager Broadcast Server - Free of charge, suitable for experienced users, limited for VPS servers
We strongly recommend only for experienced users to set up and running VueFileManager broadcast server. For others, we recommend to use Pusher service to easy set up and host broadcasting service.
For running app make sure you have:
- VPS server with SSH access
- PHP >= 8.0.2 version (8.1+ recommended)
- Nginx
- Supervisor
- Certbot
We assume you have installed and running properly your VPS server.
Upload VueFileManager into your server, for example path directory /var/www/sockets would be great. Next connect to your server with ssh and change your terminal directory into VueFileManager:
cd /var/www/sockets
Run installation command for websocket server. You will be prompted to type host of which you want to allow incoming requests.
php artisan websockets:install
Create subdomain for your socket host, for example socket.vuefilemanager.com and direct this subdomain to your vps where socket server will be running.
Then, create nginx config for your subdomain:
nano /etc/nginx/sites-available/socket.conf
And paste the template below, just replace subdomain with yours:
server {
listen 80;
server_name socket.vuefilemanager.com;
location / {
proxy_pass http://127.0.0.1:6001;
proxy_read_timeout 60;
proxy_connect_timeout 60;
proxy_redirect off;
# Allow the use of websockets
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection 'upgrade';
proxy_set_header Host $host;
proxy_cache_bypass $http_upgrade;
}
}
Enable your created config by this command:
ln -s /etc/nginx/sites-available/socket.conf /etc/nginx/sites-enabled/
Restart your nginx:
systemctl restart nginx
In the last step, install ssl certificate for your previously created subdomain with certbot:
certbot --nginx
We need supervisor to manage running your websocket server on the background.
In /etc/supervisor/conf.d (Debian/Ubuntu) or /etc/supervisord.d/ (Red Hat/CentOS) create a file websockets.conf.
Just edit php path, project path and user when they are different for your vps:
[program:websockets]
command=/usr/bin/php /var/www/socket/artisan websockets:serve
numprocs=1
autostart=true
autorestart=true
user=www-data
Run command below to start your websocket server:
supervisorctl start websockets
Run command below to stop your websocket server:
supervisorctl stop websockets
When you update code or server for some reason, you must also update running supervisor:
supervisorctl reload
Log in to your VueFileManager admin account and go to Admin / Settings / Environment.
Find Broadcasting form and select VueFileManager as broadcasting driver. Set your hostname and save the form.
That's all, you are running your own Broadcast server.
For running development environment make sure you have:
- Node >= 14
- NPM >= 6
If you would like to have express installation without Setup Wizard process, please update your database credentials in .env file
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=laravel
DB_USERNAME=root
DB_PASSWORD=
Next, run this command below. Admin account will be created with credentials howdy@hi5ve.digital and password vuefilemanager.
php artisan setup:prod
If you would like to generate demo content, run this command below. Admin account will be created with credentials howdy@hi5ve.digital and password vuefilemanager.
php artisan setup:dev
If you would like to generate demo content for the subscription with the metered billing, run this command below.
php artisan subscription:demo metered
If you would like to generate demo content for the subscription with the fixed billing, please fill the credentials in your .env file for the payment systems you'd like to use:
STRIPE_SECRET_KEY=
STRIPE_PUBLIC_KEY=
STRIPE_WEBHOOK_SECRET=
PAYSTACK_SECRET=
PAYSTACK_PUBLIC_KEY=
PAYPAL_CLIENT_ID=
PAYPAL_CLIENT_SECRET=
PAYPAL_WEBHOOK_ID=
PAYPAL_IS_LIVE=false
and then run this command to generate demo content for fixed subscription:
php artisan subscription:demo fixed
After installation, please make sure your current host/domain where you are running app is included in your .env file in SANCTUM_STATEFUL_DOMAINS variable.
To start server on your localhost, run command below.
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
The following support channels are available at your fingertips:
We are trying to make the best for VueFileManager. There are a lot of 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 us. There is couple way you can support us, and then, we support you with all great new features we can make. Thank you for participating on this awesome application!
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.
Sorry guys i have 2 issues...
but for me is impossible to find this issue...
Someone can help me? maybe in pvt, maybe here it is not the right place to talk about the issue.