- Notifications
You must be signed in to change notification settings - Fork205
Access your device's terminal from anywhere via the web.
License
zhaojh329/rttys
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
rttys(中文)
This is the server program ofrtty
golang and node 20+ is required
cd uinpm installnpm run buildcd ..go buildGenerate a token
$ rttys tokenPlease set a password:******Your token is: 34762d07637276694b938d23f10d7164Use token
$ rttys run -t 34762d07637276694b938d23f10d7164If the device authentication URL is configured, when the device connecting,rttys will initiate an authentication request to this URL, and the authenticationserver will return whether the authentication has been passed.
Request data format:
{"devid":"test", "token":"34762d07637276694b938d23f10d7164"}Authentication Server Response Format:
{"auth": true}You can enable mTLS by specifying device CA storage (valid file) in config file or from CLI (variable ssl-cacert).Device(s) without valid CA in storage will be disconnected in TLS handshake.
s#qlite://rttys.db
mysql://rttys:rttys@tcp(localhost)/rttys
On database instance, login to database console as root:
mysql -u root -pCreate database user which will be used by Rttys, authenticated by password. This example uses 'rttys' as password. Please use a secure password for your instance.
CREATE USER 'rttys' IDENTIFIED BY 'rttys';Create database with UTF-8 charset and collation. Make sure to use utf8mb4 charset instead of utf8 as the former supports all Unicode characters (including emojis) beyond Basic Multilingual Plane. Also, collation chosen depending on your expected content. When in doubt, use either unicode_ci or general_ci.
CREATE DATABASE rttys CHARACTER SET 'utf8mb4' COLLATE 'utf8mb4_unicode_ci';Grant all privileges on the database to database user created above.
GRANT ALL PRIVILEGES ON rttys.* TO 'rttys';FLUSH PRIVILEGES;Quit from database console by exit.
# rttys.confaddr-user: 127.0.0.1:5913addr-http-proxy: 127.0.0.1:5914http-proxy-redir-url: http://web.your-server.comhttp-proxy-redir-domain: .your-server.com# nginx.confserver { listen 80; server_name rtty.your-server.com; location /connect/ { proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "Upgrade"; proxy_pass http://127.0.0.1:5913; } location / { proxy_pass http://127.0.0.1:5913; }}server { listen 80; server_name web.your-server.com; location / { proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "Upgrade"; proxy_pass http://127.0.0.1:5914; }}The parameter 'http-proxy-redir-url' and 'http-proxy-redir-domain' in rttys.conf can also be configuredby setting new HTTP headers in nginx.
server { listen 80; server_name rtty.your-server.com; location /connect/ { proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "Upgrade"; proxy_pass http://127.0.0.1:5913; } location /web/ { proxy_set_header HttpProxyRedir http://web.your-server.com; proxy_set_header HttpProxyRedirDomain .your-server.com proxy_pass http://127.0.0.1:5913; } location / { proxy_pass http://127.0.0.1:5913; }}server { listen 80; server_name web.your-server.com; location / { proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "Upgrade"; proxy_pass http://127.0.0.1:5914; }}sudo docker run -it -p 5912:5912 -p 5913:5913 -p 5914:5914 zhaojh329/rttys:latest \ run --addr-http-proxy :5914sudo mkdir -p /opt/rttyssudo sh -c 'echo "addr-http-proxy: :5914" > /opt/rttys/rttys.conf'sudo docker run -it -p 5912:5912 -p 5913:5913 -p 5914:5914 -v /opt/rttys:/etc/rttys \ zhaojh329/rttys:latest run -conf /etc/rttys/rttys.confIf you would like to help makingrttys better,see theCONTRIBUTING.md file.
About
Access your device's terminal from anywhere via the web.