astra
/
plc-mirror
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Self-hosted PLC mirror
195 Commits
1 Branch
0 Tags
402 KiB
Go 98.4%
Dockerfile 1.6%
 
 
Go to file
Astra bb036dc6d8 Update README.md 2024-10-26 03:53:15 +02: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
Makefile Remove everything that's not needed for PLC mirror 2024-09-25 22:04:13 +01:00
README.md Update README.md 2024-10-26 03:53:15 +02:00
docker-compose.yml Remove everything that's not needed for PLC mirror 2024-09-25 22:04:13 +01:00
example.env Remove everything that's not needed for PLC mirror 2024-09-25 22:04:13 +01:00
go.mod Update go.mod 2024-10-25 23:56:56 +02:00
go.sum Rename module and run `go mod tidy` 2024-09-25 22:05:40 +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

In the top directory run the following:

podman build -t plc-mirror:latest -f cmd/plc-mirror/Dockerfile .

Setup

  • Decide where do you want to store the data
  • Copy example.env to .env and edit it to your liking.
    • POSTGRES_PASSWORD can be anything, it will be used on the first start of postgres container to initialize the database.
  • make up

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.