Consignment Script Documentation

Complete Web Setup and Administration Guide

1. Server Requirements

Before installing the script, ensure your web server meets the following requirements:

2. Web Installation Wizard

We have bundled an automatic web installer to make setup quick and easy. Follow these steps:

  1. Upload all the files to your web server hosting root or subdirectory.
  2. Create an empty database via your hosting control panel (cPanel, Plesk, etc.).
  3. Open your browser and navigate to the installation wizard: http://yourdomain.com/install.php
  4. The wizard will run a system compatibility check. Click Continue to Config.
  5. Fill in your database details:
    • Database Host: e.g., localhost.
    • Database Username: Your database user.
    • Database Password: Your database password.
    • Database Name: The empty database created in Step 2.
  6. Set up your admin login details by entering a custom Admin Email and Password, then click Run Setup.
  7. The script will populate the tables, configure database connection strings, and establish the admin account.
⚠️ CRITICAL SECURITY WARNING:

Once installation finishes, you must delete install.php from your server root immediately to prevent unauthorized re-installation.

3. Manual Payment Gateways Setup

As the administrator, you can configure multiple manual payment options for your clients (e.g., Crypto, Zelle, PayPal, Bank Transfers):

  1. Log in to the Admin Panel (SafeBox) at http://yourdomain.com/SafeBox/login.php.
  2. Navigate to the **Payment Methods** page using the sidebar navigation.
  3. Click **Add New Method** to launch the creation form.
  4. Choose a payment method type:
    • Crypto Specify the Coin name, Network (e.g. ERC20, TRC20), Wallet Address, Payment instructions, and optionally upload a QR Code image.
    • Bank Transfer Specify the Bank Account Number, payment instructions (including bank name, routing code, and account holder name).
    • PayPal & Zelle Specify the destination account email or phone number and transaction guidelines.
  5. Save the payment method. You can disable, enable, edit, or delete any payment methods at any time.

4. Clearance Fee & Payment Approval

When a parcel is placed on hold, the system allows the tracking customer to clear it directly by submitting payment proofs:

Setting a Clearance Fee:

  1. While creating a parcel or updating its status to **⚠️ On Hold**, enter the **Clearance Fee** amount.
  2. Once the parcel is saved in the **⚠️ On Hold** state, a payment box will automatically appear on the user's tracking results screen.

Customer Checkout & Submission:

Admin Payment Review:

  1. Go to **Clearance Payments** in the admin sidebar.
  2. Click **View & Process** on any pending payment to inspect the details and proof image.
  3. Select **Approve** to mark the payment approved. This automatically updates the parcel status to **In-Transit**, logs a tracking checkpoint in history, and sends the approval email.
  4. Select **Reject** to decline the proof. You must input a rejection reason, which is automatically emailed to the customer, allowing them to upload a corrected proof.

5. Dynamic Identity & Live Chat Settings

You can configure core website assets directly from the admin panel without editing code files:

  1. Navigate to **System Settings** in the SafeBox sidebar.
  2. You can update:
    • System Name: The site branding name used in emails and copyright.
    • Website Logo: Upload a custom logo to automatically replace header and receipt images.
    • Favicon: Upload a favicon image to refresh tab icons.
    • Email & Contact: Used for customer support references and header contact items.
    • Live Chat Widget Script: Paste your chat integration JS script (e.g. Smartsupp, Tawk.to) directly into the text box. The front-end will render and run it instantly.
  3. Click **Save** to apply changes.

6. SMTP Mail & Notification Settings

Email notifications are sent to users automatically during payment submission, approval, and rejection. By default, the system uses the native PHP mail() routing. However, to guarantee high email deliverability, you should configure custom SMTP server credentials.

Configuring SMTP Settings:

  1. Navigate to **System Settings** in the SafeBox sidebar.
  2. Scroll down to the **SMTP Mail Server Settings** block.
  3. Enter your mail server parameters:
    • SMTP Host: e.g., smtp.yourdomain.com or smtp.gmail.com.
    • SMTP Port: 465 (SSL), 587 (TLS), or 25 (none).
    • SMTP Security: Select SSL, TLS, or None based on your server requirements.
    • SMTP Username/Password: Login credentials of the mail account.
    • Sender Details: Customize the Sender Email address and Display Name.
  4. Click **Save**. To disable custom SMTP and return to native PHP mail routing, simply clear the SMTP Host field and save.

Customizing Notification Templates:

The subjects and body messages can be edited dynamically in **System Settings**. The templates support the following placeholders which replace values dynamically when the email is sent: