gocompile/localrelay repository overview

⁠Localrelay

Localrelay⁠ is a cross platform CLI & lib which acts as a reverse proxy allowing the destination address to be customised and allows the use of a SOCKS5 proxy. Supporting both raw TCP connections and HTTP/HTTPS connections with options such as; IP locking, Certificate pinning. This app allows you to host services e.g. Nextcloud on Tor and access it on your mobile or laptop anywhere.

⁠Use Cases

If you self host a service for example; Bitwarden⁠, Nextcloud⁠, Syncthing⁠, Grafana⁠, Gitea⁠... You may not want to expose your public IP address to the internet. Especially considering some self-hosted platforms such as Plex⁠ has been exploited with code execution vulnerabilities⁠. You may consider to protect it behind Tor (however this isn't full proof).

Access your local or remote services securely over Tor⁠ without needing to port forward.

Many apps such as Nextcloud, Termis and Bitwarden do not allow you to specify a proxy when connecting to your self-hosted server. Localrelay allows you to host a local reverse proxy on your devices loopback. This relay then encrypts the outgoing traffic through your set SOCKS5 proxy (Tor: 127.0.0.1:9050).

When at home connect locally, when away connect over Tor. Securely connect remotely over Tor without port forwarding AND when at home connect directly with high speeds.

⁠Docker Installation

Compressed image size: <3mb Super small light weight, low CPU, RAM and disk usage container perfect for low power devices.

docker-compose.yaml

version: "3"
services:
  localrelay:
    container_name: localrelay
    image: gocompile/localrelay:latest
    network_mode: "host"
    restart: unless-stopped
    volumes:
      - ./localrelay:/etc/localrelay:ro

docker-compose up -d

Place your relay configs in ./localrelay/. The configs will be loaded when the relay starts.