Skip to content

Commit

Permalink
Update README docs, add the rate limit section (#156)
Browse files Browse the repository at this point in the history
  • Loading branch information
mstmdev authored Apr 27, 2023
1 parent 90b0bf4 commit cb3c56f
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,16 @@ Web文件服务器默认使用HTTPS协议,使用`tls_cert_file`和`tls_key_fil
$ gofs -source=./source -dest=./dest -server -tls_cert_file=cert.pem -tls_key_file=key.pem -rand_user_count=3
```

### 速率限制

使用`max_tran_rate`命令行参数来限制服务器端和客户端的最大传输速率,这是一个期望值,而不是绝对值

例如,限制最大传输速率为1048576字节,即1MB

```bash
$ gofs -source=./source -dest=./dest -max_tran_rate=1048576
```

### 远程磁盘服务端

启动一个远程磁盘服务端作为一个远程文件数据源
Expand Down
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,17 @@ If you want to use the redis as the session store, here is an example for redis
$ gofs -source=./source -dest=./dest -server -tls_cert_file=cert.pem -tls_key_file=key.pem -rand_user_count=3
```

### Rate Limit

Use the `max_tran_rate` flag to limit the max transmission rate in the server and client sides,
and this is an expected value, not an absolute one.

For example, limit the max transmission rate to 1048576 bytes, means 1MB.

```bash
$ gofs -source=./source -dest=./dest -max_tran_rate=1048576
```

### Remote Disk Server

Start a remote disk server as a remote file source.
Expand Down

0 comments on commit cb3c56f

Please sign in to comment.