Actions/ssh-action
1
Fork 0
mirror of https://github.com/appleboy/ssh-action.git synced 2025-10-31 16:23:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve project documentation and organization

Browse Source 
- Add a project description mentioning the use of Golang and drone-ssh
- Replace the list of input variables with a table format for better readability and organization

Signed-off-by: appleboy <appleboy.tw@gmail.com>
This commit is contained in:
appleboy 2024-11-23 23:30:53 +08:00
parent 43d4ebbb72
commit 6137f733fb
No known key found for this signature in database
1 changed files with 38 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
README.zh-cn.md
View File

@ -6,42 +6,48 @@
[![testing main branch](https://github.com/appleboy/ssh-action/actions/workflows/main.yml/badge.svg)](https://github.com/appleboy/ssh-action/actions/workflows/main.yml) [![testing main branch](https://github.com/appleboy/ssh-action/actions/workflows/main.yml/badge.svg)](https://github.com/appleboy/ssh-action/actions/workflows/main.yml)
该项目使用 [Golang](https://go.dev) 和 [drone-ssh](https://github.com/appleboy/drone-ssh) 构建。🚀
## 输入变量 ## 输入变量
更详细的信息，请参考 [action.yml](./action.yml)。 更详细的信息，请参考 [action.yml](./action.yml)。
* `host` - SSH 主机 | 输入参数 | 描述 | 默认值 |
* `port` - SSH 连接端口，默认为 `22` | ------------------------- | ----------------------------------------------------- | ------ |
* `username` - SSH 用户名称 | host | SSH 主机地址 | |
* `password` - SSH 密码 | port | SSH 端口号 | 22 |
* `passphrase` - 通常用于加密私钥的 passphrase | passphrase | SSH 密钥密码短语 | |
* `sync` - 同步执行多个主机上的命令，默认为 false | username | SSH 用户名 | |
* `timeout` - SSH 连接到远程主机的超时时间，默认为 `30s` | password | SSH 密码 | |
* `command_timeout` - SSH 命令超时时间，默认为 10m | protocol | SSH 协议版本（tcp, tcp4, tcp6） | tcp |
* `key` - SSH 私钥的内容，例如 ~/.ssh/id_rsa 的原始内容，请记得包含 BEGIN 和 END 行 | sync | 如果有多个主机，启用同步执行 | false |
* `key_path` - SSH 私钥的路径 | use_insecure_cipher | 使用不安全的密码算法 | false |
* `fingerprint` - 主机公钥的 SHA256 指纹，默认为跳过验证 | cipher | 允许的密码算法。如果未指定，则使用适当的算法 | |
* `script` - 执行命令 | timeout | SSH 连接到主机的超时时间 | 30s |
* `script_file` - 執行命令的文件 | command_timeout | SSH 命令的超时时间 | 10m |
* `script_stop` - 当出现第一个错误时停止执行命令 | key | SSH 私钥的内容，例如 ~/.ssh/id_rsa 的原始内容 | |
* `envs` - 传递环境变量到 shell script | key_path | SSH 私钥的路径 | |
* `debug` - 启用调试模式 | fingerprint | 主机公钥的 SHA256 指纹 | |
* `use_insecure_cipher` - 使用不安全的密码（ciphers）进行加密，详见 [#56](https://github.com/appleboy/ssh-action/issues/56) | proxy_host | SSH 代理主机 | |
* `cipher` - 允许使用的密码（ciphers）算法。如果未指定，则使用适当的算法 | proxy_port | SSH 代理端口 | 22 |
| proxy_protocol | SSH 代理协议版本（tcp, tcp4, tcp6） | tcp |
SSH 代理设置： | proxy_username | SSH 代理用户名 | |
| proxy_password | SSH 代理密码 | |
* `proxy_host` - 代理主机 | proxy_passphrase | SSH 代理密钥密码短语 | |
* `proxy_port` - 代理端口，默认为 `22` | proxy_timeout | SSH 连接到代理主机的超时时间 | 30s |
* `proxy_username` - 代理用户名 | proxy_key | SSH 代理私钥的内容 | |
* `proxy_password` - 代理密码 | proxy_key_path | SSH 代理私钥的路径 | |
* `proxy_passphrase` - 密码通常用于加密私有密钥 | proxy_fingerprint | 代理主机公钥的 SHA256 指纹 | |
* `proxy_timeout` - SSH 连接至代理主机的超时时间，默认为 `30s` | proxy_cipher | 代理允许的密码算法 | |
* `proxy_key` - SSH 代理私有密钥内容 | proxy_use_insecure_cipher | 使用不安全的密码算法 | false |
* `proxy_key_path` - SSH 代理私有密钥路径 | script | 执行命令 | |
* `proxy_fingerprint` - 代理主机公钥的 SHA256 指纹，默认为跳过验证 | script_file | 从文件执行命令 | |
* `proxy_use_insecure_cipher` - 使用不安全的加密方式，详见 [#56](https://github.com/appleboy/ssh-action/issues/56) | script_stop | 在第一次失败后停止脚本 | false |
* `proxy_cipher` - 允许的加密算法。如果未指定，则使用合理的算法 | envs | 传递环境变量到 shell 脚本 | |
| envs_format | 环境变量传递的灵活配置 | |
| debug | 启用调试模式 | false |
| allenvs | 将带有 `GITHUB_` 和 `INPUT_` 前缀的环境变量传递给脚本 | false |
| request_pty | 请求伪终端 | false |
## 使用方法 ## 使用方法