unflypig / rttys

Access your device's terminal from anywhere via the web.

rttys(中文)

This is the server program of rtty

Usage

download the pre-built release binary from Release page according to your os and arch or compile it by yourself.

go get -u github.com/zhaojh329/rttys

Command Line Parameters

./rttys -h
Usage of rttys:
  -addr-dev string
        address to listen device (default ":5912")
  -addr-user string
        address to listen user (default ":5913")
  -conf string
        config file to load (default "./rttys.conf")
  -gen-token
        generate token
  -http-password string
        password for http auth
  -http-username string
        username for http auth
  -log string
        log file path (default "/var/log/rttys.log")
  -ssl-cert string
        certFile Path
  -ssl-key string
        keyFile Path
  -token string
        token to use
  -white-list string
        white list(device IDs separated by spaces or *)

Authorization

./rttys -gen-token
Please set a password:******
Your token is: 34762d07637276694b938d23f10d7164

./rttys -token 34762d07637276694b938d23f10d7164

Running as a Linux service

Move the rttys binary into /usr/local/bin/

sudo mv rttys /usr/local/bin/

Copy the config file to /etc/rttys/

sudo mkdir /etc/rttys
sudo cp rttys.conf /etc/rttys/

Create a systemd unit file: /etc/systemd/system/rttys.service

[Unit]
Description=rttys
After=network.target

[Service]
ExecStart=/usr/local/bin/rttys -conf /etc/rttys/rttys.conf
TimeoutStopSec=5s

[Install]
WantedBy=multi-user.target

To start the service for the first time, do the usual systemctl dance:

sudo systemctl daemon-reload
sudo systemctl enable rttys
sudo systemctl start rttys

You can stop the service with:

sudo systemctl stop rttys

Contributing

If you would like to help making rttys better, see the CONTRIBUTING.md file.