Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
Signed-off-by: Jianhui Zhao <zhaojh329@gmail.com>
  • Loading branch information
zhaojh329 committed May 4, 2022
1 parent 226d891 commit a6b77fd
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ Use token
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.

# Database Preparation
## Database Preparation
## Sqlite
sqlite://rttys.db
s#qlite://rttys.db

## MySql or Mariadb
### MySql or Mariadb
mysql://rttys:rttys@tcp(localhost)/rttys

On database instance, login to database console as root:
Expand All @@ -64,6 +64,6 @@ FLUSH PRIVILEGES;

Quit from database console by exit.

# Contributing
## 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.
8 changes: 4 additions & 4 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@
您可以在配置文件中指定设备 CA 存储(有效文件)或在 CLI 中指定设备 CA 存储(参数 ssl-cacert) 来启用 mTLS。
存储中没有有效 CA 的设备将在 TLS 握手中断开连接。

# 数据库准备
## Sqlite
## 数据库准备
### Sqlite
sqlite://rttys.db

## MySql 或者 Mariadb
### MySql 或者 Mariadb
mysql://rttys:rttys@tcp(localhost)/rttys

在数据库实例上,以root用户身份登录到数据库控制台:
Expand All @@ -64,6 +64,6 @@ FLUSH PRIVILEGES;

退出数据库控制台。

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

0 comments on commit a6b77fd

Please sign in to comment.