Documentation

WHITESTAR FX CRM

Thank you so much for purchasing our item from codecanyon.

  • Created: 1st March, 2022
  • Update: 1st March, 2022

Introduction

WHITESTAR FX CRM is a flexible CRM system developed exclusively for Forex Brokerages and White labels who are dedicated to offering a Higher level of Customer and Partner Experience. Our CRM can be customized to your exact Business Model.
If you’re looking for a Forex CRM that can work with the popular MetaTrader 5 Platform, then look no further. WHITESTAR FX CRM, is fully integrated with MT5 platform and can provide your brokerage with an MT5 crm that exceeds all of your expectations.

Key Features:
  • MT5 Server API Integration
  • 2FA Customer Verification
  • Google Recaptcha
  • Advanced Customer Management
  • Advanced Staff Management
  • Real Time MT5 Client Operations
  • Real Time MT5 Deposit, Withdrawal, Credit & Bonus Management
  • MT5 Web Trader Integration
  • Payment Gateways Management
  • Currency Management
  • Deposit & Withdrawal Management
  • Bank Account(s) Management
  • Email Management
  • Notifications Management
  • Advanced Reports with export options
  • Live Chat Management
  • Complete CMS Management
  • & More

Server Requirements :

  • PHP >= 7.3.0
  • 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

Installation

Follow the steps below to setup your site:

  1. Unzip the downloaded package and open the /scripts folder to find all the script files. You will need to upload these files to your hosting web server using FTP or localhost in order to use it on your website.
  2. Below is the folder structure and needs to be uploaded to your website or localhost root directory: image
  3. You should upload all the files.
  4. Once you are done uploading, open your browser (Google Chrome is recommended).
  5. Go to http://www.YOURSITE.com/
    There will be a welcome screen show. image Click on Check Requirements.
  6. Please make sure you have the following installed on your server image Then click on Check Permissions.
  7. Please make sure the permissions granted are given to the following folders.
    • storage/framework => 775
    • storage/logs => 775
    • storage/cache => 775
    image Then click on Verify License.
  8. Fill all the given fields: image
    • Email Address (Envato Account Registered Email Address)
    • Envato Username
    • Purchase Code (Envato Purchase Code)

    Then click on Verify.
  9. After verification fill all the given fields: image
    • App Name (YOUR PROJECT NAME e.g. WHITESTAR FX CRM)
    • App Debug
    • APP URL (YOUR SITE URL) e.g:
      • https://siteurl.com
      • https://www.siteurl.com
      • https://siteurl.com
      • https://subdomain.siteurl.com
      • https://siteurl.com/subfolder
    • Database Host (MySQL host name e.g: localhost)
    • Username (MySQL username)
    • Password (MySQL password)

    Then click on Install.
  10. Finally! The application installed successfully😃 image Now click on Exit.

  11. After that, the login screen will be shown. You've to put these login credentials to run the application.

    User Demo:
    • URL: (e.g. https://siteurl.com)
    • Username: testuser@whitestarfxcrm.com
    • Password: testuserpwd
    Admin Demo:
    • URL: (e.g. https://siteurl.com/admin)
    • Username: admin
    • Password: admindemo
  12. After login the application you can change the password. Change password option is located on top right of the navbar. Click on profile image a dropdown will display click on change passord and change it.

MT5 Server Database Synchronization

Create a new database on your cpanel/plesk. Copy Database Username, Database Name ,Database User Password & Database Server IP & Port.

DATABASE_SERVER_IP= XXX.XXX.XXX.XXX
DB2_PORT=YOUR DATABASE SERVER PORT (COMMONLY IT IS 3306)
DB2_DATABASE=YOUR DATABASE NAME
DB2_USERNAME=YOUR DATABASE USERNAME
DB2_PASSWORD=YOUR DATABASE PASSWORD

Once you've generated above values. Login to your MT5 Server Administrator Application as shown below:

image

Right Click on "Main Trade Backup Server" as shown below:

image

Click on Edit Button. A new popup will open as shown below:

image

Now click on "SQL Export" Tab. In type select your Web Server SQL Type and enter the details in other tabs as you've recorded earlier.

image

Update

Auto Update System not available. We need to update this script manually. Contact us on support we will update your system for free. We need you Cpanel access to update the system.

For Update contact author https://codecanyon.net/item/support

Application Settings

The Application Information Can Be Changed From Admin Panel -> System Settings -> General Settings

  • Application Title - YOUR APPLICATION NAME
  • Application Email - YOUR APPLICATION EMAIL
  • Admin Email - YOUR ADMIN EMAIL
  • Support Email - YOUR SUPPORT EMAIL
  • Application Description - YOUR APPLICATION DESCRIPTION
  • Footer Text - APPLICATION FOOTER TEXT
  • Choose Application Logo - APPLICATION LOGO
  • Choose Application Icon - FAVICON ICON
  • Front Background Image - LOGIN & REGISTER BACKGROUND IMAGE
image

Preloader

The Preloader Can Be Changed From Admin Panel -> System Settings -> Preloader

  • Status - If option is ON then preloader will display.
  • Background Color - Preloader Background Image
  • Image - Preloader Icon
image

PWA Icons / Splash Screens

The PWA Icons Can Be Changed From Admin Panel -> System Settings -> PWA Icons

image

The PWA Splash Screens Can Be Changed From Admin Panel -> System Settings -> PWA Splash Screens

image

Upload your application splash images or icons. Make sure all the images are according to mentioned size.

Theme Colors

The Theme Colors Can Be Changed From Admin Panel -> System Settings -> Theme Color Settings

  • Primary Color - Buttons, Nav Icons, Cards, Links, Icons, Profile Info, Charts Color
  • Secondary Color - Dropdowns,Elements Backgrounds Color
  • Body Text Color - Headings, Paragraphs Color
  • Sidebar Background Color - Sidebar Background Color
image

Timezone

The Timezone Can Be Changed From Admin Panel -> System Settings -> Timezone Settings

image

Select your timezone and click on Save

MT5 Server API

The MT5 API Settings Can Be Changed From Admin Panel -> System Settings -> MT5 API Settings

How to create MT5 WEB API ACCOUNT on MT5 SERVER Please click

image

Login OTP Settings

The Login OTP Settings Can Be Changed From Admin Panel -> System Settings -> OTP Settings

image

If you want to ask otp at the time of customer login toggle the status and click on Save.

Social Icons

The Social Icons Can Be Changed From Admin Panel -> System Settings -> Social Icons

You can add many social icons by click on the plus button on the top right side.

image
  • Icon Code FONT AWESOME ICON CODE (To generate the icon please click on this link)
    Make sure the code same like this: <i class="fab fa-facebook-f"><i/>
  • Icon Link

Application Platforms

The Application Platforms Can Be Changed From Admin Panel -> System Settings -> Platforms. These platforms are display on the platforms section of customer panel.

image

These platforms display on the Web Trader section of customer panel.

image

You can get MT5 platforms links by clicking here.

image

You can add application link on the related fields.

image

To get the Meta Trader Widget Code Please click on Show Widget Code. The Sample code is:

                            
                                <div id="webterminal" style="width:100%;height:600px;"></div>
                                <script type="text/javascript" src="https://trade.mql5.com/trade/widget.js"></script>
                                <script type="text/javascript">
                                    new MetaTraderWebTerminal( "webterminal", {
                                        version: 5,
                                        servers: ["WHITESTARFX-Server"],
                                        server: "WHITESTARFX-Server",
                                        demoAllServers: true,
                                        utmSource: "www.whitestarfx.com",
                                        startMode: "create_demo",
                                        language: "en",
                                        colorScheme: "black_on_white"
                                    } );
                                </script>

You can paste the widget code in Meta Trader Widget Box and click on save.

Trading Widget

The Trading Can Be Changed From Admin Panel -> System Settings -> Live Widget. The widget is display on the dashboard of admin & customer panel.

How to get widget code? Please click to get a widget code.

image

Tawk.to Chat

How to get widget code? Please click to get a widget code.

  1. Sign up tawk.to with your email. If you don’t have a email id create one. You can use any emails like Gmail, Zoho, etc. image
  2. After signing up tawk.to create property and fill your property details like site name and website URL.. image image
  3. After that add teams your property and their roles if you want or else skip this step next you are prompted to install your website. image
  4. Here you can see the tawk.to widget code image

Copy the widget code and Go to Admin Panel -> System Settings -> Live Chat Widget paste the widget code in a box and click on save.

image

Google Recaptcha

How to get recaptcha keys? Please click to get a recaptcha keys. Here is the process to get keys:

image image

Copy the keys from the above process and Go to Admin Panel -> System Settings -> API Credentials and paste the keys into the related fields.

image
  • Site Key
  • Secret Key

Custom Styling and Scripts

The Custom Styling and Scripts Can Be Changed From Admin Panel -> System Settings -> Live Custom Scripts. You can add your CSS styling or Javascript code in this section.

image

Maintenance Mode

The Maintenance Can Be Changed From Admin Panel -> System Settings -> Maintenance Mode. The maintenance mode is only for customer panel.

image
  • Status - MAINTENANCE MODE STATUS
  • Background Color - MAINTENANCE BACKGROUD COLOR
  • Text Color - MAINTENANCE PAGE TEXT COLOR
  • Description - MAINTENANCE PAGE DESCRIPTION/MESSAGE
  • Image - MAINTENANCE PAGE IMAGE

The maintenance mode sample is: image

SMTP

  • The first step of the process is to create an email account on your hosting package. This will be required for the SMTP configuration of your website and it will also ensure that all emails from your website are successfully delivered to your users. You can create a new email account via cPanel.
  • Once you have your email account created, you can proceed with the actual configuration of your website. You need to go to SMTP settings from Admin Panel -> Email Settings -> SMTP Settings
    1. SMTP Status - Enable/Disable
    2. SMTP Host - mail.example.com (change example.com to your actual domain)
    3. SMTP Port - SMTP server port, most used 587 for TLS, and 465 for SSL encryption
    4. Encryption - Choose SMTP encryption method
    5. SMTP Username - Enter the email account created in the previous chapter
    6. SMTP Password - Enter the password for your email account
    7. From Email
    8. From Name
image
  • I made the changes above but my website is not sending any emails, what I can do?
    • Please test your SMTP credentials at SMTPER, if the same config worked by the test, please contact us.

Email Template Settings

The Email Template Styling and Content Can Be Changed From Admin Panel -> Email Settings -> General Settings

  • Email Logo - EMAIL TEMPLATE LOGO
  • Footer Backgound Color - EMAIL TEMPLATE FOOTER BACKGROUND COLOR
  • Footer Foreground Color - EMAIL TEMPLATE FOOTER TEXT COLOR
  • Footer Text - EMAIL TEMPLATE FOOTER TEXT
  • Sender Name - APPLICATION NAME / SENDER NAME
  • Sender Tagline - SLOGAN / TAGLINE
  • Sender URL - APP URL
image

You can also change email inner data. For change go to Admin Panel -> Email Settings -> Email Templates and click on edit button.

image image

Notifications

The Custom Email Notifications Can be Send From Admin Panel -> Notifications -> Custom Email Notifications. Click on Send Notfication Button

image

Stripe

  • Go to Stripe & create a new account.
  • Login to your dashboard & turn your account on by flipping the switch from “Test” to “Live”.
  • Click Activate Account in the pop up window to fill out the standard business details Stripe needs to send you payments.
  • Once you’ve completed the entire form, click Activate Account.
  • Now that your account is live, go to Your Account and click on Account Settings.
  • Click the API Keys tab & copy the Live Secret Key & Publishable Key.
  • Go to Admin Panel -> Payments Settings -> Payment Methods, find Stripe and edit the following options:
    1. Enable Status by clicking on the toggle.
    2. Stripe API Secret Key - Your Stripe secret key that starts with sk_
    3. Stripe Publishable Key - Your Stripe publishable key that starts with pk_

PayPal

  • Login to PayPal, then click here: https://developer.paypal.com/developer/applications/create
  • Set your app name, email address then click Create App.
  • On the top right side, you can see two tabs, SandBox and Live, Choose Live.
  • Go to Admin Panel -> Payments Settings -> Payment Methods, find PayPal and edit the following options:
    1. Enable Status by clicking on the toggle.
    2. PayPal Mode - Choose Live (In case your app is in Live mode).
    3. PayPal Clinet ID - PayPal application ID you created in the previous chapter.
    4. PayPal Secret Key - PayPal application secret key you created in the previous chapter.

CashFree

  • Go to Cashfree website & sign in to your account with a registered email address.
  • Click on Activate button to activate various payment gateways for your account.
  • Now, you can click on View Dashboard to view account details.
  • Go to Credentials tab to access the test API credentials for payment gateways.
  • Click on Get Credentials tab to access the sandbox credentials
  • View app ID & secret key under Test Credentials tab.
  • Go to Admin Panel -> Payments Settings -> Payment Methods, find CashFree and edit the following options:
    1. Enable Status by clicking on the toggle.
    2. CashFree Mode - Choose Live (In case your app is in Live mode).
    3. Client ID - CashFree application ID you created in the previous chapter.
    4. Client Secret - CashFree application secret key you created in the previous chapter.

CoinPayments

  • Go to CoinPayments https://www.coinpayments.net/register, and create a new account.
  • Once you are logged in, go to https://www.coinpayments.net/acct-api-keys
  • Scroll down, and click Generate new key...
  • Copy both Public Key and Private Key.
  • Click on Edit Permissions and scroll down to API Key Permissions
  • Enable the following: get_basic_info, set_basic_info, get_tx_info, create_transfer, get_conversion_info then click on Update Permissions
  • Grab the new API keys
  • Once you got your keys, Go to Admin Panel -> Payments Settings -> Payment Methods, find CoinPayments and edit the following options:
    1. Enable Status by clicking on the toggle.
    2. Merchant ID - Your account Merchant ID, you can get this ID from your account settings.
    3. Secret Key - Your Public key you copied in the previous chapter.

PayStack

  • Sign Up with Paystack
  • Verify your sign up using a verification link sent to your email.
  • The next thing is to sign in to your new Paystack account
  • On your Dashboard you will find your public and secret key
  • Grab the keys, then go to Admin Panel -> Payments Settings -> Payment Methods, find PayStack and edit the following options:
    1. Enable Status by clicking on the toggle.
    2. Secret Key - CashFree application secret key you created in the previous chapter.

RazorPay

  • Go to the Razorpay website and Sign Up.
  • Enter your work email address and a password for your Razorpay account and click Create Account.
  • Fill Pre-sign Up Form
  • Verify Email Address
  • Once your account is created, you have access to the Test mode on the Dashboard. Test mode is used for testing purposes and does not involve actual money transactions. However, you would need to activate your account in order to accept live payments.
  • To create an Application, follow this RazorPay Guide.
  • Once your application was created, take the required keys then go to Admin Panel -> Payments Settings -> Payment Methods, find RazorPay and edit the following options:
    1. Enable Status by clicking on the toggle.
    2. Application ID - CashFree application ID you created in the previous chapter.
    3. Application Secret - CashFree application secret key you created in the previous chapter.

SecurionPay

  • You can find a detailed doc here: https://securionpay.helpjuice.com/90032-backoffice/529474-api-keys
  • Once you got your keys, Go to Admin Panel -> Payments Settings -> Payment Methods, find Securionpay and edit the following options:
    1. Enable Status by clicking on the toggle.
    2. Securionpay Public key - Your Public key you copied in the previous chapter.
    3. Securionpay Secret key - Secret Key you copied in the previous chapter.

Authorize.Net

  • Log into the Merchant Interface.
  • Click Account from the main toolbar.
  • Click Settings in the main left-side menu.
  • Click API Credentials & Keys.

  • Select New Transaction Key.

    Note: When obtaining a new Transaction Key, you may choose to disable the old Transaction Key by clicking the box titled, Disable Old Transaction Key Immediately. You may want to do this if you suspect your previous Transaction Key is being used fraudulently.
  • Click Submit to continue.
  • Request and enter PIN for verification.
  • Your new Transaction Key is displayed.
  • If the Disable Old Transaction Key Immediately box is not checked, the old Transaction Key will automatically expire in 24 hours. When the box is checked, the Transaction Key expires immediately.
  • Go to Admin Panel -> Payments Settings -> Payment Methods, find Authorize.net and edit the following options:
    1. Enable Status by clicking on the toggle.
    2. Authorize.net Mode - Choose Live (In case your app is in Live mode).
    3. Authorize.Net API LOGIN ID - Your API Login ID.
    4. Authorize.Net TRANSACTION KEY - TRANSACTION KEY you copied in the previous chapter.

Manual Payments

You can manage multiple Bank Accounts for Manual Payments From Admin Panel -> Payments Settings -> Bank Details for add click on Add New Bank Details button

  • Account Holder - Accont Title
  • SWIFT/BIC -Bank Swift Code / Bank Identifier Code
  • Account Number - Bank Account Number
  • Bank Name
  • Branch Address - Bank Branch Address
  • Country - Your Country / Bank Account Related Country
  • Currency - Currency in which you want to receive amount

You can active/disable manual payments from Admin Panel -> Payments Settings -> Payment Gateways , find Bank and edit the following options:

  • Status - Enable/Disable
  • Image - Icon Image (Customer Side)

Crypto Payments

You can manage multiple payment gateways for Crypto Payments From Admin Panel -> Payments Settings -> Payment Gateways for add click on Add Bitcoin Payment Gateway button

  • Name - Gateway Name
  • Wallet Address - Crypto Wallet Address
  • Status - Enable/Disable
  • QR Code - QR Code Image for receiving Payments
  • Image - Icon Image (Customer Side)

Support

If this documentation doesn't answer your questions, So, Please send us Email via Support Page

Changelog

See what's new added, changed, fixed, improved or updated in the latest versions.

Version 1.0 (1st March, 2022)

Initial Release

License

WHITESTARFX is made by FRIENDSHIVE LTD. under Envato Extended & Regular License.

What is the different between Extended and Regular license?
  • An Extended License is required if the end user must pay to use the end product, means that you should own an extended license if you will charge your end users.
  • Both versions are similar, same features, updates and support services.
  • Both can be used one domain only, means you need a license for every domain.