webtty

command module
v0.0.0-...-7e2360a Latest Latest
Warning

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

Go to latest
Published: Jan 30, 2024 License: MIT Imports: 22 Imported by: 0

README

WebTTY

WebTTY allows you to share a terminal session from your machine using WebRTC.

This is a fork of WebTTY that caters to my use case. Some choices I made:

  • Web-based frontends (to require zero setup on client machine)
  • WebRTC with no TURN server (for minimal latency)
  • Config file over CLI arguments (no good reason, only because it simplifies the code a little)

Status

This works pretty well (for me).

I mostly use this with emacs -nw. Sometimes emacs freezes. I don't know why or if it's related to this. It didn't freeze like that when I used gotty, so I assume it's related to this somehow.

Running

Create a config.toml that contains the following: (these contents can be found in config.toml.example).

oneWay = false
verbose = true
nonInteractive = true
stunServer = "stun:stun.l.google.com:19302"
cmd = "bash"
httpPort = 3247

Then run:

webtty config.toml

or with the flake output:

nix run github:sid-code/webtty -- config.toml

Then open up localhost:3247. Add a reverse proxy and TLS.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
pkg
sd
web-client module

Jump to

Keyboard shortcuts

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