https://github.com/raphadam/pleer

👥 Peer-to-peer port forwarding CLI over WebRTC.
https://github.com/raphadam/pleer

Last synced: about 2 months ago
JSON representation

👥 Peer-to-peer port forwarding CLI over WebRTC.

• Host: GitHub
• URL: https://github.com/raphadam/pleer
• Owner: raphadam
• Created: 2024-08-02T04:04:23.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-08-18T10:17:00.000Z (6 months ago)
• Last Synced: 2024-11-08T13:24:59.464Z (3 months ago)
• Language: Go
• Size: 123 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-pion - raphadam/pleer - Securely forward local ports over the internet using WebRTC (DataChannel)

README

        
![Architecture](docs/pleerlogo.png)

## Introduction

A command-line tool that enables users to securely forward local ports over the internet using WebRTC. Leveraging the Pion Golang library, this tool supports both TCP and UDP protocols in a multiplexed, encrypted, and concurrent connection. 

## Example use cases

- **Remote Development:** Share your local development server with team members without exposing your network.

- **Game Hosting:** Host a local game server and forward the port to allow friends to join remotely.

- **Secure Access:** Access internal resources securely over the internet.

## Architecture

![Architecture](docs/pleergraph.png)

## Usage

### Create a party and forward ports

```sh

$ pleer -host -tcp 8080 -tcp 25565

```

After executing this command, the CLI will provide you with a `PARTY_ID`. You need to share this `PARTY_ID` with any peer who wants to join the party.

### Join a party

```sh

$ pleer -join {PARTY_ID}

```

Once you successfully join a party, you will automatically be able to exchange data over the ports defined by the host. For the connection to happen, you must have the signaling server.

## Signaling Server

The signaling server is required for establishing a WebRTC connection between peers. You can run the signaling server using:

```bash

$ go run ./signal

```

## Roadmap

- **Desktop Application:** Develop a GUI-based desktop application for ease of use.

- **Enhanced UDP Support:** Improve UDP handling for better performance in real-time applications.

- **Stability Improvements:** Address edge cases and ensure robust connection handling.