Server Sync – Pelican Panel Plugin

Important: Work in Progress This plugin is still under active development. Use carefully and expect changes.

What it does

• Bidirectional or unidirectional file synchronization between two Pelican Panel servers.
• Full folder sync or selective path sync with exclude rules.
• Incremental sync after first sync (based on file modified time).
• Live sync (running servers) and on-restart sync (stop, sync, start partner).
• Automatic scheduler + manual "Sync Now" with per-server and global limitations.
• Includes detailed logging and admin/server UI.

Quick highlights

• DB Tables: server_sync_pairs, server_sync_logs, server_sync_settings, plus servers.server_sync_limit.
• Enums: SyncDirection, SyncScope, SyncMode.
• Core services: SyncService (transfer engine), SyncValidator, ScheduleMirrorService.
• Job: ExecuteSyncJob handles queue updates and user notifications.
• Task schema: SyncTaskSchema for schedule integration.
• Permissions: server-sync.view, server-sync.manage, server-sync.trigger.

Installation

1. Put plugin in plugins/server-sync.
2. php artisan migrate for new tables.
3. Set server_sync_limit > 0 on servers to enable UI.
4. Set global config in Admin → Plugin Settings.

Quick usage

1. Create sync pair (Admin or server panel).
2. Choose direction + scope + mode.
3. Configure excluded paths (toggle + file browser).
4. Use "Sync Now" or schedule with schedule task type server_sync.

Important config values

• enforce_same_egg: optional egg matching.
• max_sync_pairs_per_server: global cap.
• default_interval_minutes, min_interval_minutes, max_file_size_mb, concurrent_sync_limit, log_retention_days.

Note

• Server Sync pairs may cause resource/disk/transfer load; monitor performance.
• If a server has server_sync_limit = 0, sync tasks are hidden for it.

Translations

Community translations are managed in a separate public repository:

server-sync-translations

• Submit new translations via Pull Request
• All PRs are automatically validated (missing keys, placeholders, etc.)
• Merged translations are automatically synced back into this plugin

Currently included: 🇬🇧 English, 🇩🇪 German — see all available languages

License

MIT License — see LICENSE for details.

Author

Eranio — eranio.de