Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
islenbo authored Aug 22, 2019
1 parent cc31246 commit ba0be8a
Showing 1 changed file with 3 additions and 46 deletions.
49 changes: 3 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,62 +4,19 @@

![演示](https://raw.githubusercontent.com/islenbo/autossh/8456ea1e8cb82541018a4133227a257c70199e40/docs/images/ezgif-5-42b5117192fc.gif)

## Wiki
[Wiki](https://github.com/islenbo/autossh/wiki)

## 功能说明
- SSH 快速登录
- 支持 cp 命令文件/文件夹复制功能 `autossh cp source:/file target:/file`
- 支持自动更新检测功能 `autossh upgrade`
- 新增快捷登录功能 `autossh [序号/别名]`

## Wiki
[Wiki](https://github.com/islenbo/autossh/wiki)

## 安装
- Mac/Linux用户直接下载安装包,运行install脚本即可。
- Windows用户可手动编译,参考编译章节。

## config.json字段说明
```yaml
show_detail: bool <是否显示服务器详情(用户、IP)>
options:
ServerAliveInterval: int <是否定时发送心跳包,与SSH ServerAliveInterval属性用法相同>
servers:
- name: string <显示名称>
ip: string <服务器IP>
port: int <端口>
user: string <用户名>
password: string <密码>
method: string <鉴权方式,password-密码 key-密钥>
key: string <私钥路径>
options:
ServerAliveInterval: int <与根节点ServerAliveInterval用法相同,该值会覆盖根节点的值>
alias: string <别名>
log:
enable: bool <是否启用日志>
filename: string <日志路径, 如 /tmp/%n-%u-%dt.log 支持变量请参考下方《日志变量》章节>
mode: string <遇到同名日志的处理模式,cover-覆盖 append-追加,默认为cover>
groups:
- group_name: string <组名>
prefix: string <组前缀>
servers: array <服务器列表,配置与servers相同,配置说明略>
collapse: bool <是否折叠>
proxy:
type: string <代理方式,目前仅支持SOCKS5>
server: string <代理服务器地址>
port: int <端口号>
user: string <用户,若无留空>
password: string <密码,若无留空>
```
## 日志变量
变量 | 说明 | 示例
--- | --- | ---
%g | 组名(group_name) | MyGroup1
%n | 显示名称(name) | vagrant
%u | 用户名(user) | root
%a | 别名(alias) | vagrant
%dt | 日期时间 | 20190821223010
%d | 日期 | 20190821
## 注意
v0.X版本配置文件无法与v1.X版本兼容,请勿使用!

Expand Down

0 comments on commit ba0be8a

Please sign in to comment.