├── LICENSE ├── README.md ├── backup_manager.conf └── backup_manager.sh /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # S3 Backup Manager 2 | 3 | ## Table of Contents 4 | - [Introduction](#introduction) 5 | - [How It Works](#how-it-works) 6 | - [Installation](#installation) 7 | - [Configuration](#configuration) 8 | - [Automate with Crontab](#automate-with-crontab) 9 | - [Contribution](#contribution) 10 | 11 | ## Introduction 12 | **S3 Backup Manager** is a command-line tool built using Bash. Its primary aim is to simplify the process of managing, backing up, restoring, and viewing files from an AWS S3 bucket. With the rise of data-driven applications and the need for data integrity and recovery, this tool becomes an indispensable utility for any system administrator or developer interacting with S3 buckets. 13 | 14 | image 15 | 16 | 17 | ## How It Works 18 | This tool operates with a source bucket and a backup bucket: 19 | 20 | 1. **Source Bucket**: This is where your active data resides. Any files or directories in this bucket are what you would consider "live" or "production" data. 21 | 22 | 2. **Backup Bucket**: This bucket is the destination for all backup operations. The tool uses AWS's sync command to create backups into folders named after the current date. For example, a backup performed on the 15th of August, 2023 would reside in a folder named `2023-08-15`. 23 | 24 | Example Backup Bucket Structure: 25 | ``` 26 | ├── 2023-08-12 27 | │ ├── file1.txt 28 | │ ├── file2.txt 29 | │ └── data/ 30 | ├── 2023-08-13 31 | │ ├── file1.txt 32 | │ ├── file2.txt 33 | │ └── data/ 34 | ├── 2023-08-14 35 | │ ├── file1.txt 36 | │ ├── file2.txt 37 | │ └── data/ 38 | ``` 39 | 40 | 3. **Backup**: Creates a snapshot of the source bucket and stores it into the backup bucket under a folder named with the current date. 41 | 42 | 4. **Restore**: Lets you select a specific date from the available backups and syncs its content to the source bucket, effectively restoring your data to that point in time. 43 | 44 | 5. **Show**: There are two show options: 45 | - Show all files in the main source bucket. 46 | - Display all files of a selected backup. 47 | 48 | ## Installation 49 | 50 | Before you begin, ensure you have the following installed: 51 | 52 | 1. **AWS CLI**: Install AWS CLI. Depending on your OS, the installation method may vary. Here's how you can install it on Ubuntu: 53 | ```bash 54 | sudo apt-get install awscli 55 | ``` 56 | on the centos 57 | ```bash 58 | sudo pip install awscli --upgrade 59 | ``` 60 | Please note that you should have the last version of AWS-CLI so please check [official-aws-installation](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) 61 | 62 | 2. **JQ**: This is a lightweight and flexible command-line JSON processor. 63 | ```bash 64 | sudo apt-get install jq 65 | ``` 66 | on the centos 67 | ```bash 68 | sudo yum install jq 69 | ``` 70 | 71 | 4. **Backup Manager Script**: Ensure the `backup_manager.sh` script is present on your system and is executable. You can clone it from the repository and make it executable: 72 | ```bash 73 | git clone git@github.com:hamid/s3-backup-manager.git 74 | chmod +x backup_manager.sh 75 | ``` 76 | 77 | ## Configuration 78 | 79 | 1. **AWS CLI Configuration**: Before you can use the tool, you must configure the AWS CLI with your credentials. 80 | ```bash 81 | aws configure 82 | ``` 83 | Follow the prompts to input your AWS Access Key ID, Secret Access Key, default region, and default output format. 84 | 85 | 2. **Backup Configuration**: To keep your configuration tidy and separate from the main script, all configurations are stored in `backup_config.conf`. Open this file and replace the placeholders with the appropriate values for your setup. The script will source this file to get the configuration values. 86 | ``` 87 | # Define our buckets and folder 88 | SOURCE_BUCKET="your-source-bucket-name" 89 | BACKUP_BUCKET="your-backup-bucket-name" 90 | BACKUP_FOLDER="file-backups" 91 | CURRENT_DATE=$(date +\%Y-\%m-\%d) 92 | 93 | ``` 94 | 95 | ## Automate with Crontab 96 | To automate the backup process, you can leverage `crontab`. Here's an example of how you can set up the script to run automatically: 97 | 98 | 1. Open the crontab for editing: 99 | ```bash 100 | crontab -e 101 | ``` 102 | 103 | 2. Add the following line to run the backup at 10:10 AM every day and then exit the script: 104 | ``` 105 | 10 10 * * * (echo "3"; sleep 2; echo "7") | /path/to/backup_manager.sh 106 | ``` 107 | 108 | Remember to adjust the path and time according to your preferences. 109 | 110 | ## Contribution 111 | If you think of a feature that would enhance this tool or encounter a bug, please raise an issue or submit a pull request. Your contributions are highly welcomed! 112 | -------------------------------------------------------------------------------- /backup_manager.conf: -------------------------------------------------------------------------------- 1 | # Configuration file for S3 Backup Manager 2 | 3 | # Define our buckets and folder 4 | SOURCE_BUCKET="your-source-bucket-name" 5 | BACKUP_BUCKET="your-backup-bucket-name" 6 | BACKUP_FOLDER="file-backups" 7 | CURRENT_DATE=$(date +\%Y-\%m-\%d) 8 | -------------------------------------------------------------------------------- /backup_manager.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # S3 Backup Manager 4 | # 5 | # This script provides functionalities to backup, restore, and manage files from an AWS S3 bucket. 6 | # Developer: Hamid Reza Salimian 7 | # Repository: https://github.com/hamid/s3-backup-manager 8 | # Email: xsx.hamid@gmail.com 9 | # 10 | # Make sure to configure the backup_manager.conf before executing this script. 11 | 12 | # Source the configuration file 13 | source backup_manager.conf 14 | 15 | # Color codes 16 | GREEN='\033[0;32m' 17 | BLUE='\033[0;34m' 18 | RED='\033[0;31m' 19 | RESET='\033[0m' 20 | DIVIDER="-------------------------------------------" 21 | 22 | # Function to display a message 23 | print_message() { 24 | color=$1 25 | message=$2 26 | echo -e "${color}${message}${RESET}" 27 | echo -e "${DIVIDER}\n" 28 | } 29 | 30 | # Function to display a boxed message 31 | print_boxed_message() { 32 | color=$1 33 | message=$2 34 | echo -e "${color}+${DIVIDER}+" 35 | echo "| ${message} |" 36 | echo -e "+${DIVIDER}+\n${RESET}" 37 | } 38 | 39 | # Global array to store the list of backups 40 | declare -a backups 41 | 42 | # Function to update the global list of available backups 43 | update_backups() { 44 | backups=($(aws s3 ls s3://$BACKUP_BUCKET/$BACKUP_FOLDER/ | awk '{print $NF}' | sed '/^$/d')) 45 | } 46 | 47 | # Function to display the list of backups 48 | show_backups() { 49 | update_backups 50 | print_message "${BLUE}" "Available Backups:" 51 | for i in "${!backups[@]}"; do 52 | echo "$((i+1)). ${backups[i]}" 53 | done 54 | echo -e "\n\n" 55 | } 56 | 57 | # Function to select a backup from the global list 58 | select_backup() { 59 | print_message "${BLUE}" "\nAvailable Backups:" 60 | for i in "${!backups[@]}"; do 61 | echo "$((i+1)). ${backups[i]}" 62 | done 63 | echo -e "\n\n" 64 | read -p "Select a backup by number: " choice 65 | if [[ "$choice" -ge 1 && "$choice" -le "${#backups[@]}" ]]; then 66 | SELECTED_FOLDER="${backups[$((choice-1))]}" 67 | else 68 | echo "Invalid choice." 69 | exit 1 70 | fi 71 | } 72 | 73 | # Function to restore a backup 74 | restore_backup() { 75 | update_backups 76 | select_backup 77 | aws s3 sync s3://$BACKUP_BUCKET/$BACKUP_FOLDER/$SELECTED_FOLDER s3://$SOURCE_BUCKET/ --delete 78 | if [ $? -eq 0 ]; then 79 | print_boxed_message "${GREEN}" "Restoration from $SELECTED_FOLDER successful." 80 | else 81 | print_message "${RED}" "Restoration failed. Please check and try again." 82 | fi 83 | } 84 | 85 | # Function to create a backup 86 | create_backup() { 87 | aws s3 sync s3://$SOURCE_BUCKET/ s3://$BACKUP_BUCKET/$BACKUP_FOLDER/$CURRENT_DATE --exclude "backups/*" 88 | if [ $? -eq 0 ]; then 89 | print_boxed_message "${GREEN}" "Backup successful. New folder $CURRENT_DATE created." 90 | else 91 | print_message "${RED}" "Backup failed. Please check and try again." 92 | fi 93 | } 94 | 95 | # Function to show all files of main bucket 96 | show_files_main_bucket() { 97 | aws s3 ls s3://$SOURCE_BUCKET/ 98 | } 99 | 100 | # Function to show all files of a selected backup 101 | show_files_backup() { 102 | update_backups 103 | select_backup 104 | aws s3 ls s3://$BACKUP_BUCKET/$BACKUP_FOLDER/$SELECTED_FOLDER 105 | } 106 | 107 | # Main menu 108 | while true; do 109 | print_message "${BLUE}" "Backup Manager" 110 | echo "1. Show available backups" 111 | echo "2. Restore" 112 | echo "3. Backup" 113 | echo "4. Show All files of Main Bucket" 114 | echo "5. Show All files of backups" 115 | echo "6. Exit" 116 | echo -n "Please select an option [1-6]: " 117 | read option 118 | 119 | case $option in 120 | 1) show_backups ;; 121 | 2) restore_backup ;; 122 | 3) create_backup ;; 123 | 4) show_files_main_bucket ;; 124 | 5) show_files_backup ;; 125 | 6) exit 0 ;; 126 | *) print_message "${RED}" "Invalid option, please try again." ;; 127 | esac 128 | done 129 | --------------------------------------------------------------------------------