You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 46e93f6
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: readme.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,29 +1,29 @@
1
-

1
+

2
2
3
-
# WebRTTY
3
+
# WebTTY
4
4
5
-
WebRTTY allows you to share a terminal session from your machine using WebRTC. You can pair with a friend without setting up a proxy server, debug servers behind NATs, and more. WebRTTY also works in-browser. You can connect to a WebRTTY session from this static page: https://maxmcd.github.io/webrtty/
5
+
WebTTY allows you to share a terminal session from your machine using WebRTC. You can pair with a friend without setting up a proxy server, debug servers behind NATs, and more. WebTTY also works in-browser. You can connect to a WebTTY session from this static page: https://maxmcd.github.io/webtty/
6
6
7
7
### Status
8
8
9
9
There are a handful of bugs to fix, but everything works pretty well at the moment. Please open an issue if you find a bug.
10
10
11
11
### Installation
12
12
```bash
13
-
go get -u github.com/maxmcd/webrtty
13
+
go get -u github.com/maxmcd/webtty
14
14
```
15
-
WebRTTY uses the wonderful [pions/webrtc](https://github.com/pions/webrtc) for WebRTC communication. It currently requires OpenSSL to build. More here: https://github.com/pions/webrtc#install
15
+
WebTTY uses the wonderful [pions/webrtc](https://github.com/pions/webrtc) for WebRTC communication. It currently requires OpenSSL to build. More here: https://github.com/pions/webrtc#install
16
16
17
17
### Running
18
18
19
19
```shell
20
-
>webrtty -h
21
-
Usage of webrtty:
20
+
>webtty -h
21
+
Usage of webtty:
22
22
-cmd
23
23
The command to run. Default is "bash -l"
24
24
Because this flag consumes the remainder of the command line,
25
25
all other args (if present) must appear before this flag.
26
-
eg: webrtty -o -v -ni -cmd docker run -it --rm alpine:latest sh
26
+
eg: webtty -o -v -ni -cmd docker run -it --rm alpine:latest sh
By default WebRTTY forces the size of the client terminal. This means the host size can frequently render incorrectly. One way you can fix this is by using tmux:
56
+
By default WebTTY forces the size of the client terminal. This means the host size can frequently render incorrectly. One way you can fix this is by using tmux:
57
57
58
58
```bash
59
59
tmux new-session -s shared
60
60
# in another terminal
61
-
webrtty -ni -cmd tmux attach-session -t shared
61
+
webtty -ni -cmd tmux attach-session -t shared
62
62
```
63
63
Tmux will now resize the session to the smallest terminal viewport.
64
64
65
65
### One-way Connections
66
66
67
-
One-way connections can be enabled with the `-o` flag. A typical webrtc connection requires an SDP exchange between both parties. By default, WebRTTY will create an SDP offer and wait for you to enter the SDP answer. With the `-o` flag the initial offer is sent along with a public url that the receiver is expected to post their response to. This uses my service [10kb.site](https://www.10kb.site). The host then polls the url continually until it gets an answer.
67
+
One-way connections can be enabled with the `-o` flag. A typical webrtc connection requires an SDP exchange between both parties. By default, WebTTY will create an SDP offer and wait for you to enter the SDP answer. With the `-o` flag the initial offer is sent along with a public url that the receiver is expected to post their response to. This uses my service [10kb.site](https://www.10kb.site). The host then polls the url continually until it gets an answer.
68
68
69
-
I think this somewhat violates the spirit of this tool because it relies on a third party service. However, one-way connections allow you to do very cool things. Eg: I can have a build server output a WebRTTY connection string on error and allow anyone to attach to the session.
69
+
I think this somewhat violates the spirit of this tool because it relies on a third party service. However, one-way connections allow you to do very cool things. Eg: I can have a build server output a WebTTY connection string on error and allow anyone to attach to the session.
70
70
71
71
SDP descriptions are encrypted when uploaded and encryption keys are shared with the connection data to decrypt. So presumably the service being compromised is not problematic.
0 commit comments