registration-relay

module
v0.0.0-...-c00b355 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 9, 2024 License: AGPL-3.0

README

registration-relay

A relay that helps the iMessage bridge fetch data from registration providers (Mac, iOS).

Usage

Build the binary (clone + go build) or use a Docker image from GHCR (ghcr.io/beeper/registration-relay), then just run it with some environment variables for configuration.

  • REGISTRATION_RELAY_SECRET (required) - 32 byte secret key as base64, used to authenticate providers when reconnecting.
    • A secret can be generated with openssl rand -base64 32
  • REGISTRATION_RELAY_LISTEN (defaults to :8000) - IP and port to listen on.
  • REGISTRATION_RELAY_METRICS_LISTEN (defaults to :5000) - IP and port to listen on for Prometheus metrics.

A reverse proxy configured to allow websockets should be pointed at the RELAY_LISTEN port to enable TLS. The bridge and registration providers can then be pointed at the public address of the reverse proxy.

Directories

Path Synopsis
cmd
internal
api

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL