System Configuration

Overview

OpenCart’s system configuration section provides tools for maintaining your store, managing logs, performing backups, and handling system-level tasks. Regular maintenance ensures optimal performance and security.

Access system tools from System menu in the admin panel.

System Tools

Backup and Restore

Create backups of your store’s database to protect against data loss.

// From backup.php controller (admin/controller/tool/backup.php)
namespace Opencart\Admin\Controller\Tool;

class Backup extends \Opencart\System\Engine\Controller {
    public function download(): void {
        $this->load->model('tool/backup');
        
        // Generate SQL backup
        $backup = $this->model_tool_backup->backup($this->request->post['table']);
        
        // Set headers for download
        header('Content-Type: application/octet-stream');
        header('Content-Disposition: attachment; filename="' . date('Y-m-d-H-i-s', time()) . '.sql"');
        header('Expires: 0');
        
        echo $backup;
    }
}

Select Tables

Navigate to System → Maintenance → Backup / Restore.Select tables to backup:

All tables (recommended for full backup)
Specific tables (for partial backup)

Download Backup

Click Backup to download a .sql file containing your data.

Backups are downloaded directly to your browser - store them securely off-site.

Restore (if needed)

Use phpMyAdmin or MySQL command line to restore from backup:

mysql -u username -p database_name < backup-2024-01-15.sql

Backup Best Practices:

Create backups before updates or major changes
Store backups in multiple locations (local + cloud)
Test restore procedures periodically
Include both database AND files (upload/ directory)
Automate daily backups via cron job

Error Logs

Monitor and troubleshoot errors in your store.

// From log.php controller (admin/controller/tool/log.php)
namespace Opencart\Admin\Controller\Tool;

class Log extends \Opencart\System\Engine\Controller {
    public function index(): void {
        $file = DIR_LOGS . 'error.log';
        
        if (file_exists($file)) {
            $data['log'] = file_get_contents($file, FILE_USE_INCLUDE_PATH, null);
            $data['size'] = filesize($file);
        }
    }
}

Viewing Error Logs

Navigate to System → Maintenance → Error Logs to view recent errors and warnings.Log location: system/storage/logs/error.log

Clearing Logs

Click Clear to delete the error log file. Recommended when log file becomes very large (>10MB).

Common Errors

PHP Notices: Minor issues, usually safe to ignore
Warnings: Potential problems that should be investigated
Fatal Errors: Critical issues that stop execution
Database Errors: Connection or query problems

Upload Management

Manage file uploads and track upload history.

// From upload.php controller (admin/controller/tool/upload.php)
namespace Opencart\Admin\Controller\Tool;

class Upload extends \Opencart\System\Engine\Controller {
    public function index(): void {
        $this->load->model('tool/upload');
        
        // Get all uploads
        $filter_data = [
            'start' => ($page - 1) * $this->config->get('config_pagination_admin'),
            'limit' => $this->config->get('config_pagination_admin')
        ];
        
        $uploads = $this->model_tool_upload->getUploads($filter_data);
    }
}

View uploaded files at System → Maintenance → Uploads. This includes files uploaded through product options or customer accounts.

Developer Tools

Modification System

OpenCart’s OCMOD system allows extensions to modify core files without directly editing them.

<!-- Example modification XML -->
<?xml version="1.0" encoding="utf-8"?>
<modification>
    <name>My Custom Modification</name>
    <code>my_custom_mod</code>
    <version>1.0</version>
    <author>Your Name</author>
    
    <file path="catalog/controller/product/product.php">
        <operation>
            <search><![CDATA[
                $data['products'] = [];
            ]]></search>
            <add position="after"><![CDATA[
                // Your custom code here
            ]]></add>
        </operation>
    </file>
</modification>

Install Modification

Upload modification XML via Extensions → Installer or place in system/storage/modification/ directory.

Refresh Modifications

Navigate to Extensions → Modifications and click Refresh to apply changes.

Clear Cache

Clear modification cache to see results immediately.

Theme Editor

Edit theme templates directly from the admin panel.

Theme editing in production is risky. Always:

Create backups before editing
Test changes in development environment
Use version control for theme files

Event System

View and manage system events (hooks).

// From event.php model (admin/model/setting/event.php)
namespace Opencart\Admin\Model\Setting;

class Event extends \Opencart\System\Engine\Model {
    public function getEvents(array $data = []): array {
        $sql = "SELECT * FROM `" . DB_PREFIX . "event`";
        
        if (!empty($data['filter_code'])) {
            $sql .= " WHERE `code` = '" . $this->db->escape($data['filter_code']) . "'";
        }
        
        $sql .= " ORDER BY `sort_order` ASC";
        
        return $this->db->query($sql)->rows;
    }
}

Event Fields:

Code: Unique identifier for the event
Trigger: System trigger point (e.g., catalog/model/checkout/order/addOrder/after)
Action: Route to call when triggered
Status: Enable/disable event
Sort Order: Execution priority

Cron Jobs

Setting Up Automated Tasks

Configure cron jobs for scheduled maintenance and updates.

# Example crontab entries

# Currency update (daily at 3 AM)
0 3 * * * /usr/bin/php /path/to/opencart/admin/cli_currency.php

# GDPR data cleanup (weekly on Sunday at 2 AM)
0 2 * * 0 /usr/bin/php /path/to/opencart/admin/cli_gdpr.php

# Sitemap generation (daily at 4 AM)
0 4 * * * /usr/bin/php /path/to/opencart/admin/cli_sitemap.php

Currency Updates
GDPR Cleanup
Subscription Renewals

// catalog/controller/cron/currency.php
namespace Opencart\Catalog\Controller\Cron;

class Currency extends \Opencart\System\Engine\Controller {
    public function index(int $cron_id, string $code, string $cycle, string $date_added, string $date_modified): void {
        $this->load->model('setting/extension');
        
        $extensions = $this->model_setting_extension->getExtensionsByType('currency');
        
        foreach ($extensions as $extension) {
            $this->load->controller('extension/' . $extension['extension'] . '/currency/' . $extension['code']);
        }
    }
}

Updates exchange rates from configured currency services.

// catalog/controller/cron/gdpr.php
public function index(): void {
    $this->load->model('account/gdpr');
    
    // Delete customer data older than retention period
    $this->model_account_gdpr->deleteGdpr();
}

Removes customer data after GDPR retention period expires.

// catalog/controller/cron/subscription.php
public function index(): void {
    $this->load->model('checkout/subscription');
    
    // Process recurring subscriptions
    $subscriptions = $this->model_checkout_subscription->getSubscriptions();
    
    foreach ($subscriptions as $subscription) {
        if ($subscription['date_next'] <= date('Y-m-d')) {
            // Process payment and update next billing date
        }
    }
}

Processes recurring subscription payments.

Cache Management

Clearing Cache

Different cache types require different clearing methods.

Modification Cache

Location: system/storage/modification/Clear via Extensions → Modifications → Refresh

Image Cache

Location: image/cache/Manually delete folder contents or use FTP

System Cache

Location: system/storage/cache/Delete folder contents via FTP or file manager

Template Cache

Location: Managed by TwigDeleted automatically on theme changes

# Clear all caches via command line
cd /path/to/opencart

# Clear modification cache
rm -rf system/storage/modification/*

# Clear image cache
rm -rf image/cache/*

# Clear system cache
rm -rf system/storage/cache/*

Database Maintenance

Optimizing Tables

Regularly optimize database tables for better performance.

-- Optimize all OpenCart tables
OPTIMIZE TABLE 
    oc_product, 
    oc_product_description, 
    oc_category, 
    oc_category_description,
    oc_customer,
    oc_order,
    oc_order_product,
    oc_session;
    
-- Check table status
SHOW TABLE STATUS WHERE Name LIKE 'oc_%';

Run optimization during low-traffic periods as it may temporarily lock tables.

Cleaning Old Data

-- Delete old customer sessions (older than 7 days)
DELETE FROM oc_session 
WHERE expire < DATE_SUB(NOW(), INTERVAL 7 DAY);

-- Delete old customer activities (older than 90 days)
DELETE FROM oc_customer_activity 
WHERE date_added < DATE_SUB(NOW(), INTERVAL 90 DAY);

-- Delete old customer searches (older than 30 days)
DELETE FROM oc_customer_search 
WHERE date_added < DATE_SUB(NOW(), INTERVAL 30 DAY);

Performance Monitoring

Key Metrics to Track

Page Load Time

Monitor average page load times. Target: less than 2 seconds for category/product pages.Tools: Google PageSpeed Insights, GTmetrix

Database Query Time

Slow queries can impact performance. Enable query logging in development.

// In config.php (development only)
define('DB_QUERY_LOGGING', true);

Error Rate

Monitor error.log file size and frequency. Increasing errors indicate issues.

Disk Space

Ensure adequate disk space for:

Product images and uploads
Log files
Database growth
Session storage

System Requirements

Server Requirements

Minimum Requirements:

PHP: >= 8.0.2
MySQL: >= 5.7 or MariaDB >= 10.2
Disk Space: 500MB minimum
Memory: 128MB minimum (256MB recommended)

Required PHP Extensions:

// From composer.json and INSTALL.md
- curl
- gd or imagick
- mysqli or pdo_mysql
- zip
- openssl
- json
- xml
- mbstring

Checking PHP Configuration

<?php
// Create a phpinfo.php file in your web root
phpinfo();

// Check specific settings
echo 'PHP Version: ' . PHP_VERSION . "\n";
echo 'Memory Limit: ' . ini_get('memory_limit') . "\n";
echo 'Upload Max: ' . ini_get('upload_max_filesize') . "\n";
echo 'Post Max: ' . ini_get('post_max_size') . "\n";
echo 'Max Execution Time: ' . ini_get('max_execution_time') . "\n";

Delete phpinfo.php after checking - it exposes server configuration details.

Security Hardening

File Permissions

Set correct permissions:

Directories: 755
Files: 644
config.php: 444 (read-only)

Disable Directory Listing

Add to .htaccess:

Options -Indexes

Move Admin Directory

Rename /admin to something unique:

mv admin my-secure-admin-panel

SSL Certificate

Use HTTPS for all traffic:

Install SSL certificate
Force HTTPS in .htaccess
Update store URLs in settings

Store Settings

Configure general store settings

Development Setup

Set up local development environment

Extensions

Install system extensions

​Overview

​System Tools

​Backup and Restore

​Error Logs

​Upload Management

​Developer Tools

​Modification System

​Theme Editor

​Event System

​Cron Jobs

​Setting Up Automated Tasks

​Cache Management

​Clearing Cache

Modification Cache

Image Cache

System Cache

Template Cache

​Database Maintenance

​Optimizing Tables

​Cleaning Old Data

​Performance Monitoring

​Key Metrics to Track

​System Requirements

​Server Requirements

​Checking PHP Configuration

​Security Hardening

File Permissions

Disable Directory Listing

Move Admin Directory

SSL Certificate

​Related Documentation

Store Settings

Development Setup

Extensions

Overview

System Tools

Backup and Restore

Error Logs

Upload Management

Developer Tools

Modification System

Theme Editor

Event System

Cron Jobs

Setting Up Automated Tasks

Cache Management

Clearing Cache

Database Maintenance

Optimizing Tables

Cleaning Old Data

Performance Monitoring

Key Metrics to Track

System Requirements

Server Requirements

Checking PHP Configuration

Security Hardening

Related Documentation