idct/php-proxmox-backups

Simple PHP executable tool for making backups with Proxmox 5 env easier.

dev-master 2019-08-18 00:13 UTC

Requires

• php: >=5.4.0
• ext-json: *
• phpmailer/phpmailer: ^6.0

MIT

• IDCT Bartosz Pachołek

• container
• php
• backup
• Virtualization
• ovh
• devops
• vm
• Proxmox
• sysops
• ct

README

Simple tool for easing the execution of VMs and CTs backups with Proxmox 5 environment (provided by OVH).

Apart from starting backups of defined machines allows to send notification emails (SMTP required) or Telegram messages using a Telegram Bot.

FEATURES

• init of backups building using internal proxmox tools
• storing on FTPs and keeping a backlog on N backups
• sending notification emails
• sending Telegram notifs

TODOs

• schedule of backups
• different rules for backlog: to keep weekly, monthly and not only daily entries
• provide better readme
• different FTPs for different machines
• master logging

Installation

Download

Download ZIP package or clone using git:

git clone [e-mail]:ideaconnect/php-proxmox-backups.git

or install using Composer:

composer require idct/php-proxmox-backups

Install

Install using Composer:

composer install

This will create the vendors folder with all required libraries.

Create config.json file (check configuration section below and config_sample.json).

Execute the tool:

cd bin/
./dobackups

In case of errors try to execute using php directly:

cd bin/
php dobackups

You can also add this to cron - for example to execute at 23:00 each day:

0 23 * * * cd [path to your application]/bin && php dobackups > /var/log/proxmox-backups.log 2>&1

Configuration

Create config.json file with two objects: global, machines (array).

For example:

{
    "global": {},
    "machines: []
}

If you want FTP upload support define ftp object in the global section - for example:

{
    "global": {
        "ftp": {
            "login": "sample-username",
            "pass": "your-password",
            "dir": "/backups/",
            "host": "ftpbackups.some.host.net"
        }
    },
    "machines: []
}

Machine must have ftp.backlog value defined to use the ftp feature.

If you want to use email notifications feature then please add smtp object into the global section - for instance:

{
    "global": {
        "smtp": {
            "host": "smtp.your.host.net",
            "username": "smtp_username",
            "password": "smtp_password",
            "port": 25,
            "from_mail": "[e-mail]",
            "from_name": "My Best Backups"
        },
        "ftp": {
            "login": "sample-username",
            "pass": "your-password",
            "dir": "/backups/",
            "host": "ftpbackups.some.host.net"
        }
    },
    "machines: []
}

The most important part is to provide information about VMs or CTs which are meant to be included in the process. Sample block:

        {
            "id": 101,
            "storage": "backups",
            "email": "[e-mail]",
            "ftp.backlog": 3,
            "telegram": {
                "bot": "<telegram bot id>",
                "channel": "<telegram channel id>"
            }
        }

• id -> identifier of the VM or CT from Proxmox
• storage -> identifier of the storage from Proxmox to which the particular VM (or CT) can perform backups
• email -> optional, if set then email notifications about the process will be sent (if SMTP is provided)
• telegram -> optional, allows sending simple notifications using a Telegram Bot.

You can provide more than one machine (VM or CT).

Contribution

I more than appreciate any contribution: please provide it using pull requests or issues reporting. Be sure to follow PSR rules when contributing any code!