Update README.md

This commit is contained in:
Foxly IT 2021-10-13 08:27:43 +02:00 committed by GitHub
parent 3ea46df233
commit 9508f1bc80
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,22 +1,47 @@
# Backup-CloudPanel-Nextcloud
*BorgBackup Script - CloudPanel, Nextcloud*
<div align=center>
[![foxly.de](https://foxly.de/media/223-github-logo-png/)](https://foxly.de)
[![Commits](https://img.shields.io/github/last-commit/foxly-it/Backup-CloudPanel-Nextcloud?style=flat-square)](https://github.com/foxly-it/Backup-CloudPanel-Nextcloud/commits/main) [![GitHub release](https://img.shields.io/github/release/foxly-it/Backup-CloudPanel-Nextcloud?style=flat-square)](https://github.com/foxly-it/Backup-CloudPanel-Nextcloud/releases) [![GitHub license](https://img.shields.io/github/license/foxly-it/Backup-CloudPanel-Nextcloud?style=flat-square&color=lightgray)](LICENSE.md) [![GitHub file size in bytes](https://img.shields.io/github/size/foxly-it/Backup-CloudPanel-Nextcloud/backup.sh?style=flat-square)](https://github.com/foxly-it/Backup-CloudPanel-Nextcloud/blob/main/Backup-CloudPanel-Nextcloud.sh)
---
[![foxly.de](https://foxly.de/media/232-png-bild-png/)](https://foxly.de)
---
</div>
This backupscript is designed to be simple. It is adapted for [CloudPanel](CloudPanel.io). Of course there is also a focus on Nextcloud.
This script is designed for [CloudPanel](CloudPanel.io). It backs up all data located in ```/home/cloudpanel``` to a Borgbackup repository. Furthermore, before the actual backup process, all databases that are specified are backed up and stored in ```/home/cloudpanel/backup```. In the script itself you have to define which database is used, e.g. MySQL/MariaDB or PostgreSQL. Adjustments that need to be changed in the script are marked with TODO.
In the script a Nextcloud instance is also considered, should this function not be used, it can simply be commented out.
It backs up both the databases and the files.
Of course, this script can be adapted to other systems.
---
## Usage
First, a BorgBackup repository must be created.
In order to back up data, a repository must first be created. This can be created locally or on a remote computer via ssh.
*local:*
```
borg init --encryption=repokey /path/to/backup
```
*remote*
```
borg init --encryption=repokey user@server.ip.or.domain:/path/to/backup
```
---
---
Now you can adjust the script to your needs.
## Features
[![foxly.de](https://foxly.de/media/232-png-bild-png/)](https://foxly.de)
* MariaDB/MySQL support
* PostgreSQL support
* Nextcloud support
---
### Operating System
#### Recommended
* Ubuntu 20.04 (__Focal__ Fossa)
* Debian 10 (__Buster__)
* Raspbian 10 (__Buster__)