Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/own-pay/OwnPay-Documentation/llms.txt

Use this file to discover all available pages before exploring further.

Before downloading or installing OwnPay, confirm that your hosting environment satisfies all of the requirements listed on this page. An environment that is missing a PHP extension or running an unsupported PHP version will fail at the web installer’s requirements check — reviewing this page first saves time and avoids a broken install.

Server Requirements

The table below lists the minimum configuration required for OwnPay to run and the recommended configuration for a production payment gateway handling real traffic.
ComponentMinimumRecommended
PHP8.38.3 (latest patch)
MySQL5.78.0+
RAM512 MB2 GB+
Disk Space1 GB5 GB+
PHP 8.3 is a hard requirement. OwnPay will not start on PHP 8.2 or earlier. If your hosting panel shows an older default PHP version, switch it to 8.3 before running the installer.

Required PHP Extensions

All of the extensions listed below must be enabled on your server. Most modern shared hosting plans include them by default. On a VPS, install them manually alongside PHP 8.3.
ExtensionPurpose
php-mysqlMySQL database connectivity
php-curlOutbound HTTP requests to payment gateways
php-xmlXML processing for gateway responses
php-zipZIP archive support for plugin installation
php-gdImage manipulation for logos and receipts
php-bcmathArbitrary-precision arithmetic for financial calculations
php-intlInternationalization and locale formatting
The OwnPay web installer runs an automated requirements check on its first screen and flags any missing extensions with a red indicator. You will not be able to proceed past that screen until all extensions are green.

Hosting Compatibility

Shared hosting is supported and works well for low-to-medium traffic deployments. Popular providers that are compatible with OwnPay include Hostinger, Namecheap, SiteGround, and Bluehost.Requirements for shared hosting:
  • PHP 8.3 selectable per domain (via cPanel MultiPHP, DirectAdmin PHP Selector, or Plesk PHP Settings)
  • MySQL database creation access
  • File Manager or FTP access to upload and extract files
  • Cron job configuration panel (cPanel Advanced → Cron Jobs, DirectAdmin Cron Jobs, or Plesk Scheduled Tasks)
On shared hosting, the document root for your domain must be pointed to the public/ subdirectory inside the OwnPay installation, not the root folder. Most shared hosts let you configure this in the domain settings panel.

Domain and SSL Requirements

OwnPay requires a proper domain and HTTPS in production. These are not optional for a payment gateway.
  • Custom domain — A registered domain name pointed at your server via DNS A record
  • SSL certificate — HTTPS is required; use Let’s Encrypt (free) or any valid certificate authority
  • DNS access — Required to configure per-brand custom domains and brand-level checkout domains
Running OwnPay over plain HTTP (http://) in a production environment is insecure and will cause modern browsers to block payment form submissions. Always use HTTPS.

Cron Job Requirement

OwnPay depends on a background scheduler to process payment queues, check gateway callbacks, send notifications, and handle retries. You must configure a cron job that runs once per minute.
* * * * * php /path/to/ownpay/public/index.php cron
Replace /path/to/ownpay/public/index.php with the actual absolute path on your server. On shared hosting, this is typically something like /home/YOUR_USERNAME/public_html/public/index.php. On a VPS, it is usually /var/www/ownpay/public/index.php.
If the cron job is not configured, payment status checks, webhook retries, and notification emails will not work. The system will appear functional but many features will silently fail.

Optional Enhancements

These components are not required to run OwnPay but are strongly recommended for production deployments with meaningful traffic.
Redis is the recommended driver for both the cache layer and the background job queue. Without Redis, OwnPay falls back to file-based caching and synchronous queue processing, which is slower and less reliable under load.Install Redis on Ubuntu/Debian:
sudo apt install -y redis-server php8.3-redis
sudo systemctl enable redis-server
After installation, switch the cache and queue drivers to redis in Settings → System inside the OwnPay admin panel.
Both Nginx and Apache are supported, but Nginx is recommended for VPS deployments. Nginx handles static asset serving more efficiently and its configuration for OwnPay is simpler and more explicit. See the Installation Guide for the complete recommended Nginx server block.
For installations serving customers across multiple geographic regions, placing a CDN in front of OwnPay’s static assets (JavaScript, CSS, images) reduces checkout page load times. Any standard CDN (Cloudflare, BunnyCDN, AWS CloudFront) can be used with OwnPay.

Mobile SMS Gateway Requirements

The optional mobile SMS gateway feature — which automatically parses mobile-banking SMS alerts from providers like bKash and Nagad — requires a local Android device connected to your OwnPay installation.
RequirementSpecification
Android DeviceRequired for SMS automation features (optional)
The Android SMS gateway is an optional feature and is not needed for standard payment processing via Stripe, PayPal, or other plugin-based gateways. It is specifically for operators who need to automate local mobile-money payment verification.

Browser Requirements for the Admin Panel

The OwnPay admin panel is a web application and works in all modern browsers.
  • Chrome / Chromium 90+
  • Firefox 88+
  • Safari 14+
  • Edge 90+

Once your environment meets these requirements, proceed to the Installation Guide.

Build docs developers (and LLMs) love