JobClass documentation

Installation

PHP 7.3 or greater (with all default PHP functions enabled including exec(), etc.)
MySQL 5.6 or greater (The MySQL user need to have a full privilege to manage the database)
BCMath PHP Extension
Ctype PHP Extension
Fileinfo PHP extension
JSON PHP Extension
Mbstring PHP Extension
OpenSSL PHP Extension
PDO PHP Extension
Tokenizer PHP Extension
XML PHP Extension
GD PHP Extension (or Imagick PHP Extension)
PHP Zip Archive
Rewrite Module (Apache or Nginx)

open_basedir must be disabled

/bootstrap        775
/storage          775 (recursively)

Installation with Apache

Creating a new Database

First thing you want to do before installing JobClass is to create a new database on your mysql server. If you already know how to do this/or have already created one just skip to the next step.

Your hosting provider will most likely have phpMyAdmin as mysql manager. If that is the case here is a step by step guide (if not the process will be very similar on other managers).

Login to your control panel, find and click phpMyAdmin link.

Click on the database tab in the top menu, enter any name for your database and click create.

Uploading Files

After creating a database, unzpip the file you donwloaded from CodeCanyon and upload the contents of JobClass folder to your server root, usually called /path/to/www/ or /path/to/html/ or /path/to/httpdocs/ or /path/to/public_html/.

Launch the Installer

After you created a database and uploaded the files, simply open up your site in the browser (like http://mysite.com, you will redirect to http://mysite.com/install) and follow on-screen instructions to complete the installation.

Installation with Nginx

• Put all the JobClass package files to your server root, usually /path/to/www/ or /path/to/html/ or /path/to/httpdocs/ or /path/to/public_html/ and set your server configuration like this:

root "/path/to/www/public";
location / {
   try_files $uri $uri/ /index.php?$query_string;
}

• Then restart Nginx.
• Create a MySQL database, add user to it with full permissions.
• Go to the script's installation URL. For example http://mysite.com/install
• And follow the web installation wizard.

Installation on localhost

• You have to create a local virtual host by using a domain name (eg. http://mysite.localhost) instead of localhost (http://localhost/mysite).
  For more information, please see this article: Using a domain name instead of localhost with XAMPP, WAMP or MAMP.
• Restart your server.
• Create a MySQL database, add user to it with full permissions.
• Go to the script's installation URL. For example http://mysite.localhost/install
• And follow the web installation wizard.

Upgrade to new versions

Upgrade

1. Download the latest version from CodeCanyon.
2. Copy the .zip file you have downloaded to the root of your server (same place where files were uploaded during installation).
3. Extract the .zip file (you have uploaded) into the root directory and overwrite old files.
4. (If you have installed any plugins) Update them to their latest version.
5. Visit the URL http://yoursite.com/upgrade and click Upgrade Now button (Make sure you are logged in as admin).
6. Once update is completed you will be redirected back to homepage.

Upgrade Notes

SMTP

Short for Simple Mail Transfer Protocol, a protocol for sending e-mail messages between servers. Most e-mail systems that send mail over the Internet use SMTP to send messages from one server to another; the messages can then be retrieved with an e-mail client using either POP or IMAP. In addition, SMTP is generally used to send messages from a mail client to a mail server. This is why you need to specify both the POP or IMAP server and the SMTP server when you configure your e-mail application.

• Your own hosting SMTP server
• Mandrill
• Amazon SES
• Mailgun
• Sparkpost
• Gmail, Yahoo or some other email provider

Own SMTP Server

• Go to your Admin panel -> Settings -> General -> Mail
• Set 'Mail Mailer', 'Mail Host', 'Mail Port', 'Mail Encryption', 'Mail Username' and 'Mail Password'
• And save your changes.

• Login to your FTP account.
• Open and Edit /.env file.
• Copy and paste your server smtp details in the file.

MAIL_MAILER=smtp
MAIL_HOST=your-mail-host
MAIL_PORT=your-mail-port
MAIL_USERNAME=your-mail-username
MAIL_PASSWORD=your-mail-password
MAIL_ENCRYPTION=your-mail-encryption

• Replace your-mail-host, your-mail-port, your-mail-username, your-mail-password and your-mail-encryption.
• Save and Upload the file
• You are done.

Mailgun

• Go to your Admin panel -> Settings -> General -> Mail
• Set 'Mail Mailer', 'Mailgun Domain', 'Mailgun Secret', 'Mail Host', 'Mail Port', 'Mail Encryption', 'Mail Username' and 'Mail Password'
• And save your changes.

• Login to your FTP account.
• Open and edit /.env file.
• Remove all your current Mail configuration variables.
• Add the lines below:

MAIL_MAILER=mailgun
MAILGUN_DOMAIN=your-mailgun-domain
MAILGUN_SECRET=your-mailgun-secret
MAIL_HOST=your-mailgun-smtp-host
MAIL_PORT=your-mailgun-smtp-port
MAIL_USERNAME=your-mailgun-smtp-username
MAIL_PASSWORD=your-mailgun-smtp-password
MAIL_ENCRYPTION=your-mailgun-smtp-encryption

• Replace your-mailgun-domain, your-mailgun-secret, your-mailgun-smtp-host, your-mailgun-smtp-port, your-mailgun-smtp-username, your-mailgun-smtp-password and your-mailgun-smtp-encryption.
• Save and upload the file.
• You are done.

Postmark

• Go to your Admin panel -> Settings -> General -> Mail
• Set 'Mail Mailer', 'Postmark Token', 'Mail Host', 'Mail Port', 'Mail Encryption', 'Mail Username' and 'Mail Password'
• And save your changes.

• Login to your FTP account.
• Open and edit /.env file.
• Remove all your current Mail configuration variables.
• Add the lines below:

MAIL_MAILER=postmark
POSTMARK_TOKEN=your-postmark-token
MAIL_HOST=your-postmark-smtp-host
MAIL_PORT=your-postmark-smtp-port
MAIL_USERNAME=your-postmark-smtp-username
MAIL_PASSWORD=your-postmark-smtp-password
MAIL_ENCRYPTION=your-postmark-smtp-encryption

• Replace your-postmark-secret, your-postmark-smtp-host, your-postmark-smtp-port, your-postmark-smtp-username, your-postmark-smtp-password and your-postmark-smtp-encryption.
• Save and upload the file.
• You are done.

Amazon SES

• Go to your Admin panel -> Settings -> General -> Mail
• Set 'Mail Mailer', 'SES Key', 'SES Secret' and 'SES Region'
• And save your changes.

• Login to your FTP account.
• Open and edit /.env file.
• Remove all your current Mail configuration variables.
• Add the lines below:

MAIL_MAILER=ses
SES_KEY=your-ses-key
SES_SECRET=your-ses-secret
SES_REGION=your-ses-region

• Replace your-ses-key, your-ses-secret and your-ses-region.
• Save and upload the file.
• You are done.

Mandrill

• Visit mandrill dashboard.
• Generate a API key, via this page https://mandrillapp.com/settings/
• Copy the key.

• Go to your Admin panel -> Settings -> General -> Mail
• Set 'Mail Mailer', 'Mandrill Secret', 'Mail Host', 'Mail Port', 'Mail Encryption', 'Mail Username' and 'Mail Password'
• And save your changes.

• Login to your FTP account.
• Open and edit /.env file.
• Remove all your current Mail configuration variables.
• Add the lines below:

MAIL_MAILER=mandrill
MANDRILL_SECRET=your-mandrill-secret
MAIL_HOST=your-mandrill-smtp-host
MAIL_PORT=your-mandrill-smtp-port
MAIL_USERNAME=your-mandrill-smtp-username
MAIL_PASSWORD=your-mandrill-smtp-password
MAIL_ENCRYPTION=your-mandrill-smtp-encryption

• Replace your-mandrill-secret, your-mandrill-smtp-host, your-mandrill-smtp-port, your-mandrill-smtp-username, your-mandrill-smtp-password and your-mandrill-smtp-encryption.
• Save and upload the file.
• You are done.

Sparkpost

• Go to your Admin panel -> Settings -> General -> Mail
• Set 'Mail Mailer', 'Sparkpost Secret', 'Mail Host', 'Mail Port', 'Mail Encryption', 'Mail Username' and 'Mail Password'
• And save your changes.

• Login to your FTP account.
• Open and edit /.env file.
• Remove all your current Mail configuration variables.
• Add the lines below:

MAIL_MAILER=sparkpost
SPARKPOST_SECRET=your-sparkpost-secret
MAIL_HOST=your-sparkpost-smtp-host
MAIL_PORT=your-sparkpost-smtp-port
MAIL_USERNAME=your-sparkpost-smtp-username
MAIL_PASSWORD=your-sparkpost-smtp-password
MAIL_ENCRYPTION=your-sparkpost-smtp-encryption

• Replace your-sparkpost-secret, your-sparkpost-smtp-host, your-sparkpost-smtp-port, your-sparkpost-smtp-username, your-sparkpost-smtp-password and your-sparkpost-smtp-encryption.
• Save and upload the file.
• You are done.

Payment Providers

The script support these payment providers:

• Paypal

Paypal is one of the best payment gateway in the world, it support all credit cards and accepted in many countries.

Paypal

Visit the official documentation: https://developer.paypal.com/developer/applications/create

Setup

• Copy and paste the API username, password, and signature into the /.env file.
• Open and edit the /.env file by providing your keys like this:

PAYPAL_MODE=sandbox
PAYPAL_USERNAME=yourPayPalBusinessEamil@something.com
PAYPAL_PASSWORD=YourPassword
PAYPAL_SIGNATURE=YourSignatrue

• You have to use PAYPAL_MODE=live in your live server.
• You are done.

Now visit Admin Panel -> Payment -> Packages to set the packages and currencies.

SMS APIs

This functionality is only available in the version v2.0+, allowing to verify the mobile number of the users and offering the possibility to the sellers to be contacted by SMS.

How to set up?

• Admin panel -> Settings -> General -> Mail -> 'SMS Driver' to set the default SMS API.
• You can use both NEXMO or TWILIO as your SMS provider API:

NEXMO

NEXMO - https://www.nexmo.com

• Go to your Admin panel -> Settings -> General -> SMS
• Set 'Nexmo Key', 'Nexmo Secret' and 'Nexmo From'
• And save your changes.

• Login to your FTP account.
• Open and edit /.env file.
• Remove all your current Mail configuration variables.
• Add the lines below:

NEXMO_KEY=your-nexmo-key
NEXMO_SECRET=your-nexmo-secret
NEXMO_FROM=your-sender-number

TWILIO

TWILIO - https://www.twilio.com

• Go to your Admin panel -> Settings -> General -> SMS
• Set 'Twilio Account SID', 'Twilio Auth Token' and 'Twilio From'
• And save your changes.

• Login to your FTP account.
• Open and edit /.env file.
• Remove all your current Mail configuration variables.
• Add the lines below:

TWILIO_ACCOUNT_SID=your-twilio-account-sid
TWILIO_AUTH_TOKEN=your-auth-token
TWILIO_FROM=your-sender-number

Others SMS Configurations

Now, go to your Admin panel :

• Admin panel -> Settings -> General -> SMS -> 'Enable Phone Verification' to enabling/disabling the mobile Phone number verification.
• Admin panel -> Settings -> General -> SMS -> 'Enable SMS Message' to enabling/disabling the SMS sending between users.

You are done.

Social Login

Facebook

1. Register for regular Facebook account, if you don't already have one.
2. Open this url, and Create a New App.
3. Get the new app settings.

Now, you have to setup your admin panel:

• Go to your Admin panel -> Settings -> General -> Social Login
• For Facebook: set 'Facebook Client ID' and 'Facebook Client Secret'
• And save your changes.
• You are done.

Or place all the config values or API keys in the /.env file.

Facebook example in /.env file

FACEBOOK_CLIENT_ID=your-facebook-client_id
FACEBOOK_CLIENT_SECRET=your-facebook-client_secret

NOTE:

• The /.env file settings override those of the admin panel.
• The "OAuth redirect URI" is: (http:// or https://) domain.tld/auth/facebook/callback or www.domain.tld/auth/facebook/callback

LinkedIn

1. Register for regular LinkedIn account, if you don't already have one.
2. Open this url, and Create a New App.
3. Get the new app settings.

Now, you have to setup your admin panel:

• Go to your Admin panel -> Settings -> General -> Social Login
• For LinkedIn: set 'LinkedIn Client ID' and 'LinkedIn Client Secret'
• And save your changes.
• You are done.

Or place all the config values or API keys in the /.env file.

LinkedIn example in /.env file

LINKEDIN_CLIENT_ID=your-linkedin-client_id
LINKEDIN_CLIENT_SECRET=your-linkedin-client_secret

NOTE:

• The /.env file settings override those of the admin panel.
• The "OAuth redirect URI" is: (http:// or https://) domain.tld/auth/linkedin/callback or www.domain.tld/auth/linkedin/callback

Twitter

1. Register for regular Twitter account, if you don't already have one.
2. Open this url, and Create a New App.
3. Get the new app settings.

Now, you have to setup your admin panel:

• Go to your Admin panel -> Settings -> General -> Social Login
• For Twitter: set 'Twitter Client ID' and 'Twitter Client Secret'
• And save your changes.
• You are done.

Or place all the config values or API keys in the /.env file.

Twitter example in /.env file

TWITTER_CLIENT_ID=your-twitter-client_id
TWITTER_CLIENT_SECRET=your-twitter-client_secret

NOTE:

• The /.env file settings override those of the admin panel.
• The "OAuth redirect URI" is: (http:// or https://) domain.tld/auth/twitter/callback or www.domain.tld/auth/twitter/callback
• And before configuring your Twitter app in the script, you have to change its Permissions (on developer.twitter.com) by enabling the "Request email address from users" option.

Google (deprecated)

1. Register for regular Google account, if you don't already have one.
2. Open this url, and Create a New App.
3. Get the new app settings.

Now, you have to setup your admin panel:

• Go to your Admin panel -> Settings -> General -> Social Login
• For Google: set 'Google Client ID' and 'Google Client Secret'
• And save your changes.
• You are done.

Or place all the config values or API keys in the /.env file.

Google example in /.env file

GOOGLE_CLIENT_ID=your-google-client_id
GOOGLE_CLIENT_SECRET=your-google-client_secret

NOTE:

• The /.env file settings override those of the admin panel.
• The "OAuth redirect URI" is: (http:// or https://) domain.tld/auth/google/callback or www.domain.tld/auth/google/callback

Google Maps

You have to activate Google Maps Embed API and Google Maps JavaScript API in your Google Console.

Admin panel setup

• Go to your Admin panel -> Settings -> General -> Others
• Set ‘Google Maps key‘
• And save your changes.

Or use /.env file setup

• Login to your FTP account.
• Open and edit .env file.
• Add this code:

GOOGLE_MAPS_API_KEY=your-googlemaps-key

• Replace your-googlemaps-key.
• Save and upload the file.
• You are done.

Captcha

Recaptcha Key

What is recaptcha

reCAPTCHA is a free CAPTCHA service that helps protect your site against spam, malicious registrations and other forms of attacks where computers try to disguise themselves as a human. reCAPTCHA comes in the form of a widget that you can easily add to your blog, forum, registration.

• Visit https://www.google.com/recaptcha/admin
• Follow the steps by select the reCAPTCHA version and get your site key and your secret key.

Admin panel setup

• Go to the Admin panel -> Settings -> General -> Security
• Enable the feature from the 'Enable reCAPTCHA' field
• Set 'reCAPTCHA version', 'reCAPTCHA site key' and 'reCAPTCHA secret key'
• And save your changes.

Or use /.env file setup

• Login to your FTP account
• Open /.env file.
• Provide the keys there.

RECAPTCHA_VERSION=your-recaptcha-keys-version
RECAPTCHA_SITE_KEY=your-recaptcha-site_key
RECAPTCHA_SECRET_KEY=your-recaptcha-secret_key

• Replace your-recaptcha-keys-version (by v2 or v3), replace your-recaptcha-site_key and your-recaptcha-secret_key by your keys.
• Save the file.
• You are done.

NOTE: The /.env file settings override those of the admin panel.

Image Processing

Image Setting

The script support for two image processor.

• GD
• Imagick

GD is very basic image resizing driver for PHP and only to used on basic website. It has memory issues and doesn't perform well at all conditions.
If you want your site for pro-photography or better quality images we prefer you to use imagick instead for better quality results.
Please make sure that your server has imagick installed.

Imagick

First make sure that you have imagick installed on your server, if not then contact your hosting provider.

• Login to your FTP account.
• Open and edit /.env file.

IMAGE_DRIVER=gd

IMAGE_DRIVER=imagick

• You are done.

Geo location

How can I enable Geo location?

• Visit the Admin panel -> Settings -> General -> Geo Location and turn 'Enable Geolocation' to ON by checking the checkbox.
• If you want to redirect users to their country's website based on their IP address, you should leave blank the parameter "Default Country" in your Admin panel -> Settings -> General -> Geo Location. ATTENTION: When you reset this option by setting a default country, you need erase all your browser's data (like: historic, hosted app's data and cache, etc.) to see the effect of the change.
• (Optional) Go to: https://dev.maxmind.com/geoip/geoip2/geolite2/
• (Optional) Download the latest binary version of the 'GeoLite2 City' database.
• (Optional) Extract it in the Maxmind database folder at /storage/database/maxmind/ like this /storage/database/maxmind/GeoLite2-City.mmdb
  You can replace the current file (if exists) to update the Maxmind database.
• You are done.

NOTE: It's important to note that the lite (free) versions of the Maxmind databases are not accurate. Please check out this link for more information: https://support.maxmind.com/geolite-faq/.

SVG Maps

The script uses Simplemaps SVG maps (http://simplemaps.com/resources/svg-maps). And the map of some countries (Kosovo, some islands, etc.) are not available.

For some countries you need to edit the SVG files to change some states or provinces name etc. You can find all the SVG maps files in the /public/images/maps/ directory.

There are a free (commercial use) license and a paid license. So you can buy a license for some missing SVG maps and hire a local developer to add them for your website (based on current code). You can also disable the SVG maps from your Admin panel.

Countries Data

Geonames Database

It is important to know that the script uses Geonames database (http://www.geonames.org) (their most structured database) for data on cities and administrative divisions.

But, sadly, this database is not complete for any country. And you need to update this database (from your Admin panel -> Settings -> International -> Countries -> "Admin. Division x" or "Cities") by adding new data (respecting the Geonames data format) or by modifying existing data or by deleting them.

From v2.0+ you have to update the countries locations database from your Admin panel -> Settings -> International -> Countries (see the screenshot below)

The script does not support certain countries (Kosovo, some islands, etc.) automatically because the data in these countries are not reliable. And you will need to add the missing (or incorrect) data manually from your admin panel.

Your own Database

You can also delete all data from Geoname and add your own data.

To do this, you need to:

• Clear the "subadmin1", "subadmin2" and "cities" tables in your database (using phpMyAdmin)
• Add new data from your Admin panel for your country (or for active countries)

Languages

How can I add new languages?

• Go to your Admin panel -> Settings -> Languages
• Click on Add language
• Go to the translation folder at /resources/lang
• The script will already have duplicate the folder /resources/lang/en/ to /resources/lang/<abbr>/

Notes:

• Don't forget to translate the database translatable entries from the Admin panel (Users -> Titles/Genders, Ads -> Ad Types, Ads -> Categories, Settings -> Packages, Settings -> Report Type, etc.).
• If need, you have to duplicate (manually, in this same directory) or edit the date language's file in the: /vendor/nesbot/carbon/src/Carbon/Lang/ directory.

How can I change the default language?

• Go to your Admin panel -> Settings -> Languages
• Create a new language entry and check the "Default" field. Or click on Edit to edit an existing language and check "Default".
• Save all of changes
• You are done.

Note: To prevent the missing translations in the new default language, please open the file /config/app.php and change the fallback_locale value with your default language <abbr> value (e.g. de). Save your files on your server.

How can I edit translations?

• Go to the translation folder at /resources/lang/(each language has his language code as folder name).
• Go to the folder of the language you wish to translate and their files (e.g. global.php contains 90% of the site’s texts, mail.php for emails contents, etc.).
• To translate a file, you must change the values and not the keys of PHP array.
• Save your files on your server.
• Your are done.

Important: It's important to know that the Admin panel does not support the RTL direction.

Notes:

• Don't forget to translate the database translatable entries from the Admin panel (Users -> Titles/Genders, Ads -> Ad Types, Ads -> Categories, Settings -> Packages, Settings -> Report Type, etc.).
• If need, you have to duplicate (manually, in this same directory) or edit the date language's file in the: /vendor/nesbot/carbon/src/Carbon/Lang/ directory.

How can I disable languages?

• Go to your Admin panel -> Settings -> Languages
• Select a language and edit it.
• Uncheck "Active" checkbox and save.

How can I delete languages?

• Go to your Admin panel -> Settings -> Languages
• Select a language and delete it.

Important: By deleting the language, the language files folder /resources/lang/<abbr> will be also removed.

How To

How can I set the Default country?

• Go to your Admin panel -> Settings -> General -> Geo Location and set 'Default Country' with your country code (only ISO alpha-2 codes are accepted). From v2.x or above the script set the default country during installation.
• Your are done.

How can I set the Default currency?

• The default currency will be that of the current country, except the Packages's currency that you can set from  Admin panel -> Settings -> Packages.

How can I setup the packages/Plans?

• Go to your Admin panel -> Settings -> Packages
• Select a package and edit it
• NOTE: You can add new packs or delete current packages in the actual version.

How can I setup the advertising code (e.g. Adsense)?

• Go to your Admin panel -> Settings -> Advertisings
• Edit 'top' and 'bottom' code.
• The code will be displayed on the search results pages and the ads page.
• Your are done.

How can I setup Recaptcha?

• Go to your Admin panel -> Settings -> General -> Security
• Turn ON or OFF 'Enable reCAPTCHA'
• Set 'reCAPTCHA public key' and 'reCAPTCHA private key'
• And save your changes.

Cron Job

How can I start the Scheduler?

• The Ads Clear command (that auto archives and deletes ads after expiration) every hour.
• The Cache and Views Clear commands, the latest day of every week at 6:00.

When using the scheduler, you only need to add the following Cron entry to your server.

* * * * * {PHP_BIN_PATH} /path/to/public_html/artisan schedule:run >> /dev/null 2>&1

This Cron will call the Laravel command scheduler every minute. When the schedule:run command is executed, Laravel will evaluate your scheduled tasks and runs the tasks that are due.

NOTE

• {PHP_BIN_PATH} => Ex: /usr/bin/php7.1.3, /usr/bin/php, /usr/lib/php
• /path/to/public_html/ => You have to replace this path by your real path.
• Don't hesitate to ask more information about it from your hosting provider.
• You can disable the Auto Cache and Views Clear command by adding this variable: DISABLE_CACHE_AUTO_CLEAR=1 in the /.env file.

More information about Cron Job:

• https://crontab.guru/every-1-hour
• https://code.tutsplus.com/tutorials/scheduling-tasks-with-cron-jobs--net-8800
• http://askubuntu.com/questions/2368/how-do-i-set-up-a-cron-job

How does the Ads Clear command work?

After setting it up to run every hour (for example), you can consider 2 cases:

1. Regular Ads

You have to set up the options below from the Admin panel -> Settings -> General -> Cron:

• Unactivated Ads Expiration: After this time (in days) the unactivated ads will be deleted
• Activated Ads Expiration: After this time (in days) the activated ads will be archived
• Archived Ads Expiration: After this time (in days) the archived ads will be removed

2. Premium/Sponsored/Paid Ads

• After the Packages duration time (in days) that you have set up from the Admin panel -> Settings -> Packages -> [EDIT] -> Duration, the Premium Ads become Regular Ads.
  NOTE:
  • The expiration duration of free packages (ie packages with 0 as price) will not be taken to account. The Regular Ads rules will be take to account instead.
  • For site owners that have installed our Offline Payment plugin, pushed ads as premium (ie manual promotions of ads from the admin panel) will never expire. You will need to un-feature them (ie remove the promotion manually) first.
• And then, the Regular Ads rules (seen in #1) are applied to clear the website database.

Backup

Before using this feature, you have to set your MySQL dump binary path with the variable DB_DUMP_BINARY_PATH in the /.env file.
Example with MAMP on Mac OS: DB_DUMP_BINARY_PATH=/Applications/MAMP/Library/bin/. Note: You have to set only the path, so without mysqldump.

If local disk is used, you can get the backups on your server in the /storage/backups/ directory.

Manual Backup

Go to the Admin panel -> Backups to make the backups manually.

Automatic Backup

Go to the Admin panel -> Settings -> General -> Backup to schedule backups and their clearing up.

Backup Storage

Go the Admin panel -> Settings -> General -> Backup to select a storage type for the backups.

For local storage, select the Local Only option and save the form. For cloud storage, select the Cloud Only or Local and Cloud options and save the form.

• Local Only: The backup will be save on the website server only.
• Cloud Only: The backup will be save on the cloud storage only.
• Local and Cloud: The backup will be save both on the website server and on the cloud storage.

Cloud Storage

FTP

You have to add the config below in your /.env file and you have to set the FILESYSTEM_CLOUD= variable to ftp like below and replace the FTP parameters.

FILESYSTEM_CLOUD=ftp
FTP_HOST=your-ftp-host
FTP_USERNAME=your-ftp-username
FTP_PASSWORD=your-ftp-password
FTP_PORT=21
FTP_ROOT=/path/to/storage/root/
FTP_PASSIVE=true
FTP_SSL=true
FTP_TIMEOUT=30

SFTP

You have to add the config below in your /.env file and you have to set the FILESYSTEM_CLOUD= variable to sftp like below and replace the SFTP parameters.

FILESYSTEM_CLOUD=sftp
SFTP_HOST=your-sftp-host
SFTP_USERNAME=your-sftp-username
SFTP_PASSWORD=your-sftp-password
SFTP_SSH_PRIVATE_KEY=
SFTP_PORT=22
SFTP_ROOT=/path/to/storage/root/
SFTP_TIMEOUT=30

Amazon S3

You have to add the config below in your /.env file and you have to set the FILESYSTEM_CLOUD= variable to s3 like below and replace the Amazon S3 parameters.

FILESYSTEM_CLOUD=s3
AWS_ACCESS_KEY_ID=your-s3-access-key
AWS_SECRET_ACCESS_KEY=your-s3-secret-key
AWS_DEFAULT_REGION=your-s3-region-code
AWS_BUCKET=your-s3-bucket
AWS_URL=

Dropbox

You have to add the config below in your /.env file and you have to set the FILESYSTEM_CLOUD= variable to dropbox like below and replace the Dropbox parameters.

FILESYSTEM_CLOUD=dropbox
DROPBOX_ROOT=path/to/storage/root
DROPBOX_AUTHORIZATION_TOKEN=your-dropbox-authorization-token

Backblaze

You have to add the config below in your /.env file and you have to set the FILESYSTEM_CLOUD= variable to backblaze like below and replace the Backblaze parameters.

FILESYSTEM_CLOUD=backblaze
BACKBLAZE_ACCOUNT_ID=your-backblaze-account-id
BACKBLAZE_APPLICATION_KEY=your-backblaze-app-key
BACKBLAZE_BUCKET=your-backblaze-bucket

DigitalOcean

You have to add the config below in your /.env file and you have to set the FILESYSTEM_CLOUD= variable to digitalocean like below and replace the DigitalOcean parameters.

FILESYSTEM_CLOUD=digitalocean
DIGITALOCEAN_KEY=your-s3-access-key
DIGITALOCEAN_SECRET=your-s3-secret-key
DIGITALOCEAN_REGION=your-s3-region-code
DIGITALOCEAN_BUCKET=your-s3-bucket

API

By default the API uses an access token set in the /.env file with the variable APP_API_TOKEN, whose its value need to be added in the header of all the API requests with X-AppApiToken as key.

You can change how the web app consumes the API in the /.env file with the variable APP_HTTP_CLIENT.

• APP_HTTP_CLIENT=none : to use Laravel sub-requests.
• APP_HTTP_CLIENT=curl : to cURL (via Laravel HTTP-Client/Guzzle).

Credits

• Laravel – https://laravel.com
• Maxmind – https://www.maxmind.com
• Geonames – https://www.geonames.org
• Simplemaps – https://simplemaps.com
• and more...