This commit is contained in:
Alexandre Dulaunoy 2024-09-03 06:20:05 +02:00
commit 9808362509
Signed by: adulau
GPG key ID: 09E2CD4944E6CBCD
5 changed files with 61 additions and 4 deletions

1
.dockerignore Normal file
View file

@ -0,0 +1 @@
justfile

4
CHANGELOG.md Normal file
View file

@ -0,0 +1,4 @@
# Changelog
## Version 1.0.0 (September 1, 2024)
Initial release

25
Dockerfile Normal file
View file

@ -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"]

View file

@ -24,6 +24,8 @@ It is likely that I have not considered all possible use cases, or that I've bee
## Table of contents
* [Installation](#installation)
* [From source](#from-source)
* [Container](#container)
* [Dependencies](#dependencies)
* [Usage](#usage)
* [Environment variables](#environment-variables)
@ -49,10 +51,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:

View file

@ -17,8 +17,6 @@ descendants:
- {{ .Id }}
{{- end }}
{{- end }}
layout: page
title: paperbay.org Mastodon - {{ .Post.URI }}
---
{{ .Post.Content | toMarkdown }}