https://github.com/devcom-iitb/mongogbackup

Remote Mongo DB backup on Google Drive
https://github.com/devcom-iitb/mongogbackup

backup gdrive mongodb

Last synced: 14 days ago
JSON representation

Remote Mongo DB backup on Google Drive

• Host: GitHub
• URL: https://github.com/devcom-iitb/mongogbackup
• Owner: DevCom-IITB
• License: mit
• Created: 2024-07-04T13:18:36.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-10-20T16:38:50.000Z (3 months ago)
• Last Synced: 2024-12-24T20:16:37.337Z (14 days ago)
• Topics: backup, gdrive, mongodb
• Language: Python
• Homepage: https://pypi.org/project/mongogbackup/
• Size: 18.3 MB
• Stars: 5
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mongogbackup

Secure Mongo DB backups on Google Drive

## Installation

```bash

$ pip install mongogbackup

```

## Usage

### Import

```python

from  mongogbackup import MongoConfig, MongoGBackup

```

### Initialization

```python

mongo_config = MongoConfig(

                                db_name='your_db',

                                host='localhost',

                                port=27017,

                                # optional parameters below

                                username='root',

                                password='password',

                                auth_db='admin'

                            )

backup_handler =MongoGBackup(

                            mongoConfig=mongo_config,

                            credentials_file='path/credentials.json',  

                            key='fernet_key'

                        )

gdrive = GoogleDriveHandler(

                             credentials_file='path/credentials.json',

                             parent_id = target_folder_id,

                             file_name = name_of_the_file_you_want_to_upload,

                             num_files = how_many_files_you_want_to_keep_in_the_rotating_file_handler               

)

```

## Creating dump

```python

backup_handler.backups.backup(dir='backup_path/dump/')

```

### Compressing the dump

```python

backup_handler.targz.pack(source_path='backup_path/dump/', output_path='filename.tar.gz')

```

### Encrypting the dump

```python

backup_handler.encrypt.encrypt_file('filename.tar.gz', 'destination.file')

```

### Uploading to Google Drive

Add your credentials.json file to your project (you can generate this on Google Cloud Console)

## Simple upload to google drive

```python

gdrive.upload_file_to_drive(file_name, parent_id)

```

## Delete all previous files with same name and upload to Google Drive

```python

gdrive.overwrite_and_upload_to_drive(file_name, parent_id)

```

## Upload to Google Drive with a rotating file handler

```python

gdrive.upload_to_drive_with_rfh(file_name, parent_id, num_files)

```

## Restore Backups

Download the backup file from google drive (say: backup.encr)

### Decrypt the file

```python

backup_handler.encrypt.decrypt_file('backup.encr', 'filename.tar.gz')

```

### Decompressing the tar-gz dump

```python

backup_handler.targz.unpack(source_path='filename.tar.gz', output_path='backup_dir/dump/')

```

### Restoring the dump

```python

backup_handler.backups.restore(bck_dir='backup_dir/dump/')

```

## Hash Checks

To ensure that your backup file has not been tampered with, you can perform a SHA-256 hash check.

```python

backup_handler.hash.generate_file_hash('source.file')

```

You can also save the hash into a txt file by executing

```python

backup_handler.hash.save('hash.txt')

```

or print the hash by executing

```python

print(backup_handler.hash.last_hash())

```

You can also compare the current generated hash with any other string using

```python

backup_handler.hash.compare_generated('hash-string')

# returns True or False on comparision

```

Made with ❤️ by DevCom, 2024