1. Download Zip
  2. Upload files
  3. Start installation
  4. Configure Cron (optional)
  5. Troubleshooting

Download Zip

The Zip file you download after purchase has a file structure that looks like this:

  • The docs directory contains this documentation (index.html).
  • The public directory contains all files of the script.
  • The updates directory contains updates for the script. Read more about how to update the script.

Upload files

The script must be installed on a top level domain or subdomain. Sub-directories are not supported.

Upload all files in the public directory to the root of your website. Not the public directory itself, but the files in it so the structure on your web root looks like this:

    |   .editorconfig
    |   .env.example
    |   .gitattributes
    |   .gitignore
    |   .htaccess
    |   artisan
    |   composer.json
    |   composer.lock
    |   package-lock.json
    |   package.json
    |   phpunit.xml
    |   readme.md
    |   server.php
    |   webpack.mix.js

Start installation


Now you can open the url where you have uploaded the script. You should see a screen like below. Enter the name you want to use, and the domain where you are installing the script.

Installation - Domain


Enter the MySQL details. Make sure you use an empty database so there are no conflicting table names.

Installation - Database


Enter the name and email address which will be used by the system to send emails to users. If you want to use SMTP or Mailgun, you can open the .env file in the web root after the installation is completed.

Installation - Email


Enter the name of your company, and optionally an email address and phone number.

Installation - Business


Enter the admin name, and the email address and password you will use to log in. Optionally you can enter a phone number.

Installation - Login

Click Install and the installation will begin. Be patient, it may take a few minutes.

Installation - Loader

When the installation is finished, you will be redirected to the login screen. You can now log in with the login details you entered earlier.

Installation - Login

Configure Cron

With Cron jobs you can schedule scripts to run periodically at fixed times, dates, or intervals.

For example, to send a notification when a due date is approaching. Currently the script does not use Cron jobs, but this may change in the future.

If you want to set up Crons you can do by logging into your server with SSH and enter the command:

crontab -e

A text editor will open, and at the bottom you can put this line (make sure to update the correct path to match your installation root):

* * * * * php /srv/wwwroot/artisan schedule:run >> /dev/null 2>&1

For more information take a look at the Laravel Task Scheduling documentation.


Something went wrong and you want to run the installation again? Drop all tables in the database, and delete the .env file from the web root. Now you can open the url again where you have uploaded the script.