pair

module
v0.0.11 Latest Latest
Warning

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

Go to latest
Published: Dec 30, 2020 License: MIT

README

pair

2 parts

  • server for hosting webrtc session descriptions
  • client for hosting/joining a session

based on work by https://github.com/maxmcd/webtty

Demo video

How-To

  • requires pair and tmux installed
  • client host must be started in a tmux session
  • client guest must not be started in a tmux session

Start by hosting a session:

# host
$ pair

Share this command with your guest:
  pair http://<some url>

Invite a guest by quickly supplying the command output above

# guest
$ pair http://<url from host>

Optionally setup a simple local testing server and use it:

$ pair-server-simple -v &
$ pair -v -sdp http://localhost

Setup local testing server with mkcert:

mkcert -install
mkdir -p certs
cd certs
mkcert localhost.dev
mkcert localhost
mkcert <someotherdomain>
cd ..
# append '127.0.0.1 localhost.dev <someotherdomain>' to /etc/hosts file
pair-server -v -domain localhost.dev

Run server in production with acme:

# ensure chosen domain is registered and can access public server on ports 80 and 443
mkdir -p certs
pair-server -v -domain <chosen-domain>

TODO

  • add more tests
  • run tmux and host pair within a development docker container to restrict access

Directories

Path Synopsis
cmd
pkg
env

Jump to

Keyboard shortcuts

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