initial
This commit is contained in:
commit
107a0e3fb1
17
CHANGELOG.md
Normal file
17
CHANGELOG.md
Normal file
@ -0,0 +1,17 @@
|
||||
# Changelog
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [Unreleased](https://git.d3data.de/D3Public/varbackup/compare/1.0.0...rel_1.x)
|
||||
|
||||
## [1.0.0](https://git.d3data.de/D3Public/varbackup/releases/tag/1.0.0) - 2025-01-29
|
||||
### Added
|
||||
- initial implementation
|
||||
- can create required folders (if missing)
|
||||
- can create required configuration (if missing)
|
||||
- check current files against latest backup
|
||||
- save folder as archive
|
||||
- older versions than the lastest are compressed
|
||||
- use file rotation (max 100 files per default, customizable)
|
||||
21
LICENSE.md
Normal file
21
LICENSE.md
Normal file
@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2025 D3 Data Development (Inh. Thomas Dartsch)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
56
README.md
Normal file
56
README.md
Normal file
@ -0,0 +1,56 @@
|
||||
|
||||
[](https://packagist.org/packages/d3/varbackup)
|
||||
[](https://git.d3data.de/D3Public/varbackup/raw/branch/main/LICENSE.md)
|
||||
|
||||
# Var Backup
|
||||
|
||||
create a rotating backup of the var folder
|
||||
|
||||
## Installation
|
||||
|
||||
Open a command line and navigate to the root directory of the project. Execute the following command. Adapt the path details to your installation environment.
|
||||
|
||||
```
|
||||
composer require d3/varbackup
|
||||
```
|
||||
|
||||
## How to use
|
||||
|
||||
Create a cronjob or execute the following script manually:
|
||||
|
||||
```
|
||||
./vendor/bin/varbackup.sh
|
||||
```
|
||||
|
||||
## Customizing
|
||||
|
||||
Execute the script initially. After that, modify the `backup/var/rotatemap_var.conf` to your need
|
||||
|
||||
## Changelog
|
||||
|
||||
See [CHANGELOG](CHANGELOG.md) for further informations.
|
||||
|
||||
## Contributing
|
||||
|
||||
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue. Don't forget to give the project a star! Thanks again!
|
||||
|
||||
- Fork the Project
|
||||
- Create your Feature Branch (git checkout -b feature/AmazingFeature)
|
||||
- Commit your Changes (git commit -m 'Add some AmazingFeature')
|
||||
- Push to the Branch (git push origin feature/AmazingFeature)
|
||||
- Open a Pull Request
|
||||
|
||||
## Licence of this software (Var Backup) [MIT]
|
||||
|
||||
(2025-01-29)
|
||||
|
||||
```
|
||||
Copyright (c) D3 Data Development (Inh. Thomas Dartsch)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
```
|
||||
23
composer.json
Normal file
23
composer.json
Normal file
@ -0,0 +1,23 @@
|
||||
{
|
||||
"name": "d3/varbackup",
|
||||
"description": "handle backups of the var directory",
|
||||
"type": "library",
|
||||
"keywords": [
|
||||
"d3",
|
||||
"backup",
|
||||
"rotation"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "D3 Data Development (Inh. Thomas Dartsch)",
|
||||
"email": "info@shopmodule.com",
|
||||
"homepage": "https://www.d3data.de",
|
||||
"role": "Owner"
|
||||
}
|
||||
],
|
||||
"homepage": "https://www.oxidmodule.com/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"bin": ["varbackup.sh"]
|
||||
}
|
||||
26
varbackup.sh
Executable file
26
varbackup.sh
Executable file
@ -0,0 +1,26 @@
|
||||
#!/bin/bash
|
||||
|
||||
currDir="$(pwd)/backup/var/"
|
||||
|
||||
if [ ! -d "$currDir" ]; then
|
||||
echo "creating backup directory ${currDir}";
|
||||
mkdir -p "${currDir}"
|
||||
fi
|
||||
|
||||
if [ ! -f "${currDir}../rotatemap_var.conf" ]; then
|
||||
echo "creating config file"
|
||||
printf "${currDir}var.tar.gz {\nrotate 100\n}" > ${currDir}/../rotatemap_var.conf
|
||||
fi
|
||||
|
||||
echo "pack var directory"
|
||||
tar -cf ${currDir}var.new.tar ./var;
|
||||
|
||||
if [ ! -f "${currDir}var.tar" ] || [ "$(cmp ${currDir}var.tar ${currDir}var.new.tar)" ]; then
|
||||
gzip -c ${currDir}var.tar > ${currDir}var.tar.gz
|
||||
logrotate -f -s "${currDir}../rotatemap_var.state" "${currDir}../rotatemap_var.conf"
|
||||
mv ${currDir}var.new.tar ${currDir}var.tar
|
||||
else
|
||||
rm ${currDir}var.new.tar
|
||||
fi
|
||||
|
||||
echo "finished"
|
||||
Loading…
x
Reference in New Issue
Block a user