Backup Script Setup

This document explains how to configure the bkp.sh backup script to be executable from the command line.

Setup Steps

1. Create the env.json File

The script requires an env.json file to function properly. This file can be created by copying the existing example_env.json file. Follow these steps:

1. Open a terminal in the directory where the bkp.sh script is located.

2. Ensure the example_env.json file is present in the same directory as the bkp.sh script.

3. Create the env.json file by copying example_env.json:

   cp example_env.json env.json

   This will create a new file named env.json based on the contents of example_env.json.

4. Edit the env.json file as needed to include the necessary environment variables or configurations required by the script. You can use any text editor to modify this file.

2. Make the Script Executable

To make the bkp.sh script executable from the command line, you'll need to change the file permissions. Follow these steps:

1. Change the file permissions to make it executable by running the following command:

   chmod +x bkp.sh

2. The script is now ready to be executed. You can run it directly from the terminal with:

   ./bkp.sh

3. (Optional) Add the Script to Your PATH

If you want to be able to run the script from any directory, you can add the directory containing the script to your PATH. To do this:

1. Open your shell configuration file (e.g., ~/.bashrc, ~/.bash_profile, or ~/.zshrc).

2. Add the following line to the end of the file:

   export PATH=$PATH:/path/to/script/directory

   Replace /path/to/script/directory with the actual path to the directory where bkp.sh is located.

3. Update your shell environment to apply the changes:

   source ~/.bashrc

   or

   source ~/.bash_profile

4. You can now run the script from any directory by simply typing:

   bkp.sh

Usage Example

To execute the bkp.sh script, type:

./bkp.sh