mirror of
https://github.com/zhaojh329/rttys.git
synced 2026-02-27 09:53:21 +08:00
Jianhui Zhao
85 lines
2.3 KiB
Markdown
85 lines
2.3 KiB
Markdown
# rttys([中文](/README_ZH.md))
|
|
|
|
[1]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=plastic
|
|
[2]: /LICENSE
|
|
[3]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=plastic
|
|
[4]: https://github.com/zhaojh329/rttys/pulls
|
|
[5]: https://img.shields.io/badge/Issues-welcome-brightgreen.svg?style=plastic
|
|
[6]: https://github.com/zhaojh329/rttys/issues/new
|
|
[7]: https://img.shields.io/badge/release-3.5.0-blue.svg?style=plastic
|
|
[8]: https://github.com/zhaojh329/rttys/releases
|
|
[9]: https://github.com/zhaojh329/rttys/workflows/build/badge.svg
|
|
|
|
[![license][1]][2]
|
|
[![PRs Welcome][3]][4]
|
|
[![Issue Welcome][5]][6]
|
|
[![Release Version][7]][8]
|
|
![Build Status][9]
|
|
|
|
This is the server program of [rtty](https://github.com/zhaojh329/rtty)
|
|
|
|
# Usage
|
|
## download the pre-built release binary from [Release](https://github.com/zhaojh329/rttys/releases) page according to your os and arch or compile it by yourself.
|
|
|
|
git clone https://github.com/zhaojh329/rttys
|
|
|
|
cd frontend
|
|
npm install
|
|
npm run build
|
|
cd ..
|
|
|
|
./build.sh linux amd64
|
|
|
|
## Authorization
|
|
### Token
|
|
Generate a token
|
|
|
|
$ rttys token
|
|
Please set a password:******
|
|
Your token is: 34762d07637276694b938d23f10d7164
|
|
|
|
Use token
|
|
|
|
$ rttys run -t 34762d07637276694b938d23f10d7164
|
|
|
|
### mTLS
|
|
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.
|
|
|
|
## 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 run -c /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](https://github.com/zhaojh329/rttys) better,
|
|
see the [CONTRIBUTING.md](https://github.com/zhaojh329/rttys/blob/master/CONTRIBUTING.md) file.
|