From 1676885ed59fd1333c995c67626cccda885654ec Mon Sep 17 00:00:00 2001
From: Andrew Williams <andy@tensixtyone.com>
Date: Fri, 17 Mar 2023 06:54:16 +0000
Subject: [PATCH] Update README and add example CronJob definition

---
 README.md                 | 11 +++++++++++
 examples/k8s-cronjob.yaml | 23 +++++++++++++++++++++++
 2 files changed, 34 insertions(+)
 create mode 100644 examples/k8s-cronjob.yaml

diff --git a/README.md b/README.md
index c07638c..142baa1 100644
--- a/README.md
+++ b/README.md
@@ -63,6 +63,17 @@ When setting up your cronjob, do make sure you are setting the interval long eno
 
 If you are running this script locally, my recommendation is to run it manually once, before turning on the cron job: The first run will be significantly slower than subsequent runs, and that will help you prevent overlapping during that first run.
 
+### 4) Run this script from a container
+
+This script is also available in a pre-packaged container, [mastodon_get_replies](https://github.com/nanos/mastodon_get_replies/pkgs/container/mastodon_get_replies).
+
+1. Pull the container from `ghcr.io`, using Docker or your container tool of choice: `docker pull ghcr.io/nanos/mastodon_get_replies:latest`
+2. Run the container, passing the command line arguments like running the script directly: `docker run -it ghcr.io/nanos/mastodon_get_replies:latest --access-token=<TOKEN> --server=<SERVER>`
+
+The same rules for running this as a cron job apply to running the container, don't overlap any executions.
+
+An example Kubernetes CronJob for running the container is included in the [`examples`](https://github.com/nanos/mastodon_get_replies/tree/main/examples) folder.
+
 ## Acknowledgments
 
 This script is mostly taken from [Abhinav Sarkar](https://notes.abhinavsarkar.net/2023/mastodon-context), with just some additions and alterations. Thank you Abhinav!
diff --git a/examples/k8s-cronjob.yaml b/examples/k8s-cronjob.yaml
new file mode 100644
index 0000000..accd720
--- /dev/null
+++ b/examples/k8s-cronjob.yaml
@@ -0,0 +1,23 @@
+---
+apiVersion: batch/v1
+kind: CronJob
+metadata:
+  name: mastodon-get-replies
+spec:
+  # Run every 2 hours
+  schedule: "0 */2 * * *"
+  successfulJobsHistoryLimit: 1
+  failedJobsHistoryLimit: 1
+  concurrencyPolicy: Forbid
+  jobTemplate:
+    spec:
+      template:
+        spec:
+          containers:
+            - name: mastodon-get-replies
+              image: ghcr.io/nanos/mastodon_get_replies:latest
+              args:
+                - --server=your.server.social
+                - --access-token=TOKEN
+          restartPolicy: Never
+