From f2b07a5516c272251b89e5d9013202679ece9d37 Mon Sep 17 00:00:00 2001
From: Gabriel Garrido <gabriel@garrido.io>
Date: Sun, 1 Sep 2024 13:02:44 -0600
Subject: [PATCH] Add a Dockerfile and update README

---
 .dockerignore |  1 +
 Dockerfile    | 25 +++++++++++++++++++++++++
 README.md     | 29 ++++++++++++++++++++++++++++-
 3 files changed, 54 insertions(+), 1 deletion(-)
 create mode 100644 .dockerignore
 create mode 100644 Dockerfile

diff --git a/.dockerignore b/.dockerignore
new file mode 100644
index 0000000..08e1001
--- /dev/null
+++ b/.dockerignore
@@ -0,0 +1 @@
+justfile
diff --git a/Dockerfile b/Dockerfile
new file mode 100644
index 0000000..1da9514
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,25 @@
+FROM golang:1.23.0-alpine3.20 AS build
+
+WORKDIR /app
+COPY go.mod go.sum .
+RUN go mod download
+
+COPY . .
+ENV CGO_ENABLED=0
+ENV GOOS=linux
+
+RUN go build -o mastodon-markdown-archive
+
+FROM alpine:3.20
+RUN apk add --no-cache ca-certificates
+
+LABEL org.opencontainers.image.title="Mastodon Markdown Archive"
+LABEL org.opencontainers.image.description="Archive Mastodon posts as markdown files"
+LABEL org.opencontainers.image.vendor="Gabriel Garrido"
+LABEL org.opencontainers.image.licenses=MIT
+LABEL org.opencontainers.image.url=https://git.garrido.io/gabriel/mastodon-markdown-archive
+LABEL org.opencontainers.image.source=https://git.garrido.io/gabriel/mastodon-markdown-archive
+LABEL org.opencontainers.image.documentation=https://git.garrido.io/gabriel/mastodon-markdown-archive
+
+COPY --from=build /app/mastodon-markdown-archive /usr/bin/mastodon-markdown-archive
+ENTRYPOINT ["/usr/bin/mastodon-markdown-archive"]
diff --git a/README.md b/README.md
index 92ae7bc..10c91d7 100644
--- a/README.md
+++ b/README.md
@@ -49,10 +49,37 @@ It is likely that I have not considered all possible use cases, or that I've bee
 
 ## Installation
 
+### From source
+
 [Go](https://go.dev/doc/install) is required for installation.
 
 You can clone this repo and run `go build main.go` in the repository's directory, or you can run `go install git.garrido.io/gabriel/mastodon-markdown-archive@latest` to install a binary of the latest version.
 
+### Container
+
+A [Dockerfile](./Dockerfile) is included in this repository.
+
+An image can be built as follows:
+
+`docker build -t mastodon-markdown-archive .`
+
+A host folder should be mounted into the container so that the files generated by the container are persisted to the host's file system. You can run the tool as follows:
+
+```sh
+docker run --rm -v ~/posts:/posts mastodon-markdown-archive \
+--user=https://social.coop/@ggpsv \
+--dist=/posts \
+--exclude-replies \
+--exclude-reblogs \
+--persist-last=./last \
+--visibility=public \
+--download-media=bundle \
+--threaded=true \
+--max-id=$(test -f ./last && cat ./last || echo "")
+```
+
+The container's volume target (e.g `:/posts`) should match the directory passed to the `--dist` argument.
+
 ## Dependencies
 
 This tool has only two direct dependencies, which are included to provide useful, though largely optional, functionality in templates:
@@ -413,4 +440,4 @@ This is done specifically to support Hugo [page bundles](https://gohugo.io/conte
 
 ## Known issues
 
-1. A reply post may still appear in the list of posts despite using `--exclude-replies`. This happens when the post in question is a reply to a post that has since been deleted. It looks like Mastodon's API stops treating the reply as a reply. It no longer points to another post, and thus is not affected by the `exclude_replies` parameter.
\ No newline at end of file
+1. A reply post may still appear in the list of posts despite using `--exclude-replies`. This happens when the post in question is a reply to a post that has since been deleted. It looks like Mastodon's API stops treating the reply as a reply. It no longer points to another post, and thus is not affected by the `exclude_replies` parameter.