Documentation

Getting started

Introduction

This page describes the installation and configuration steps of phpShort software.

If you're not familiar with the instructions on this page, we offer installation Services, for an additional fee.

Requirements

Before installing the software, please make sure your server meets the requirements below.

Software Modules
PHP 8.0.2+ BCMath, Ctype, Fileinfo, JSON, Mbstring, OpenSSL, PDO, Tokenizer, XML, GD, cURL
Apache 2+ mod_rewrite
MySQL 5.7.7+
MariaDB 10.3.17+

Installation

Creating the database

  1. Create a new MySQL database.
  2. Create a new MySQL username and password.
  3. Assign full privileges to your database username.

Uploading the files

Before starting to upload the files, please make sure your file explorer has the option to view hidden files turned on. On some operating systems, the dotfiles are hidden by default.

Upload what's inside the Script folder on the web root folder of your domain. This folder is generally called public_html, html, or example.com, but depending on your server's configuration, it might be named differently.

Configuring the files

Set the access permissions (CHMOD) to 775 to the following files and folders:

  • Files
    • .env
  • Folders
    • bootstrap/cache
    • lang
    • public/uploads/brand
    • storage
    • storage/framework/
    • storage/framework/cache
    • storage/framework/cache/data
    • storage/framework/sessions
    • storage/framework/views
    • storage/logs

Changing the public directory

Configure your web server's document / web root to point to the public directory of the software. For example, if you've uploaded the software in example.com folder, your web directory should be changed to example.com/public folder.

Finishing the installation

  1. Go to https://example.com/install and follow the installation wizard to complete the installation.
  2. After you've installed the software, login into your user account.
  3. Once logged-in, go to https://example.com/admin and activate your License Key.

Configuration

Cron jobs

Cron jobs are required to be set up in order to automate some of the software's functions.

  1. Go to Admin Settings Cron jobs.
  2. Set up cron job tasks, for every cron job command and its corresponding recurrence.

Emails

  1. Go to Admin Settings Email.
  2. Change the Driver field value to SMTP.
  3. Fill in the rest of the fields with the SMTP credentials from your SMTP provider.

Captcha

The Captcha system relies on Google reCAPTCHA's API.

  1. Login into your Google reCAPTCHA account.
  2. Create a new reCAPTCHA v2 Invisible Badge.
  3. Fill all the other fields with the requested information.
  4. Copy the Site key and the Secret key in Admin Settings Captcha.

Payment processors

To enable any of the payment processors, an Extended license is required. The payment processors can be enabled from Admin Settings Payment processors.

PayPal

  1. Login into your PayPal account.
  2. Go to the My apps & credentials section, click on Live button and then on the Create app button.
  3. Copy the Client ID and Secret in Admin Settings Payment processors PayPal.
  4. Go to the My apps & credentials section, click on Live button and then select your app.
  5. Scroll down to LIVE WEBHOOKS and click on the Add webhook button.
  6. On the Webhook URL field paste your webhook URL. This can be found on Admin Settings Payment processors PayPal.
  7. Under the Events types select All events and save your changes.
  8. Go to the My apps & credentials section, click on Live button and then select your app.
  9. Copy the Webhook ID in Admin Settings Payment processors PayPal.

Stripe

  1. Login into your Stripe account.
  2. From the menu bar, go to the Developers section of the Stripe dashboard and click on API Keys.
  3. Copy the Publishable key and Secret key in Admin Settings Payment processors Stripe.
  4. From the menu bar, go to the Developers section of the Stripe dashboard and click on Webhooks.
  5. Click on Add a new endpoint.
  6. On the Endpoint URL field paste your webhook URL, which can be found on Admin Settings Payment processors Stripe.
  7. On the events to listen to field, click on Select all events, and click on Add events button.
  8. Click on Add endpoint button to create your webhook endpoint.
  9. Copy the Signing secret in Admin Settings Payment processor Stripe.

Razorpay

  1. Login into your Razorpay account.
  2. From the menu bar, go to the Settings section of the Razorpay dashboard and click on API Keys.
  3. Click on Generate key button.
  4. Copy the Key ID and Key secret in Admin Settings Payment processors Razorpay.
  5. From the menu bar, go to the Settings section of the Razorpay dashboard and click on Webhooks.
  6. Click on Add new webhook.
  7. On the Webhook URL field paste your webhook URL, which can be found on Admin Settings Payment processors Razorpay.
  8. On the Secret field add your own secret passcode.
  9. On the Active events field select all the Payment events and Subscription events.
  10. Click on Create webhook button to create your webhook endpoint.
  11. Copy the Secret passcode in Admin Settings Payment processor Razorpay.

Paystack

  1. Login into your Paystack account.
  2. From the menu bar, go to the Settings section of the Paystack dashboard and click on API Keys & Webhooks.
  3. Copy the Public key and Secret key in Admin Settings Payment processors Paystack.
  4. From the menu bar, go to the Settings section of the Paystack dashboard and click on API Keys & Webhooks.
  5. On the Webhook URL field paste your webhook URL, which can be found on Admin Settings Payment processors Paystack.

Coinbase

  1. Login into your Coinbase account.
  2. From the sidebar, go to the Settings section of the Coinbase dashboard and scroll down to API keys.
  3. Create an API key, and copy the key in Admin Settings Payment processors Coinbase.
  4. From the sidebar, go to the Settings section of the Coinbase dashboard and scroll down to Webhook subscriptions.
  5. Click on Add an endpoint.
  6. On the Endpoint URL field paste your webhook URL. This can be found on Admin Settings Payment processors Coinbase.
  7. From the sidebar, go to the Settings section of the Coinbase dashboard and scroll down to Webhook subscriptions.
  8. Click on Show shared secret.
  9. Copy the Webhook shared secret in Admin Settings Payment processors Coinbase.

Crypto.com

  1. Login into your Crypto.com account.
  2. From the menu bar, go to the Integrations section of the Crypto.com dashboard and click on API Keys.
  3. Copy the Publishable key and Secret key in Admin Settings Payment processors Crypto.com.
  4. From the menu bar, go to the Integrations section of the Crypto.com dashboard and click on Webhooks.
  5. Click on Add webhook button.
  6. On the Payload URL field paste your webhook URL, which can be found on Admin Settings Payment processors Crypto.com.
  7. Copy the Signature secret in Admin Settings Payment processor Crypto.com.

Bank

  • All fields are optional.

Advanced

Google Safe Browsing

  1. Follow the Google Safe Browsing guide to obtain an API key.
  2. Copy the API key in Admin Settings Advanced Google Safe Browsing.

Update

Backing up

Before updating the software, you must make a complete backup of your website.

If you've made any modifications to the software's files, your changes will be lost.

Please consult the Requirements section before upgrading.

Updating

  1. Make a backup of the .env config file located on your server.
  2. Upload and replace all the files on your server with what's inside the Script folder.
  3. Restore your .env config file on your server.
  4. Go to https://example.com/update and follow the update wizard.1
  1. Updates that do not have database changes, will not show up in the update wizard.

FAQ

  • I have a support inquiry, a question or a problem, how can I contact you?

    You can contact us here.
  • What hosting do you recommend?

    We recommend using DigitalOcean, as they offer great performance and flexibility at an affordable price.
  • Is installation included in the price?

    No, installation is not included. We offer installation services for an extra fee, please consult our Services section for more details.
  • How can I translate my website?

    Make a copy of the default en.json language file found in /lang folder, and change it according to your needs.
  • Where do I find the HTML template files?

    The HTML template files can be found in the /resources/views folder. For example to edit the home page, you would edit the /resources/views/home/index.blade.php file.
  • Where can I add my custom CSS code?

    You can add your custom CSS code in Admin Settings Appearance Custom CSS field.
  • Where can I add my custom JS code?

    You can add your custom JS code in Admin Settings General Custom JS field.
  • How can I create a custom page?

    You can create custom page in Admin Pages.
  • Where can I set up my Terms of Service, Privacy Policy, and Cookies Policy URL pages?

    You can paste the links of your legal pages in Admin Settings Legal.
  • My custom domain is not working, why?

    If you're on a managed environment (cPanel, Plesk, etc), you need to manually add your custom domain in your panel, with the same root directory as the software's installation.