imap-backup 14.2.0 → 14.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +41 -2
  3. data/lib/imap/backup/version.rb +1 -1
  4. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1da04e15e0f6c66398320aff6a7ce638e50089db3b6470a3aed7c6a4b49f0a66
4
- data.tar.gz: '0261943b048d8a97f334ca58f21010ae26799ff0afab23cd611cf4528ac841c7'
3
+ metadata.gz: 51b770e733777e6ba74110df4759c369d9fd5cba2934fa22c6b6dbc4b053c3df
4
+ data.tar.gz: ec1ea8bf99e182313b5c92e1c3b4eb36226ba461ff876d5fe884fadd3ccf9aba
5
5
  SHA512:
6
- metadata.gz: 627bcbbdeab8a9bf8cd68cdfd28ae68fbd0961aeb8ce87703428b4a6c1709c3a08a6b45619fc9455d124e31c677af0423e726bbe2c89ad28abc35ddff1fdf2ad
7
- data.tar.gz: ea19474d8dbe419330b96f46860d44ca930d94188492afde2afde4a7a3018e190904b13af6f820c88295540deca0887abee908987abcef8a2d17d7c21fe239db
6
+ metadata.gz: 858cdc1a5c9df78b9a9edfe19be8a6703d47072c27d7072ab9476773b80f12e5b37984665bb52e579c65fb7aa4b76a8baf8244cd5fe76c1e927da59dba9684ed
7
+ data.tar.gz: 041a4aef1052f76b006c8b54e14c73dba718480ecf56c8d21ad284566c29bb2948f7b278d5b4da2fe04860fa5e584d0a81d75e04d11dfb3dac04f820ffcef956
data/README.md CHANGED
@@ -34,6 +34,45 @@ See below for a [full list of commands](#Commands).
34
34
 
35
35
  # Installation
36
36
 
37
+ ## Docker or Podman
38
+
39
+ If you have Docker or Podman installed, the easist way to use imap-backup
40
+ is via the container image.
41
+
42
+ You'll need to choose a path on your computer where your backups will be saved,
43
+ we'll use `./my-data` here.
44
+
45
+ If you have just one account, you can do as follows
46
+
47
+ ```sh
48
+ docker run -v ./my-data:/data -ti ghcr.io/joeyates/imap-backup:latest \
49
+ imap-backup single backup \
50
+ --email me@example.com --password mysecret --server imap.example.com \
51
+ --path /data/me_example.com
52
+ ```
53
+
54
+ Podman will work exactly the same.
55
+
56
+ If you have multiple accounts, you can create a configuration file.
57
+
58
+ You'll need to choose a path on your computer where your configuration will be saved,
59
+ we'll use `./my-config` here.
60
+
61
+ First, run the menu-driven setup program to configure your accounts
62
+
63
+ ```sh
64
+ docker run -ti -v ./my-config:/config -v ./my-data:/data -ti ghcr.io/joeyates/imap-backup:latest \
65
+ imap-backup setup -c /config/imap-backup.json
66
+ ```
67
+
68
+ Then, run the backup
69
+
70
+ ```sh
71
+ docker run -v ./my-config:/config -v ./my-data:/data -ti ghcr.io/joeyates/imap-backup:latest \
72
+ imap-backup backup -c /config/imap-backup.json
73
+ ```
74
+
75
+
37
76
  ## Homebrew (macOS)
38
77
 
39
78
  ![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
76
115
  ## GMail
77
116
 
78
117
  To use imap-backup with GMail, Office 365 and other services that require
79
- OAuth2 authentication, you can use [email-oauth2-proxy](https://github.com/simonrob/email-oauth2-proxy)
80
- to handle authentication, and then connect to the proxy on a local port.
118
+ OAuth2 authentication, you can use [email-oauth2-proxy](https://github.com/simonrob/email-oauth2-proxy).
119
+ 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/).
81
120
 
82
121
  # Backup
83
122
 
@@ -2,7 +2,7 @@ module Imap; end
2
2
 
3
3
  module Imap::Backup
4
4
  MAJOR = 14
5
- MINOR = 2
5
+ MINOR = 3
6
6
  REVISION = 0
7
7
  PRE = nil
8
8
  VERSION = [MAJOR, MINOR, REVISION, PRE].compact.map(&:to_s).join(".")
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: imap-backup
3
3
  version: !ruby/object:Gem::Version
4
- version: 14.2.0
4
+ version: 14.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Joe Yates
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-10-21 00:00:00.000000000 Z
11
+ date: 2023-11-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: highline