Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Signed-off-by: Jianhui Zhao <[email protected]>
  • Loading branch information
Jianhui Zhao committed Apr 25, 2019
1 parent ee2fd7e commit 9a35257
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 5 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,14 @@ The server side of [rtty](https://github.com/zhaojh329/rtty)
address to listen (default ":5912")
-conf string
config file to load (default "./rttys.conf")
-gen-token
generate token
-ssl-cert string
certFile Path
certFile Path (default "./rttys.crt")
-ssl-key string
keyFile Path
keyFile Path (default "./rttys.key")
-token string
token to use

## run as root (use system credentials)

Expand All @@ -47,6 +51,13 @@ The server side of [rtty](https://github.com/zhaojh329/rtty)

cat /var/log/rttys.log

## Authorization

./rttys -gen-token
34762d07637276694b938d23f10d7164

./rttys -token 34762d07637276694b938d23f10d7164

# 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.
17 changes: 14 additions & 3 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,14 @@
address to listen (default ":5912")
-conf string
config file to load (default "./rttys.conf")
-gen-token
generate token
-ssl-cert string
certFile Path
certFile Path (default "./rttys.crt")
-ssl-key string
keyFile Path
keyFile Path (default "./rttys.key")
-token string
token to use

## 以root用户运行(使用系统用户名和密码)

Expand All @@ -43,10 +47,17 @@

./rttys

# 如何在后台运行模式下查看日志
## 如何在后台运行模式下查看日志

cat /var/log/rttys.log

## 认证

./rttys -gen-token
34762d07637276694b938d23f10d7164

./rttys -token 34762d07637276694b938d23f10d7164

# 贡献代码
如果你想帮助[rttys](https://github.com/zhaojh329/rttys)变得更好,请参考
[CONTRIBUTING_ZH.md](https://github.com/zhaojh329/rttys/blob/master/CONTRIBUTING_ZH.md)

0 comments on commit 9a35257

Please sign in to comment.