Skip to content

rtctunnel/rtctunnel

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
October 12, 2020 04:12
May 9, 2022 18:19
October 8, 2022 16:49
October 7, 2022 18:08
December 10, 2019 10:33
May 9, 2022 18:19
January 19, 2021 10:57
September 29, 2022 09:16
May 9, 2022 18:19
fix
September 29, 2022 08:31
February 26, 2018 06:25
November 5, 2018 11:37
March 31, 2022 08:38
November 9, 2018 13:31

RTCTunnel

RTCTunnel builds network tunnels over WebRTC.

WARNING:

This is a proof of concept and should NOT be used in production. Errors/Exceptions like disconnects and invalid data are not well handled, and may result in panics.

An overview of the application and how and why it was built is available here: RTCTunnel: Building a WebRTC Proxy with Go.

Installation

RTCTunnel can be installed via go install:

go install github.com/rtctunnel/rtctunnel/cmd/rtctunnel@latest

Or downloaded from the releases page (for linux).

Usage

RTCTunnel creates a network tunnel over WebRTC between two peers. Those peers are identified by a public key.

To use RTCTunnel first create a config with:

rtctunnel init

You can see info with:

rtctunnel info

Once you've done that on both peers, copy the two public keys and add a route. A route has four components: a local peer, a local port, a remote peer and a remote port. All network connections and data sent to the local port will be forwarded to the remote peer. For example:

export CLIENT_KEY=
export SERVER_KEY=
rtctunnel add-route \
    --local-peer=$CLIENT_KEY \
    --local-port=6379 \
    --remote-peer=$SERVER_KEY \
    --remote-port=6379

The route must be added on both peers and the CLIENT_KEY and SERVER_KEY should be set to the peer keys.

Once the routes are added you can run rtctunnel with:

rtctunnel run

Typically it would be run in the background.

A docker-compose example is available in examples/redis.

Configuration

Configuration is stored in a yaml file based on github.com/kirsle/configdir:

Linux:   $XDG_CONFIG_HOME or "$HOME/.config"
Windows: %APPDATA% or "C:\\Users\\%USER%\\AppData\\Roaming"
macOS:   $HOME/Library/Application Support

You can see the path by running rtctunnel help.

Signal Channel

In addition to the key pair and routes you can set the signal channel in the config:

keypair:
  public: xxx
  private: xxx
routes: []
signalchannel: operator://localhost:8000

The default signal channel is apprtc:// which uses a websocket server for appr.tc.