mirror of https://github.com/elisescu/tty-server
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
48 lines
1.6 KiB
Groff
48 lines
1.6 KiB
Groff
.\" Text automatically generated by txt2man
|
|
.TH tty-server 1 "30 September 2020" "tty-server-0.0~git20200923.bae58e7" "Server side for tty-share"
|
|
.SH NAME
|
|
\fBtty-server \fP- Server side for tty-share
|
|
\fB
|
|
.SH SYNOPSIS
|
|
.nf
|
|
.fam C
|
|
\fBtty-server\fP [\fIoptions\fP]
|
|
|
|
.fam T
|
|
.fi
|
|
.fam T
|
|
.fi
|
|
.SH DESCRIPTION
|
|
\fBtty-server\fP is the server side for tty-share. It provides an instant pairing
|
|
solution, allowing you to share a terminal. tty-share is necessary to connect
|
|
to the \fBtty-server\fP, when the connection occurs a secret URL is generated,
|
|
through which the terminal can be viewed in the browser.
|
|
.SH OPTIONS
|
|
\fB-frontend_path\fP string
|
|
The path to the frontend resources.
|
|
By default, these resources are included in the server binary,
|
|
so you only need this path if you don't want to use the bundled ones.
|
|
.PP
|
|
\fB-sender_address\fP string
|
|
The bind address for the tty-share TLS connections.
|
|
tty-share tool will connect to this address. (default ":6543")
|
|
.PP
|
|
\fB-url\fP string
|
|
The public web URL the server will be accessible at.
|
|
This will be sent back to the tty-share tool to display it to the user. (default "http://localhost")
|
|
.PP
|
|
\fB-web_address\fP string
|
|
The bind address for the web interface.
|
|
This is the listening address for the web server that hosts the "browser terminal".
|
|
You might want to change this if you don't want to use the port 80, or only bind the localhost. (default ":80")
|
|
.SH AUTHOR
|
|
\fBtty-server\fP was written by Elis Popescu and is available at:
|
|
.PP
|
|
.nf
|
|
.fam C
|
|
https://github.com/elisescu/tty-server
|
|
|
|
.fam T
|
|
.fi
|
|
This manual page was written by Francisco Vilmar Cardoso Ruviaro for the Debian project (but may be used by others).
|