mirror of
https://github.com/zhaojh329/rttys.git
synced 2026-02-27 09:53:21 +08:00
a749bd3e8a
```
location /web/ {
proxy_set_header HttpProxyRedir http://$server_name;
proxy_pass http://127.0.0.1:5913;
}
```
Signed-off-by: Jianhui Zhao <zhaojh329@gmail.com>
188 lines
4.7 KiB
Markdown
188 lines
4.7 KiB
Markdown
# rttys
|
||
|
||
[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-4.2.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]
|
||
|
||
这是[rtty](https://github.com/zhaojh329/rtty)的服务器程序。
|
||
|
||
## 从源码构建
|
||
golang and node 20+ is required
|
||
|
||
cd ui
|
||
npm install
|
||
npm run build
|
||
cd ..
|
||
go build
|
||
|
||
## 认证(可选)
|
||
### Token
|
||
生成一个 token
|
||
|
||
$ rttys token
|
||
Please set a password:******
|
||
Your token is: 34762d07637276694b938d23f10d7164
|
||
|
||
使用 token
|
||
|
||
$ rttys -t 34762d07637276694b938d23f10d7164
|
||
|
||
### 使用自己的认证服务器
|
||
如果配置了设备认证 url, 设备连接时, rttys 会向此 url 发起认证请求, 认证服务器返回是否通过认证.
|
||
|
||
请求数据格式:
|
||
|
||
{"devid":"test", "token":"34762d07637276694b938d23f10d7164"}
|
||
|
||
认证服务器响应格式:
|
||
|
||
{"auth": true}
|
||
|
||
### SSL 双向认证(mTLS)
|
||
您可以在配置文件中指定设备 CA 存储(有效文件)或在 CLI 中指定设备 CA 存储(参数 ssl-cacert) 来启用 mTLS。
|
||
存储中没有有效 CA 的设备将在 TLS 握手中断开连接。
|
||
|
||
## 数据库准备
|
||
### Sqlite
|
||
sqlite://rttys.db
|
||
|
||
### MySql 或者 Mariadb
|
||
mysql://rttys:rttys@tcp(localhost)/rttys
|
||
|
||
在数据库实例上，以root用户身份登录到数据库控制台：
|
||
```
|
||
mysql -u root -p
|
||
```
|
||
|
||
创建将由 Rttys 使用的数据库用户，通过密码验证。本例使用 “rttys” 作为密码。请为您的实例使用安全密码。
|
||
```
|
||
CREATE USER 'rttys' IDENTIFIED BY 'rttys';
|
||
```
|
||
|
||
使用 UTF-8 字符集和排序规则创建数据库。确保使用 utf8mb4 字符集而不是 utf8，因为前者支持基本多语言平面
|
||
之外的所有 Unicode字符（包括emojis）。另外，根据您期望的内容选择排序规则。如有疑问，请使用 unicode_ci 或general_ci。
|
||
```
|
||
CREATE DATABASE rttys CHARACTER SET 'utf8mb4' COLLATE 'utf8mb4_unicode_ci';
|
||
```
|
||
将数据库上的所有权限授予上面创建的数据库用户。
|
||
```
|
||
GRANT ALL PRIVILEGES ON rttys.* TO 'rttys';
|
||
FLUSH PRIVILEGES;
|
||
```
|
||
|
||
退出数据库控制台。
|
||
|
||
## nginx 反向代理
|
||
|
||
```
|
||
# rttys.conf
|
||
|
||
addr-user: 127.0.0.1:5913
|
||
|
||
addr-http-proxy: 127.0.0.1:5914
|
||
http-proxy-redir-url: http://web.your-server.com
|
||
http-proxy-redir-domain: .your-server.com
|
||
```
|
||
|
||
```
|
||
# nginx.conf
|
||
|
||
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 / {
|
||
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;
|
||
}
|
||
}
|
||
```
|
||
|
||
在 rttys.conf 中的参数 http-proxy-redir-url 也可以通过在 nginx 中设置一个新
|
||
的 HTTP header HttpProxyRedir 来配置.
|
||
|
||
```
|
||
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://$server_name;
|
||
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;
|
||
}
|
||
}
|
||
```
|
||
|
||
## Docker
|
||
|
||
sudo docker run -it -p 5912:5912 -p 5913:5913 -p 5914:5914 zhaojh329/rttys:latest \
|
||
run --addr-http-proxy :5914
|
||
|
||
使用配置文件
|
||
|
||
sudo mkdir -p /opt/rttys
|
||
sudo 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.conf
|
||
|
||
## 贡献代码
|
||
如果你想帮助[rttys](https://github.com/zhaojh329/rttys)变得更好，请参考
|
||
[CONTRIBUTING_ZH.md](https://github.com/zhaojh329/rttys/blob/master/CONTRIBUTING_ZH.md)。
|