Bash-SaveSite

Simple tool for saving an entire web-site folder to a timestamped bz2 archive.

Note: I use this script for my own projects, it contains only the features I need.

Table of Contents

Installation | Features | Test | Contributing | License

Installation

Requires: a Debian/Ubuntu version of linux and a Bash version ~4.4. bash-sys installed.

1. Download a release or clone this repository.
2. Use scripts/install.sh to automatically install the application in the /opt/oju/bash project folder.
3. If needed, add PATH="$PATH:/opt/oju/bash/bin" to the .profile files.
4. Update the config.sh configuration file.

Features

This tool allows you to save a website directory, located in /var/www, to a timestamped bz2 archive. The destination is defined in the config.sh file.

Usage: savesite.sh [options] <directory 1> [directory 2 ...]

  <directory 1>   Website directory name located in /var/www

options
  -d | --destination    Destination folder. The default is /home/<user>
  -h | --help           Show this help.
  -l | --active-log     Log mode. Content outputs are logged in a file.
  -n | --no-display     Display mode. Nothing is displayed in terminal.
  -t | --trace          Display var and constants.
  -v | --version        Show the version.
  -w | --wait           Wait user. Wait for user input between actions.

Test

I didn't write any line of 'unit test' code. Sorry.

Contributing

Thanks you for taking the time to contribute. Please fork the repository and make changes as you'd like.

As I use these scripts for my own projects, they contain only the features I need. But If you have any ideas, just open an issue and tell me what you think. Pull requests are also warmly welcome.

If you encounter any bugs, please open an issue.

Be sure to include a title and clear description,as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

License

This project is open-source and is licensed under the MIT License.