Skip to content

ThewApp/og-image

Repository files navigation

og-image

.github/workflows/docker.yml

Node.js application to capture and generate an open graph image.

Examples

Usage

Pull new image

docker pull ghcr.io/thewapp/og-image:main

Start

docker run -d -p 8080:8080 --restart always --name og-image ghcr.io/thewapp/og-image:main

Stop

docker stop og-image && docker rm og-image

Endpoints

/<hostname>.png?path=/<path>
/<hostname>/<any>.png?path=/<path>

<path> must have leading / and encoded with encodeURIComponent. Hence path can contain query (?) and url fragment (#).

Accepted <hostname>