Merge branch 'feature/runnable-container'

.github/workflows/publish-image.yaml

@@ -0,0 +1,48 @@
+name: Build and publish the production container image to the GitHub Registry
+
+# Run this workflow every time on every push to the branch `release`.
+on:
+  push:
+    branches: ['feature/runnable-container']
+
+env:
+  IMAGE_NAME: imap-backup
+  REGISTRY_USER: ${{ github.actor }}
+  REGISTRY_PASSWORD: ${{ github.token }}
+  REGISTRY: ghcr.io/${{ github.repository_owner }}
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job.
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Build Image
+        # https://github.com/marketplace/actions/buildah-build
+        id: build-image
+        uses: redhat-actions/buildah-build@v2
+        with:
+          image: ${{ env.IMAGE_NAME }}
+          tags: latest ${{ github.sha }}
+          extra-args: |
+            --ignorefile ./container/.containerignore
+          containerfiles: |
+            ./container/Containerfile
+          labels: |
+            ${{ env.IMAGE_NAME }}:latest
+
+      - name: Publish Image
+        # https://github.com/marketplace/actions/push-to-registry
+        id: push-to-registry
+        uses: redhat-actions/push-to-registry@v2
+        with:
+          image: ${{ steps.build-image.outputs.image }}
+          tags: ${{ steps.build-image.outputs.tags }}
+          registry: ${{ env.REGISTRY }}
+          username: ${{ env.REGISTRY_USER }}
+          password: ${{ env.REGISTRY_PASSWORD }}

Gemfile

@@ -2,9 +2,11 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "aruba", ">= 0.0.0"
-gem "pry-byebug"
-gem "rspec", ">= 3.0.0"
-gem "rubocop-rspec"
-gem "simplecov"
-gem "yard"
+group :development do
+  gem "aruba", ">= 0.0.0"
+  gem "pry-byebug"
+  gem "rspec", ">= 3.0.0"
+  gem "rubocop-rspec"
+  gem "simplecov"
+  gem "yard"
+end

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)

container/.containerignore

@@ -0,0 +1,6 @@
+*
+!bin/imap-backup
+!Gemfile
+!imap-backup.gemspec
+!lib
+!LICENSE

container/Containerfile

@@ -0,0 +1,12 @@
+FROM docker.io/library/ruby:3.2.2-alpine3.18
+
+WORKDIR /app
+
+COPY . .
+RUN \
+  gem install bundler --version "2.4.21" && \
+  BUNDLE_WITHOUT=development bundle install && \
+  rm -f /usr/local/bundle/bin/imap-backup
+ENV PATH=${PATH}:/app/bin
+
+CMD ["imap-backup", "backup", "-c", "/config/imap-backup.json"]