imap-backup 14.2.0 → 14.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1da04e15e0f6c66398320aff6a7ce638e50089db3b6470a3aed7c6a4b49f0a66
-  data.tar.gz: '0261943b048d8a97f334ca58f21010ae26799ff0afab23cd611cf4528ac841c7'
+  metadata.gz: 51b770e733777e6ba74110df4759c369d9fd5cba2934fa22c6b6dbc4b053c3df
+  data.tar.gz: ec1ea8bf99e182313b5c92e1c3b4eb36226ba461ff876d5fe884fadd3ccf9aba
 SHA512:
-  metadata.gz: 627bcbbdeab8a9bf8cd68cdfd28ae68fbd0961aeb8ce87703428b4a6c1709c3a08a6b45619fc9455d124e31c677af0423e726bbe2c89ad28abc35ddff1fdf2ad
-  data.tar.gz: ea19474d8dbe419330b96f46860d44ca930d94188492afde2afde4a7a3018e190904b13af6f820c88295540deca0887abee908987abcef8a2d17d7c21fe239db
+  metadata.gz: 858cdc1a5c9df78b9a9edfe19be8a6703d47072c27d7072ab9476773b80f12e5b37984665bb52e579c65fb7aa4b76a8baf8244cd5fe76c1e927da59dba9684ed
+  data.tar.gz: 041a4aef1052f76b006c8b54e14c73dba718480ecf56c8d21ad284566c29bb2948f7b278d5b4da2fe04860fa5e584d0a81d75e04d11dfb3dac04f820ffcef956

data/README.md

@@ -34,6 +34,45 @@ 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)
@@ -76,8 +115,8 @@ you can pass all the necessary parameters directly to the `single backup` comman
 ## 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
 

data/lib/imap/backup/version.rb

@@ -2,7 +2,7 @@ module Imap; end
 
 module Imap::Backup
   MAJOR    = 14
-  MINOR    = 2
+  MINOR    = 3
   REVISION = 0
   PRE      = nil
   VERSION  = [MAJOR, MINOR, REVISION, PRE].compact.map(&:to_s).join(".")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 14.2.0
+  version: 14.3.0
 platform: ruby
 authors:
 - Joe Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-21 00:00:00.000000000 Z
+date: 2023-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline