Skip to content

Commit 8745f95

Browse files
appleboyappleboy
committed
docs: restructure and clarify parameter documentation across all readmes
- Restructure input parameter documentation by splitting into distinct sections: Connection Settings, SSH Command Settings, and Proxy Settings for better clarity - Move parameters related to command execution out of proxy section and into the new SSH Command Settings section - Add/clarify descriptions for individual sections and parameters in all three language readmes - Update and correct parameter ordering, grouping, and formatting for consistency across all documentation - Add missing SSH Command Settings parameters and improve readability of parameter tables Signed-off-by: appleboy <appleboy.tw@gmail.com>
1 parent 8f3cc07 commit 8745f95

File tree

3 files changed

+186
-111
lines changed

3 files changed

+186
-111
lines changed

‎README.md‎

Lines changed: 62 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ English | [繁體中文](./README.zh-tw.md) | [简体中文](./README.zh-cn.md)
88
- [Table of Contents](#table-of-contents)
99
- [📖 Introduction](#-introduction)
1010
- [🧩 Core Concepts \& Input Parameters](#-core-concepts--input-parameters)
11+
- [🔌 Connection Settings](#-connection-settings)
12+
- [🛠️ SSH Command Settings](#️-ssh-command-settings)
13+
- [🌐 Proxy Settings](#-proxy-settings)
1114
- [⚡ Quick Start](#-quick-start)
1215
- [🔑 SSH Key Setup \& OpenSSH Compatibility](#-ssh-key-setup--openssh-compatibility)
1316
- [Setting Up SSH Keys](#setting-up-ssh-keys)
@@ -52,43 +55,65 @@ This action provides flexible SSH command execution with a rich set of configura
5255

5356
For full details, see [action.yml](./action.yml).
5457

55-
| Parameter | Description | Default |
56-
| ------------------------- | --------------------------------------------------------------------------------- | ------- |
57-
| host | SSH host address | |
58-
| port | SSH port number | 22 |
59-
| passphrase | Passphrase for the SSH private key | |
60-
| username | SSH username | |
61-
| password | SSH password | |
62-
| protocol | SSH protocol version (`tcp`, `tcp4`, `tcp6`) | tcp |
63-
| sync | Run synchronously if multiple hosts are specified | false |
64-
| use_insecure_cipher | Allow additional (less secure) ciphers | false |
65-
| cipher | Allowed cipher algorithms. Uses sensible defaults if unspecified | |
66-
| timeout | Timeout for SSH connection to host | 30s |
67-
| command_timeout | Timeout for SSH command execution | 10m |
68-
| key | Content of SSH private key (e.g., raw content of `~/.ssh/id_rsa`) | |
69-
| key_path | Path to SSH private key | |
70-
| fingerprint | SHA256 fingerprint of the host public key | |
71-
| proxy_host | SSH proxy host | |
72-
| proxy_port | SSH proxy port | 22 |
73-
| proxy_protocol | SSH proxy protocol version (`tcp`, `tcp4`, `tcp6`) | tcp |
74-
| proxy_username | SSH proxy username | |
75-
| proxy_password | SSH proxy password | |
76-
| proxy_passphrase | SSH proxy key passphrase | |
77-
| proxy_timeout | Timeout for SSH connection to proxy host | 30s |
78-
| proxy_key | Content of SSH proxy private key | |
79-
| proxy_key_path | Path to SSH proxy private key | |
80-
| proxy_fingerprint | SHA256 fingerprint of the proxy host public key | |
81-
| proxy_cipher | Allowed cipher algorithms for the proxy | |
82-
| proxy_use_insecure_cipher | Allow additional (less secure) ciphers for the proxy | false |
83-
| script | Commands to execute remotely | |
84-
| script_path | Path to a file containing commands to execute | |
85-
| envs | Environment variables to pass to the shell script | |
86-
| envs_format | Flexible configuration for environment variable transfer | |
87-
| debug | Enable debug mode | false |
88-
| allenvs | Pass all environment variables with `GITHUB_` and `INPUT_` prefixes to the script | false |
89-
| request_pty | Request a pseudo-terminal from the server | false |
90-
| curl_insecure | Allow curl to connect to SSL sites without certificates | false |
91-
| version | drone-ssh binary version. If not specified, the latest version will be used. | |
58+
### 🔌 Connection Settings
59+
60+
These parameters control how the action connects to your remote host.
61+
62+
| Parameter | Description | Default |
63+
| ------------------- | ----------------------------------------------------------------- | ------- |
64+
| host | SSH host address | |
65+
| port | SSH port number | 22 |
66+
| username | SSH username | |
67+
| password | SSH password | |
68+
| protocol | SSH protocol version (`tcp`, `tcp4`, `tcp6`) | tcp |
69+
| sync | Run synchronously if multiple hosts are specified | false |
70+
| timeout | Timeout for SSH connection to host | 30s |
71+
| key | Content of SSH private key (e.g., raw content of `~/.ssh/id_rsa`) | |
72+
| key_path | Path to SSH private key | |
73+
| passphrase | Passphrase for the SSH private key | |
74+
| fingerprint | SHA256 fingerprint of the host public key | |
75+
| use_insecure_cipher | Allow additional (less secure) ciphers | false |
76+
| cipher | Allowed cipher algorithms. Uses sensible defaults if unspecified | |
77+
78+
---
79+
80+
### 🛠️ SSH Command Settings
81+
82+
These parameters control the commands executed on the remote host and related behaviors.
83+
84+
| Parameter | Description | Default |
85+
| --------------- | --------------------------------------------------------------------------------- | ------- |
86+
| script | Commands to execute remotely | |
87+
| script_path | Path to a file containing commands to execute | |
88+
| envs | Environment variables to pass to the shell script | |
89+
| envs_format | Flexible configuration for environment variable transfer | |
90+
| allenvs | Pass all environment variables with `GITHUB_` and `INPUT_` prefixes to the script | false |
91+
| command_timeout | Timeout for SSH command execution | 10m |
92+
| debug | Enable debug mode | false |
93+
| request_pty | Request a pseudo-terminal from the server | false |
94+
| curl_insecure | Allow curl to connect to SSL sites without certificates | false |
95+
| version | drone-ssh binary version. If not specified, the latest version will be used. | |
96+
97+
---
98+
99+
### 🌐 Proxy Settings
100+
101+
These parameters control the use of a proxy (jump host) for connecting to your target host.
102+
103+
| Parameter | Description | Default |
104+
| ------------------------- | ----------------------------------------------- | ------- |
105+
| proxy_host | SSH proxy host | |
106+
| proxy_port | SSH proxy port | 22 |
107+
| proxy_username | SSH proxy username | |
108+
| proxy_password | SSH proxy password | |
109+
| proxy_passphrase | SSH proxy key passphrase | |
110+
| proxy_protocol | SSH proxy protocol version | tcp |
111+
| proxy_timeout | Timeout for SSH connection to proxy host | 30s |
112+
| proxy_key | Content of SSH proxy private key | |
113+
| proxy_key_path | Path to SSH proxy private key | |
114+
| proxy_fingerprint | SHA256 fingerprint of the proxy host public key | |
115+
| proxy_cipher | Allowed cipher algorithms for the proxy | |
116+
| proxy_use_insecure_cipher | Allow insecure ciphers for the proxy | false |
92117

93118
> **Note:** To mimic the removed `script_stop` option, add `set -e` at the top of your shell script.
94119

‎README.zh-cn.md‎

Lines changed: 62 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
- [目录](#目录)
99
- [📖 简介](#-简介)
1010
- [🧩 核心概念与输入参数](#-核心概念与输入参数)
11+
- [🔌 连接设置](#-连接设置)
12+
- [🛠️ 指令设置](#️-指令设置)
13+
- [🌐 代理设置](#-代理设置)
1114
- [⚡ 快速开始](#-快速开始)
1215
- [🔑 SSH 密钥配置与 OpenSSH 兼容性](#-ssh-密钥配置与-openssh-兼容性)
1316
- [配置 SSH 密钥](#配置-ssh-密钥)
@@ -52,43 +55,65 @@
5255

5356
详细参数请参阅 [action.yml](./action.yml)。
5457

55-
| 参数 | 描述 | 默认值 |
56-
| ------------------------- | ----------------------------------------------------- | ------ |
57-
| host | SSH 主机地址 | |
58-
| port | SSH 端口号 | 22 |
59-
| passphrase | SSH 私钥密码短语 | |
60-
| username | SSH 用户名 | |
61-
| password | SSH 密码 | |
62-
| protocol | SSH 协议版本（`tcp`、`tcp4`、`tcp6`） | tcp |
63-
| sync | 指定多个主机时同步执行 | false |
64-
| use_insecure_cipher | 允许额外（不安全）的加密算法 | false |
65-
| cipher | 允许的加密算法，未指定时使用默认值 | |
66-
| timeout | SSH 连接主机的超时时间 | 30s |
67-
| command_timeout | SSH 命令执行超时时间 | 10m |
68-
| key | SSH 私钥内容（如 `~/.ssh/id_rsa` 的原始内容） | |
69-
| key_path | SSH 私钥路径 | |
70-
| fingerprint | 主机公钥的 SHA256 指纹 | |
71-
| proxy_host | SSH 代理主机 | |
72-
| proxy_port | SSH 代理端口 | 22 |
73-
| proxy_protocol | SSH 代理协议版本（`tcp`、`tcp4`、`tcp6`） | tcp |
74-
| proxy_username | SSH 代理用户名 | |
75-
| proxy_password | SSH 代理密码 | |
76-
| proxy_passphrase | SSH 代理私钥密码短语 | |
77-
| proxy_timeout | SSH 连接代理主机的超时时间 | 30s |
78-
| proxy_key | SSH 代理私钥内容 | |
79-
| proxy_key_path | SSH 代理私钥路径 | |
80-
| proxy_fingerprint | 代理主机公钥的 SHA256 指纹 | |
81-
| proxy_cipher | 代理允许的加密算法 | |
82-
| proxy_use_insecure_cipher | 代理允许额外（不安全）的加密算法 | false |
83-
| script | 远程执行的命令 | |
84-
| script_path | 包含要执行命令的文件路径 | |
85-
| envs | 传递给 shell 脚本的环境变量 | |
86-
| envs_format | 环境变量传递的灵活配置 | |
87-
| debug | 启用调试模式 | false |
88-
| allenvs | 传递所有带 `GITHUB_` 和 `INPUT_` 前缀的环境变量到脚本 | false |
89-
| request_pty | 向服务器请求伪终端 | false |
90-
| curl_insecure | 允许 curl 连接无证书的 SSL 站点 | false |
91-
| version | drone-ssh 二进制版本，未指定时使用最新版本 | |
58+
### 🔌 连接设置
59+
60+
这些参数用于控制如何连接到远程主机。
61+
62+
| 参数 | 描述 | 默认值 |
63+
| ------------------- | --------------------------------------------- | ------ |
64+
| host | SSH 主机地址 | |
65+
| port | SSH 端口号 | 22 |
66+
| username | SSH 用户名 | |
67+
| password | SSH 密码 | |
68+
| protocol | SSH 协议版本（`tcp`、`tcp4`、`tcp6`） | tcp |
69+
| sync | 指定多个主机时同步执行 | false |
70+
| timeout | SSH 连接主机的超时时间 | 30s |
71+
| key | SSH 私钥内容（如 `~/.ssh/id_rsa` 的原始内容） | |
72+
| key_path | SSH 私钥路径 | |
73+
| passphrase | SSH 私钥密码短语 | |
74+
| fingerprint | 主机公钥的 SHA256 指纹 | |
75+
| use_insecure_cipher | 允许额外（不安全）的加密算法 | false |
76+
| cipher | 允许的加密算法，未指定时使用默认值 | |
77+
78+
---
79+
80+
### 🛠️ 指令设置
81+
82+
这些参数用于控制在远程主机上执行的命令及相关行为。
83+
84+
| 参数 | 描述 | 默认值 |
85+
| --------------- | ----------------------------------------------------- | ------ |
86+
| script | 远程执行的命令 | |
87+
| script_path | 包含要执行命令的文件路径 | |
88+
| envs | 传递给 shell 脚本的环境变量 | |
89+
| envs_format | 环境变量传递的灵活配置 | |
90+
| allenvs | 传递所有带 `GITHUB_` 和 `INPUT_` 前缀的环境变量到脚本 | false |
91+
| command_timeout | SSH 命令执行超时时间 | 10m |
92+
| debug | 启用调试模式 | false |
93+
| request_pty | 向服务器请求伪终端 | false |
94+
| curl_insecure | 允许 curl 连接无证书的 SSL 站点 | false |
95+
| version | drone-ssh 二进制版本，未指定时使用最新版本 | |
96+
97+
---
98+
99+
### 🌐 代理设置
100+
101+
这些参数用于通过代理（跳板机）连接到目标主机。
102+
103+
| 参数 | 描述 | 默认值 |
104+
| ------------------------- | ----------------------------------------- | ------ |
105+
| proxy_host | SSH 代理主机 | |
106+
| proxy_port | SSH 代理端口 | 22 |
107+
| proxy_username | SSH 代理用户名 | |
108+
| proxy_password | SSH 代理密码 | |
109+
| proxy_passphrase | SSH 代理私钥密码短语 | |
110+
| proxy_protocol | SSH 代理协议版本（`tcp`、`tcp4`、`tcp6`） | tcp |
111+
| proxy_timeout | SSH 连接代理主机的超时时间 | 30s |
112+
| proxy_key | SSH 代理私钥内容 | |
113+
| proxy_key_path | SSH 代理私钥路径 | |
114+
| proxy_fingerprint | 代理主机公钥的 SHA256 指纹 | |
115+
| proxy_cipher | 代理允许的加密算法 | |
116+
| proxy_use_insecure_cipher | 代理允许额外（不安全）的加密算法 | false |
92117

93118
> **注意：** 如需实现已移除的 `script_stop` 功能，请在 shell 脚本顶部添加 `set -e`。
94119

0 commit comments

Comments
 (0)