README.md in imap-backup-14.2.0 vs README.md in imap-backup-14.3.0

- old
+ new

@@ -32,10 +32,49 @@ 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 +``` + +Podman will work exactly the same. + +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) If you have [Homebrew](https://brew.sh/), do this: @@ -74,11 +113,11 @@ (see the [`single backup`](docs/commands/single-backup.md) docs). ## GMail To use imap-backup with GMail, Office 365 and other services that require -OAuth2 authentication, you can use [email-oauth2-proxy](https://github.com/simonrob/email-oauth2-proxy) -to handle authentication, and then connect to the proxy on a local port. +OAuth2 authentication, you can use [email-oauth2-proxy](https://github.com/simonrob/email-oauth2-proxy). +See [this blog post about using imap-backup with email-oauth2-proxy](https://joeyates.info/posts/back-up-gmail-accounts-with-imap-backup-using-email-oauth2-proxy/). # Backup Manually, from the command line: