Installation & Setup

Installation & Setup

Complete step-by-step guide to installing the Server Sync plugin and initial configuration.

Prerequisites

• Pelican Panel with plugin support installed and running
• PHP 8.2 or newer on the Panel server
• Database user with CREATE TABLE privileges
• storage/ and bootstrap/cache/ writable (permissions 0755, owner: web server user)

Step 1: Install the Plugin

1. Download the latest release from GitHub Releases
2. Extract the ZIP file to:

   /var/www/pelican/plugins/server-sync/
   

3. Verify the directory structure:

   plugins/server-sync/
   ├── src/
   ├── config/
   ├── database/
   ├── lang/
   ├── resources/
   ├── plugin.json
   └── composer.json
   

4. Clear the application cache:

   php artisan cache:clear
   php artisan config:clear
   php artisan view:clear
   

5. Verify the plugin appears under Admin Panel → Plugins as "Server Sync"

The migration (2026_03_13_100000_create_server_sync_tables.php) runs automatically and creates the required database tables.

Step 2: Configure Plugin Settings

Navigate to Admin → Plugin Settings → Server Sync and configure the global settings:

Step 3: Set Server Limits

For each server that should be synchronized:

1. Go to Admin → Servers → Edit server
2. Navigate to the Server Sync tab
3. Set the Server Sync Limit (e.g., 3)
4. Save

Important: A limit of 0 disables Server Sync for that server entirely — the page is not visible and permissions are not shown.

Step 4: Create First Sync Pair

In the Admin Panel:

1. Navigate to Admin → Server Sync
2. Click Create Pair
3. Select Main Server and Sub Server
4. Configure direction, scope, sync mode, and interval
5. Optional: Use the File Browser to set exclude paths
6. Click Create

In the Server Panel:

1. Open the server and navigate to the Server Sync tab
2. Click Create Pair
3. Select a partner server (only eligible servers are shown)
4. Configure the sync settings
5. Click Create

Troubleshooting