Self-hosted PLC mirror

Go to file

Astra 61f751b59a update files		2024-10-26 02:59:57 +01:00
cmd/plc-mirror	Update cmd/plc-mirror/Dockerfile	2024-10-26 03:50:41 +02:00
models	Import	2024-02-15 16:10:39 +00:00
util	Rename module and run `go mod tidy`	2024-09-25 22:05:40 +01:00
.dockerignore	feature: skip unnecessary recompilation in some cases	2024-09-07 11:47:15 +01:00
.gitignore	Add ignore to override.	2024-02-23 09:26:11 -08:00
LICENSE	Add license	2024-04-13 20:41:56 +01:00
README.md	update files	2024-10-26 02:59:57 +01:00

README.md

PLC mirror

Syncs PLC operations log into a local table, and allows resolving did:plc: DIDs without putting strain on https://plc.directory and hitting rate limits.

Build Instructions

cd cmd/plc-mirror
podman build -t plc-mirror:latest .

Setup

podman run \
    -dit \
    --name plc-mirror \
    -p 8080:8080 -p 11004:11004 \
    -e PLC_POSTGRES_URL="postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}/${POSTGRES_DB}?sslmode=disable" \
    plc-mirror:latest

Usage

You can directly replace https://plc.directory with a URL to the exposed port (11004 by default).

Note that on the first run it will take quite a few hours to download everything, and the mirror with respond with 500 if it's not caught up yet.