Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
WeeJeWel committed Aug 25, 2024
1 parent 74c4568 commit 5c888df
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@
[![Build & Publish NPM Package](https://github.com/WeeJeWel/node-icloud-backup/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/WeeJeWel/node-icloud-backup/actions/workflows/npm-publish.yml)
[![Build & Publish Docker Image](https://github.com/WeeJeWel/node-icloud-backup/actions/workflows/ghcr-publish.yml/badge.svg)](https://github.com/WeeJeWel/node-icloud-backup/actions/workflows/ghcr-publish.yml)

This module automatically downloads your iCloud Drive to the filesystem.
This module automatically downloads your iCloud Drive to the local filesystem.

This tool will output the following directory structure:

```
.
├── Drive
└── Drive
└── <...>
```

## Why?
Expand All @@ -32,14 +33,16 @@ $ npx -y icloud-backup \
--filepath "~/Backups/iCloud/"
```

> The first time you will need to enter your 2FA code manually.
> Hint: You can schedule this in a cronjob for automated backups.
#### Docker

If you prefer Docker, this is an example how to run:

```bash
$ docker run \
$ docker run -it \
--env ICLOUD_BACKUP_USERNAME="[email protected]" \
--env ICLOUD_BACKUP_PASSWORD="abcd efgh ijkl mnop" \
--env ICLOUD_BACKUP_FILEPATH="/backups" \
Expand Down

0 comments on commit 5c888df

Please sign in to comment.