Skip to content

Commit e9bbe33

Browse files
author
mritd
committed
docs(readme): update readme
update readme Signed-off-by: mritd <[email protected]>
1 parent 29e4583 commit e9bbe33

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
> 一个使用 Go 编写的简单多服务器登录管理小工具.
44
5+
### 安装
6+
7+
可直接从 [release](https://github.com/mritd/mmh/releases) 页下载预编译的二进制文件,然后执行 `sudo mmh install` 即可;
8+
卸载直接执行 `sudo mmh uninstall`,卸载命令不会删除 `~/.mmh.yaml` 配置文件。
9+
510
### 基本命令
611

712
```sh
@@ -23,6 +28,7 @@ Available Commands:
2328
install Install mmh
2429
ls List ssh server
2530
uninstall Uninstall mmh
31+
version Print version
2632

2733
Flags:
2834
--config string config file (default is $HOME/.mmh.yaml)
@@ -63,13 +69,14 @@ tags:
6369

6470
![mmh](img/mmh.gif)
6571

66-
### 跳板登录
72+
### 无限跳板
6773

6874
在每个服务器配置中可以设置一个 `proxy` 字段,当登录带有 `proxy` 字段的服务器时,工具会首先链接代理节点进行跳转;
6975
这种能力方便于在使用跳板机的情况下无感的直连跳板机之后的主机;并且其支持无限的跳板登录,如 A、B、C 三台机器,
7076
如果 C 的 `proxy` 设置为 B,同时 B 的 `proxy` 设置为 A,那么实际在登录 C 时,工具实际连接顺序为: `local->A->B->C`
7177

72-
**不要去尝试循环登录,比如 `A->B->C->A` 这种配置,工具内部已经做了检测防止产生这种循环依赖的情况**
78+
**不要去尝试循环登录,比如 `A->B->C->A` 这种配置,工具内部已经做了检测防止产生这种 "真·无限跳板" 的情况,
79+
默认最大跳板机数量被限制为 5 台,可通过在配置文件根节点中增加 `maxProxy` 字段进行调整**
7380

7481
### 批量执行
7582

0 commit comments

Comments
 (0)