update readme and license
This commit is contained in:
Asif Bacchus
parent
a299cca365
commit
0b1d220b5b
2
LICENSE
2
LICENSE
|
|
@ -1,6 +1,6 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) <year> <copyright holders>
|
||||
Copyright (c) 2019 Asif Bacchus
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
|
|
|||
66
README.md
66
README.md
|
|
@ -1,7 +1,63 @@
|
|||
# seafileBackup
|
||||
# Backup a bare-metal Seafile installation using borgbackup <!-- omit in toc -->
|
||||
|
||||
Backup Seafile DB and data using borgbackup to rsync.net
|
||||
Simple POSIX-compliant script to backup a bare-metal Seafile installation using borgbackup to a remote SSH-capable storage system. I strongly suggest using rsync.net since they are very reliable, fast and even have special pricing for people using borgbackup/attic [(details here)](https://www.rsync.net/products/attic.html).
|
||||
|
||||
This readme will be an overiew of the purpose of the repo and BASIC usability
|
||||
information. Detailed usage information will all be presented in the repo's
|
||||
wiki.
|
||||
**THIS SCRIPT USES BORG [(borgbackup)](https://borgbackup.readthedocs.io/en/stable/) SO PLEASE ENSURE THAT IS INSTALLED CORRECTLY BEFORE TRYING TO USE THIS SCRIPT!**
|
||||
|
||||
- [Basic features of this script:](#Basic-features-of-this-script)
|
||||
- [Check out the wiki](#Check-out-the-wiki)
|
||||
- [Overview](#Overview)
|
||||
- [Installation](#Installation)
|
||||
- [Running the script](#Running-the-script)
|
||||
- [*seafbackup.sh*](#seafbackupsh)
|
||||
- [Final thoughts](#Final-thoughts)
|
||||
|
||||
## Basic features of this script:
|
||||
|
||||
- Backup your entire Seafile program and data directories.
|
||||
- Dump Seafile SQL databases to a temporary directory, add them to the backup and then remove the temporary directory.
|
||||
- Easily add additional directories/files to the backup by modifying a plain-text file.
|
||||
- Easily exclude directories/files from being backed up (i.e. thumbnails) by modifying a plain-text file.
|
||||
- Optionally stop Seafile services during the backup and restart them after.
|
||||
- Optionally copy a 503 error page to your webserver so users know your server is unavailable due to a backup being performed. The 503 file is removed when the backup is completed.
|
||||
- Run 'borg prune' to trim old backups according to your schedule so you don't pay storage fees for super-old or un-needed backups.
|
||||
- Create a clear, easy to parse log file so you can keep an eye on warnings/errors, etc.
|
||||
- The generated log file can be easily parsed by tools like *logwatch* so you can integrate backup-monitoring with your existing system-monitoring solutions.
|
||||
|
||||
## Check out the wiki
|
||||
|
||||
This readme is an overview of the script. For detailed instructions on how the script works, what it does and it's various options, please read the wiki! I've tried to annotate the files as best I could with many many comments, but seriously, reading the wiki if you're stuck is the best approach since I try to go over everything step-by-step.
|
||||
|
||||
## Overview
|
||||
|
||||
This script has NO mandatory parameters. If no parameters are specified, it will proceed using defaults which normally align with the recommended Seafile installation defaults. That being said, it is impossible to determine defaults for things like your backup-server settings, so please make sure you customize the *seafbackup.details* file with appropriate details!
|
||||
|
||||
By default, the script will dump Seafile SQL databases and back them up along with your entire Seafile program and data directories. You can add additional files to be backed up by adding paths to *xtraLocations.borg*.
|
||||
|
||||
## Installation
|
||||
|
||||
Simply clone this repo to the desired location. I recommend somewhere simple like *ROOT's home directory* so any sensitive information is restricted to the root user by default.
|
||||
|
||||
```bash
|
||||
cd /root
|
||||
sudo git clone https://git.asifbacchus.app/asif/seafileBackup.git
|
||||
```
|
||||
|
||||
## Running the script
|
||||
|
||||
```bash
|
||||
./seafbackup.sh [parameters]
|
||||
|
||||
# display abbreviated help
|
||||
./seafbackup.sh --help
|
||||
```
|
||||
|
||||
## *seafbackup.sh*
|
||||
|
||||
Please open this file in a text editor and follow the comments to fill in the parameters with the correct values for your environment and your backup server.
|
||||
|
||||
## Final thoughts
|
||||
|
||||
I hope this makes backing up your Seafile server easier and removes one more mundane administrative task from your schedule :-) If you have any comments, questions, concerns, suggestions for improvements or notice any bugs, please file an issue in this repo!
|
||||
|
||||
For more scripts and solutions like this, check out my blog at [My Techie-Thoughts](https://mytechiethoughts.com). Thanks!
|
||||
|
|
|
|||
Loading…
Reference in New Issue