Sign inSign up

gsoperator/openrport-pairing

By gsoperator

•Updated 5 months ago

OpenRPort pairing service: agent installer URLs and binary mirror

Image
0

1.1K

gsoperator/openrport-pairing repository overview

⁠openrport-pairing

rport-pairing packaged for the Grace-Solutions/OpenRPort⁠ stack. Hosts one-shot installer URLs for new agents and serves the static agent binaries that the rendered installer scripts download. Config is rendered from environment variables at startup.

⁠Tags

  • latest  — rolling, retagged on every push to main of the source repo
  • <short-sha>  — immutable, one tag per main-branch commit (use this in production)
  • vX.Y.Z, vX.Y  — published when the source repo cuts a release tag

⁠Ports (host networking)

PortPurpose
38102Pairing HTTP endpoint (POST /, GET /<code>, GET /update) + static binaries under ${RPORT_PAIRING_BINARIES_PATH}

⁠Required environment

VariableNotes
OPENRPORT_PAIRING_PUBLIC_URLExternal URL the rendered installer scripts point at
OPENRPORT_SERVER_PUBLIC_URLURL agents connect to after install
PAIRING_INTERNAL_PORTDefault 38102

Optional: RPORT_PAIRING_BINARIES_DIR / RPORT_PAIRING_BINARIES_PATH to expose a directory of pre-fetched agent artefacts at a custom path, and OPENRPORT_PAIRING_DOWNLOADS_* to override the URLs baked into the rendered installer/update scripts. Full reference: .env.example⁠.

⁠Volumes

PathPurpose
/etc/rport-pairingOptional bind-mount; if config.toml exists it overrides env-rendered config
/usr/share/rport-pairing/binariesRead-only mount of fetched agent artefacts (zip + signature)
/var/log/rport-pairingLog files

⁠Quick start

The intended deployment is the full three-service stack via Compose:

git clone https://github.com/Grace-Solutions/OpenRPort
cd OpenRPort
cp .env.example .env   # then edit secrets
make prepare && make up

Or pull and run this image alone:

docker run -d --name openrport-pairing --network host \
  -e OPENRPORT_PAIRING_PUBLIC_URL=https://rport.example.com/pairing \
  -e OPENRPORT_SERVER_PUBLIC_URL=https://rport.example.com \
  -v /srv/openrport/binaries:/usr/share/rport-pairing/binaries:ro \
  gsoperator/openrport-pairing:latest

⁠Companion images

⁠Source

Built from Grace-Solutions/OpenRPort⁠ (Container/Pairing/Dockerfile). Upstream: openrport/openrport-pairing⁠.

⁠License

MPL-2.0 (inherits from upstream rport-pairing).

Tag summary

Content type

Image

Digest

sha256:a03541d34…

Size

34.1 MB

Last updated

5 months ago

docker pull gsoperator/openrport-pairing