plc-mirror/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.