Cockpit Backup Manager

🇬🇧 English | 🇷🇺 Русский

English

Cockpit Backup Manager

A module for Cockpit CMS designed to create, manage, and restore backups of your system and data.

Features

Flexible Backup: Create .tar.gz archives, including:
- Cockpit CMS Core: Cockpit system files.
- Website Files: All project files, except the cockpit folder.
- Database:
  - For Mongolite: Database data is copied along with Cockpit core files (stored in cockpit/storage/data).
  - For MongoDB: A separate database dump is created using the mongodump utility.
Exclusions: Ability to specify paths (files or directories) to exclude from the backup via module settings.
Backup Management:
- View a list of created backups with size and date information.
- Download backups via the admin panel.
- Delete backups via the admin panel.
Restoration from Backup:
- Restoration functionality via the admin panel (for a working server).
- Special script restore.php for restoring to a new or "empty" server (outside the admin panel).

Requirements

Base:

Cockpit CMS: v2.x (the module was developed for this version).
PHP: v8.1+ (or higher, depending on Cockpit CMS requirements).

For restoration via `restore.php` script:

PHP Phar Extension: Must be enabled in PHP configuration.
For MongoDB backup/restore:
- The shell_exec function must be enabled in PHP configuration.
- The mongodump and mongorestore utilities must be installed on the server and available via PATH.

Installation

Copy the Backup folder from this repository to your_cockpit_root/addons/. If necessary, copy the translation file to your_cockpit_root/config/. Your folder structure should look approximately like this:

your_project_root/ ├── cockpit/ │ └── addons/ │ │ └── Backup/ │ │ ├── Controller/ │ │ │ └── ... │ │ ├── Helper/ │ │ │ └── ... │ │ ├── views/ │ │ │ └── ... │ │ ├── admin.php │ │ ├── bootstrap.php │ │ ├── icon.svg │ │ └── restore.php │ └── config/ │ └── i18n/ │ ├── ru/ │ │ └── Backup.php

Log in to the Cockpit admin panel.
Go to Settings -> Backup.

Configuration

Module configuration is done via the Cockpit admin panel:

In the admin panel, go to Settings -> Backup.
On the "Backup Settings" tab:
- Backup Configuration: Select which parts of the system will be included in the backup (Cockpit Core, Website Files, Database).
- Excluded Paths: Specify paths (relative to the site root) that should be excluded from the backup. For example: my_temp_folder, cockpit/cache/some_large_files. Additional configuration for backup storage path (via cockpit/config/config.php file): By default, backups are stored in your_cockpit_root/backups. You can change this by adding the following section to cockpit/config/config.php:

<?php return [ 'backup' => [ 'config' => [ 'backup_path' => '/path_to_your_custom_backups_folder', ], ], ];

Usage

Creating and Managing Backups (via Admin Panel)

Go to Settings -> Backup.
On the "List of backups" tab:
- You will see a list of all previously created backups.
- For each backup, the following actions are available:
  - Download (download): Downloads the backup archive to your computer.
  - Restore (restore): Initiates the restoration process from the current server. ATTENTION: This will overwrite existing files and the database.
  - Delete (delete): Deletes the backup file.
- The "Create a backup" button starts the process of creating a new backup according to current settings.
- The "Refresh list of backups" button updates the list of backup files.

Restoring to an Empty Server (using `restore.php`)

This method is intended for situations where Cockpit CMS is not functioning or is being installed on a new server. IMPORTANT:

Placement of the restore.php script:
- Download the restore.php file from the admin panel (under "Backup List", link "Download restoration file: restore.php").
- Upload this restore.php to the ROOT DIRECTORY OF YOUR WEBSITE.
- For example, if your domain example.com points to public_html/, then restore.php should be in public_html/. The cockpit folder after restoration will be in public_html/cockpit.
Placement of the backup file:
- Upload your .tar.gz backup file to the same directory as the restore.php script.
Initiating the restoration process:
- Open restore.php in your browser (e.g., https://yourdomain.ru/restore.php).
- The script will automatically detect backup files in the current directory and select the most recent one.
- On the restoration confirmation page:
  - Check the backup details.
  - Make sure the paths to your Cockpit CMS installation and Mongolite data folder are specified correctly. The script will attempt to suggest default paths based on its location, but they may require adjustment.
  - Click "Start Restoration".
- The script will perform the following actions:
  - Extract the archive to a temporary directory.
  - Delete existing files in target directories (Cockpit, project files) before copying from the backup.
  - Copy Cockpit core files and project files.
  - Set necessary permissions for all restored files and directories.
  - Restore the database (Mongolite by copying files, MongoDB via mongorestore).
  - Clear Cockpit CMS cache.
  - Delete temporary files.
- After successful restoration, the page will display:
  - A link "Start Over".
  - A button "Delete restoration files and go to site".

WARNING:

After successful restoration, YOU MUST IMMEDIATELY DELETE the restore.php file from the server. This is a powerful tool that can be used by malicious actors to completely overwrite your site. Use the "Delete backup file and restoration script" button for safe cleanup. If automatic deletion fails, remove the files manually.

License

The module is distributed under the GNU Affero General Public License v3 (AGPLv3).

Contacts

Author: Yuriy Plotnikov
Website: https://yuriyplotnikovv.ru

Русский