Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
WeeJeWel committed Jul 30, 2024
1 parent 2a1ed31 commit 6c13acc
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Google Backup

This module automatically downloads your Google Mail, Contacts & Calendar to separate files. It'll sync only new Mails, Contacts & Events.

This tool will output the following directory structue:

```
.
├── contacts/
│ └── *.vcf
├── calendar/
│ └── *.ical
└── mail/
├── received/
│ └── *.eml
└── sent/
└── *.eml
```

## Why?

Google makes great services, but there are many horror stories of people locked out of their accounts. So be safe, and keep your data backed up!

## Usage

### 1. Create a Google App Password

Create a Google App Password at [https://myaccount.google.com/apppasswords](https://myaccount.google.com/apppasswords).

### 2. Run

```bash
$ npx -y google-backup --username "[email protected]" --password "abcd efgh ijkl mnop" --filepath "~/Backups/Google/"
```

> Hint: You can schedule this in a cronjob for automated backups.

0 comments on commit 6c13acc

Please sign in to comment.