|
1 |
| -# 🚀 用於 GitHub Actions 的 SSH |
| 1 | +# 🚀 GitHub Actions 的 SSH |
2 | 2 |
|
3 |
| -[GitHub Action](https://github.com/features/actions) for executing remote ssh commands. |
| 3 | +[English](./README.md) |
| 4 | +[简体中文](./README.zh-cn.md) |
| 5 | + |
| 6 | +[GitHub Action](https://github.com/features/actions) 用於執行遠端 SSH 命令。 |
4 | 7 |
|
5 | 8 | 
|
6 | 9 |
|
7 | 10 | [](https://github.com/appleboy/ssh-action/actions/workflows/main.yml)
|
8 | 11 |
|
| 12 | +此專案使用 [Golang](https://go.dev) 和 [drone-ssh](https://github.com/appleboy/drone-ssh) 建立。🚀 |
| 13 | + |
9 | 14 | ## 輸入變數
|
10 | 15 |
|
11 |
| -更詳細的資訊,請參閱 [action.yml](./action.yml)。 |
12 |
| - |
13 |
| -* `host` - SSH 主機 |
14 |
| -* `port` - SSH 連接埠,預設為 `22` |
15 |
| -* `username` - SSH 使用者名稱 |
16 |
| -* `password` - SSH 密碼 |
17 |
| -* `passphrase` - 通常用於加密私鑰的 passphrase |
18 |
| -* `sync` - 同步執行多個主機上的命令,預設為 false |
19 |
| -* `timeout` - SSH 連接到遠端主機的超時時間,預設為 `30s` |
20 |
| -* `command_timeout` - SSH 命令超時時間,預設為 10m |
21 |
| -* `key` - SSH 私鑰的內容,例如 ~/.ssh/id_rsa 的原始內容,請記得包含 BEGIN 和 END 行 |
22 |
| -* `key_path` - SSH 私鑰的路徑 |
23 |
| -* `fingerprint` - 主機公鑰的 SHA256 指紋,預設為略過驗證 |
24 |
| -* `script` - 執行命令 |
25 |
| -* `script_file` - 執行命令的文件 |
26 |
| -* `script_stop` - 當出現第一個錯誤時停止執行命令 |
27 |
| -* `envs` - 傳遞環境變數到 shell script |
28 |
| -* `debug` - 啟用偵錯模式 |
29 |
| -* `use_insecure_cipher` - 使用不安全的密碼(ciphers)進行加密,參見 [#56](https://github.com/appleboy/ssh-action/issues/56) |
30 |
| -* `cipher` - 允許使用的密碼(ciphers)演算法。如果未指定,則使用適當的演算法 |
31 |
| - |
32 |
| -SSH 代理設置: |
33 |
| - |
34 |
| -* `proxy_host` - 代理主機 |
35 |
| -* `proxy_port` - 代理端口,預設為 `22` |
36 |
| -* `proxy_username` - 代理使用者名稱 |
37 |
| -* `proxy_password` - 代理密碼 |
38 |
| -* `proxy_passphrase` - 密碼通常用於加密私有金鑰 |
39 |
| -* `proxy_timeout` - SSH 連線至代理主機的逾時時間,預設為 `30s` |
40 |
| -* `proxy_key` - SSH 代理私有金鑰內容 |
41 |
| -* `proxy_key_path` - SSH 代理私有金鑰路徑 |
42 |
| -* `proxy_fingerprint` - 代理主機公鑰的 SHA256 指紋,預設為跳過驗證 |
43 |
| -* `proxy_use_insecure_cipher` - 使用不安全的加密方式,請參閱 [#56](https://github.com/appleboy/ssh-action/issues/56) |
44 |
| -* `proxy_cipher` - 允許的加密算法。如果未指定,則使用合理的算法 |
45 |
| - |
46 |
| -## 使用方式 |
| 16 | +請參閱 [action.yml](./action.yml) 以獲取更詳細的信息。 |
| 17 | + |
| 18 | +| 輸入參數 | 描述 | 預設值 | |
| 19 | +| ------------------------- | ----------------------------------------------------- | ------ | |
| 20 | +| host | SSH 主機地址 | | |
| 21 | +| port | SSH 埠號 | 22 | |
| 22 | +| passphrase | SSH 金鑰密碼 | | |
| 23 | +| username | SSH 使用者名稱 | | |
| 24 | +| password | SSH 密碼 | | |
| 25 | +| protocol | SSH 協議版本 (tcp, tcp4, tcp6) | tcp | |
| 26 | +| sync | 如果有多個主機,啟用同步執行 | false | |
| 27 | +| use_insecure_cipher | 包含更多不安全的加密算法 | false | |
| 28 | +| cipher | 允許的加密算法。如果未指定,則使用合理的預設值 | | |
| 29 | +| timeout | SSH 連接主機的超時時間 | 30s | |
| 30 | +| command_timeout | SSH 命令的超時時間 | 10m | |
| 31 | +| key | SSH 私鑰的內容。例如,~/.ssh/id_rsa 的原始內容 | | |
| 32 | +| key_path | SSH 私鑰的路徑 | | |
| 33 | +| fingerprint | 主機公鑰的 SHA256 指紋 | | |
| 34 | +| proxy_host | SSH 代理主機 | | |
| 35 | +| proxy_port | SSH 代理埠號 | 22 | |
| 36 | +| proxy_protocol | SSH 代理協議版本 (tcp, tcp4, tcp6) | tcp | |
| 37 | +| proxy_username | SSH 代理使用者名稱 | | |
| 38 | +| proxy_password | SSH 代理密碼 | | |
| 39 | +| proxy_passphrase | SSH 代理金鑰密碼 | | |
| 40 | +| proxy_timeout | SSH 連接代理主機的超時時間 | 30s | |
| 41 | +| proxy_key | SSH 代理私鑰的內容 | | |
| 42 | +| proxy_key_path | SSH 代理私鑰的路徑 | | |
| 43 | +| proxy_fingerprint | 代理主機公鑰的 SHA256 指紋 | | |
| 44 | +| proxy_cipher | 代理允許的加密算法 | | |
| 45 | +| proxy_use_insecure_cipher | 包含更多不安全的加密算法 | false | |
| 46 | +| script | 執行命令 | | |
| 47 | +| script_file | 從文件中執行命令 | | |
| 48 | +| script_stop | 在第一次失敗後停止腳本 | false | |
| 49 | +| envs | 將環境變數傳遞給 shell 腳本 | | |
| 50 | +| envs_format | 環境值傳遞的靈活配置 | | |
| 51 | +| debug | 啟用調試模式 | false | |
| 52 | +| allenvs | 將帶有 `GITHUB_` 和 `INPUT_` 前綴的環境變數傳遞給腳本 | false | |
| 53 | +| request_pty | 從伺服器請求偽終端 | false | |
| 54 | + |
| 55 | +## 用法 |
47 | 56 |
|
48 | 57 | 執行遠端 SSH 命令
|
49 | 58 |
|
|
0 commit comments