Skip to content

Commit

Permalink
Add container usage to README
Browse files Browse the repository at this point in the history
  • Loading branch information
joeyates committed Nov 2, 2023
1 parent 08396dc commit a924401
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,43 @@ See below for a [full list of commands](#Commands).

# Installation

## Docker or Podman

If you have Docker or Podman installed, the easist way to use imap-backup
is via the container image.

You'll need to choose a path on your computer where your backups will be saved,
we'll use `./my-data` here.

If you have just one account, you can do as follows:

```sh
docker run -v ./my-data:/data -ti ghcr.io/joeyates/imap-backup:latest \
imap-backup single backup \
--email me@example.com --password mysecret --server imap.example.com \
--path /data/me_example.com
```

If you have multiple accounts, you can create a configuration file.

You'll need to choose a path on your computer where your configuration will be saved,
we'll use `./my-config` here.

First, run the menu-driven setup program to configure your accounts

```sh
docker run -ti -v ./my-config:/config -v ./my-data:/data -ti ghcr.io/joeyates/imap-backup:latest \
imap-backup setup -c /config/imap-backup.json
```

Then, run the backup

```sh
docker run -v ./my-config:/config -v ./my-data:/data -ti ghcr.io/joeyates/imap-backup:latest \
imap-backup backup -c /config/imap-backup.json
```


## Homebrew (macOS)

![Homebrew installs](https://img.shields.io/homebrew/installs/dm/imap-backup?label=Homebrew%20installs)
Expand Down

0 comments on commit a924401

Please sign in to comment.