Overview

Thank you for purchasing LicenseBox. If you have any questions, please feel free to send us an email at support@licensebox.app.

This documentation assumes you have some basic to intermediate knowledge of PHP. We can help integrate LicenseBox in your PHP or non-PHP application as a custom work, get in touch!

First let's see what files and folders are there in the downloaded LicenseBox (.zip) file:

.
├── documentation 
//LicenseBox documentation

├── licensebox 
//LicenseBox server/admin panel

├── licensebox_api_usage_examples
│   ├── external_api_examples.php 
//External API functions and live examples

│   └── internal_api_examples.php 
//Internal API functions and live examples

└── licensebox_integration_samples
    ├── activate 
//Pre-made script activator

    │   ├── index.php
    ├── deactivate 
//Pre-made script deactivator

    │   ├── index.php
    ├── install 
//Pre-made script installer

    │   ├── index.php
    ├── licensebox-test-wordpress-plugin 
//Sample WP plugin

    │   ├── licensebox-test-options.php
    │   └── licensebox-test.php
    └── update 
//Pre-made script updater

        └── index.php

LicenseBox is made up of two parts, the first part is the main script/admin panel itself this will be installed/hosted on your own server and the second part is a single .php file (external/client helper file) this will be included in your PHP application, wordpress plugin, theme etc. on which you wish to use LicenseBox. Even though we officially only support PHP applications and plugins but you can still use LicenseBox in any type of application which can make json/xml POST requests to your LicenseBox server, all thanks to the powerful LicenseBox API (you can find out more about the API endpoints and required parameters in the licensebox_api_usage_examples folder).

So let's start with the main LicenseBox script/admin panel installation first, follow the steps given below:

Installation

    Note: Please don't upload the downloaded (.zip) file directly onto your server, instead only upload the contents of the licensebox folder. The other folders are useful during the actual integration into your application, which we recommend you do first on your local machine only.

  1. Copy/Upload all the files and folders which are inside the folder (licensebox) to your web server using cPanel or FTP, if you want to install LicenseBox on your root domain (like example.com) then you need to upload the files directly in your root directory (/public_html/) or if you want to install LicenseBox in a subfolder (like example.com/license), then upload it in a folder (/public_html/license/).

    image01

  2. The folder "config" (present inside application) and "install" folder must have write permissions, so just give the folders write permission (i.e 777).

    image02

  3. Once you are done with the above steps, go to your hosting control panel and create a mysql database, database user and grant relevant permissions to user for this database.
  4. Now go to the URL where you have uploaded LicenseBox like www.yoursite.com/license

Minimum Requirements

  1. You should now see the minimum system requirements checklist - If there are any issues with the checklist, you will need to fix that before you can proceed to the next step.

    image03

    2. If everything is good, click next to proceed with the installation.

Verifying Purchase

    Where can I find my purchase code? please read this.

  1. Here you have to enter your Envato username, Item Purchase code and Email Address.

  2. Then click Verify, After successful verification you should see this page.

    image04

    3. Click next.

Database Details

  1. Enter your database host, database user, database password and database name. If the database you have entered does not exist, the system will try to create it. This might not work when your webhost does not allow creation of new databases. In that case only use the database you have created in earlier step.

    image05

  2. Then click Create, If everything goes well, you should see this page.

    image06

    3. Click next.

Finish Installation

Congratulations! LicenseBox is successfully installed.

image07

  1. Now you can click on the "Login" button and log yourself in, using the default username (i.e admin) and password (i.e admin1234).

    2. image08

  2. Once you are logged into the Dashboard, find Account Settings from the settings dropdown located on the menu, then change your username and password to something more secure.

  3. You can also manage LicenseBox general settings from the General Settings page, there is a separate settings page for Email and API Settings, If you wish to verify Envato purchase codes in your application you should add your Envato API token in the general settings page (You can create a new Envato API token here, if you have not created one yet) and make sure you give it the following permissions (View your items' sales history, Verify purchases of your items)

  4. Even though the LicenseBox installer will get locked automatically after the installation, it is recommended that you remove the "install" folder. You can always re-upload it, if you wish to re-install in the future.

Cron Job Setup

To enable sending of license, updates, supports expiring and new update released notifications to clients, LicenseBox cron job should run every day (recommended is running cron twice a day i.e using a common setting of Twice Per Day(0 0,12 * * *) if using cpanel). LicenseBox cron job also reverifies Envato based purchase codes (if any in the system) and it syncs changes like support expiry date change, username changes etc. Cron job can also perform auto domain, IP blacklisting (if enabled in the API settings page).

You can add a cron job using a command like this in your server crontab: 

/usr/local/bin/php /home/user/public_html/path/to/licensebox/index.php cron run
Where user is your cpanel username (if using cpanel) or account name and path/to/licensebox should point to your LicenseBox root.

Cron job displays a brief summary after every execution, which you can get on your email by adding your email address in the crontab while creating the cron job or you can save it in a log file by adding >> /home/user/lb_cron.log 2>&1 at the end of your cron command.

  Next (External/Client API Integration) ❯

Please mail us your feedback at support@licensebox.app
Follow us on twitter at @CodeMonksHQ for future product updates