DOCSEARCHbyAlgolia
Submit Docs

Premium URL Shortener Documentation

website·Indexed 33 days ago

https://gempixel.com/docs

Installation, upgrading, and migration guide for the self-hosted PHP Premium URL Shortener platform. Covers redirection options, custom Pixels, the storage/themes theming system, and Google Web Risk API integration.

Tokens
6.6K
Snippets
17
Records
49
Agent score
18%

What's inside Premium URL Shortener

  1. Manage User Affiliates

    Version 6.0 includes an affiliate tool. Users can share affiliate links to earn commissions on the first successful payment. Administrators can configure the following in the admin panel:

    • Commission rates and terms.
    • Minimum payout rate.
    • Manual review and processing of withdrawal requests (users provide a PayPal email for payment).

  2. Install and configure Razorpay plugin

    Razorpay is a paid plugin supporting various subscription types. An Extended License is required. If using Razorpay, do not enable Stripe. Sync plans when moving from Test Mode to Live Mode.

    Installation

    1. Upload razorpay.zip via Admin > Plugins > All Plugins.
    2. Activate the plugin. Manual alternative: Extract to storage/plugins/razorpay/.

    Setup

    1. Go to Admin > Settings > Payment Gateway > Razorpay Payments.
    2. Enter API keys and add the specified webhook from dashboard.razorpay.com.
    3. Copy the Signature Secret from the admin panel to the Razorpay webhook settings.
    4. Sync Plans if previous plans exist.

  3. Configure Multiple and Custom Domain Names

    To enable custom or addon domains, you must first enable the system in Admin > Advanced Settings > Multiple Domain Names.

    General Requirements:

    1. Point the domain to the server via A record (IP) or CNAME.
    2. Ensure the addon domain resolves to the exact path where the script is installed.

    Server-specific setup:

    • Shared Server (cPanel): Use the 'Addon Domains' tool. The Document Root must be the same as the primary domain or the script installation path.
    • Plesk: Use Domain Aliases and ensure 'Redirect with the HTTP 301 code' is toggled OFF.
    • VPS/Dedicated (Apache): Modify the virtual host file (e.g., /etc/apache2/sites-enabled/000-default.conf). Update the DocumentRoot and Directory paths to the script's installation directory and restart Apache.

  4. Manage and update plugins

    Plugins add extra functionality to the application. They can be installed via the admin panel uploader. To update a plugin, simply re-upload the latest version of the plugin file; settings and data are preserved during this process.

    Installation

    1. Download plugin (.zip).
    2. Admin Panel > Plugin Management > Upload.
    3. Activate and verify.

    Updating

    1. Download updated plugin version.
    2. Re-upload the plugin via the management section.

  5. Integrate Zapier or custom webhooks

    Premium URL Shortener can ping a webhook with data whenever a new URL is created or a new visit occurs. This is configured in the Tools -> Zapier Integration section. While designed for Zapier, it supports any webhook system.

  6. Set up Bio Pages

    Bio Pages (similar to Linktree) allow users to create a landing page with multiple links and widgets. These can be enabled/limited within user plans. To set a specific Bio Page as the default for a user (accessible via https://site/user/username), navigate to Bio Pages > Select the Bio Page > Choose 'Set as Default'.

  7. Install ImageMagick and Imagick for Advanced QR Codes

    Advanced QR codes require ImageMagick with the RSVG delegate. It is recommended to install the latest versions from source via root SSH access.

    Installation steps:

    1. Remove existing ImageMagick/Imagick versions.
    2. Install required delegates and modules.
    3. Install ImageMagick from source using ./configure --with-rsvg --with-modules.
    4. Install Imagick from source.
    5. Add extension=imagick.so to php.ini.
    6. Restart the server.
    7. Verify installation via Admin > Update > view phpinfo.
    sudo apt-get update && apt-get install -y -qq \
build-essential chrpath debhelper dh-exec dpkg-dev g++ ghostscript gsfontslibbz2-dev \
libdjvulibre-dev libexif-dev libfftw3-dev libfontconfig1-dev libfreetype6-dev \
libjpeg-dev liblcms2-dev liblqr-1-0-dev libltdl-dev liblzma-dev libopenexr-dev \
libpango1.0-dev libperl-dev libpng-dev librsvg2-bin librsvg2-dev libtiff-devlibwebp-dev \
libwmf-dev libx11-dev libxext-dev libxml2-dev libxt-dev pkg-config pkg-kde-toolszlib1g-dev

  8. Install and configure Iyzico plugin

    The Iyzico plugin is used for collecting payments in Turkey. This plugin requires an Extended License.

    Installation steps:

    1. Go to Admin > Marketplace.
    2. Install the Iyzico Plugin.
    3. Click the three dots and select Activate.
    4. Go to Admin > Settings > Payment Gateways and enter your keys.
    5. At Iyzico.com > Notifications, enter the webhook URL provided in the admin panel.

  9. Customize themes in Premium URL Shortener

    Themes are located in the storage/themes directory. The system includes a built-in theme editor (using ACE) for HTML and CSS modifications. Note that the editor does not format PHP; PHP code is treated as text and should only be modified by experienced users. The admin folder within a theme contains critical files and should generally not be modified. Themes can be added by uploading a .zip file via the admin panel or extracting it directly into storage/themes/. Themes cannot be deleted via the admin panel and must be removed manually from the server filesystem.

  10. Configure Crypto.com Payments plugin

    To set up Crypto.com payments, you can use the uploader or manually extract crypto.zip into storage/plugins/crypto. Once activated in the admin panel, follow these steps:

    1. Navigate to Admin > Settings > Payment Gateway.
    2. Enable Crypto.com Payments.
    3. Create a merchant account at merchant.crypto.com.
    4. Retrieve API keys from the developer section and add the specified webhook.
    5. Copy the Signature Secret from the webhooks page into the plugin settings.
    6. Save settings and Sync Plans if you have existing plans.

  11. Migrate Premium URL Shortener to a new server

    Follow these steps precisely to migrate the platform without data loss:

    1. Enable maintenance mode in the admin panel settings.
    2. Compress and download all current server files.
    3. Export the shortener database via phpMyAdmin.
    4. On the new server, create a new database and import the SQL file via phpMyAdmin.
    5. If changing the domain: In the database, locate the settings table and update the url value.
    6. Upload and extract the compressed files to the new server.
    7. Manually edit config.php to update the database connection information.
    8. Log in as admin and disable maintenance mode.

  12. System requirements for Premium URL Shortener

    To ensure the Premium URL Shortener script runs smoothly, the server must meet the following minimum specifications:

    • Server: Apache, NGINX, or LiteSpeed
    • PHP: Minimum version 8.2
    • Database: MySQL 5.7 - 8.2 or MariaDB 11.0+
    • Required PHP Modules: openssl, php-curl, php-json, php-mbstring, php-mysql, php-dom, php-xml, php-zip, php-gd, php-iconv
    • Optional Modules: php-imagick (required for advanced QR code manipulation like PDF conversion) and php-bcmath.