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
Copy file name to clipboardExpand all lines: README.md
+9-4Lines changed: 9 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,9 @@ TermPair lets developers securely share and control terminals in real time.
27
27
28
28
## Usage
29
29
30
-
Start the TermPair server with `termpair serve`, or use the one already running at [https://chadsmith.dev/termpair](https://chadsmith.dev/termpair).
30
+
First start the TermPair server with `termpair serve`, or use the one already running at [https://chadsmith.dev/termpair](https://chadsmith.dev/termpair).
31
+
32
+
The server is used to route encrypted data between terminals and connected browsers.
31
33
32
34
```
33
35
> termpair serve --port 8000
@@ -38,7 +40,9 @@ INFO: Uvicorn running on http://localhost:8000 (Press CTRL+C to quit)
You can share that URL with whoever you want. Note that anyone that has it can view and possibly control your terminal.
59
+
The URL printed contains a unique terminal ID and an encryption key. You can share that URL with whoever you want. Anyone who has it can access your terminal while the `termpair share` process is running.
56
60
57
61
The server multicasts terminal output to all browsers that connect to the session.
58
62
@@ -117,10 +121,11 @@ or install with [pip](https://pip.pypa.io/en/stable/)
117
121
## Serving with NGINX
118
122
Running behind an nginx proxy can be done with the following configuration.
119
123
120
-
TermPair must be started with `termpair serve`, and the port being run on must be specified in the `upstream` configuration.
124
+
The TermPair server must be started with `termpair serve`, and the port being run on must be specified in the `upstream` configuration.
121
125
122
126
```nginx
123
127
upstream termpair_app {
128
+
# Make sure the port matches the port you are running on
0 commit comments