mirror of
https://gitea.com/actions/appleboy-ssh-action.git
synced 2024-12-05 00:19:34 +01:00
docs(readme): standardize and format README files across languages
- Remove an empty line in `README.md` - Replace underscores with bold formatting for default key types in `README.zh-cn.md` and `README.zh-tw.md` - Standardize list formatting in `README.md`, `README.zh-cn.md`, and `README.zh-tw.md` Signed-off-by: appleboy <appleboy.tw@gmail.com>
This commit is contained in:
appleboy
parent
6137f733fb
commit
b76e6173e8
3 changed files with 38 additions and 41 deletions
25
README.md
25
README.md
|
|
@ -60,19 +60,18 @@ Executing remote SSH commands.
|
||||||
name: remote ssh command
|
name: remote ssh command
|
||||||
on: [push]
|
on: [push]
|
||||||
jobs:
|
jobs:
|
||||||
|
|
||||||
build:
|
build:
|
||||||
name: Build
|
name: Build
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: executing remote ssh commands using password
|
- name: executing remote ssh commands using password
|
||||||
uses: appleboy/ssh-action@v1.2.0
|
uses: appleboy/ssh-action@v1.2.0
|
||||||
with:
|
with:
|
||||||
host: ${{ secrets.HOST }}
|
host: ${{ secrets.HOST }}
|
||||||
username: linuxserver.io
|
username: linuxserver.io
|
||||||
password: ${{ secrets.PASSWORD }}
|
password: ${{ secrets.PASSWORD }}
|
||||||
port: ${{ secrets.PORT }}
|
port: ${{ secrets.PORT }}
|
||||||
script: whoami
|
script: whoami
|
||||||
```
|
```
|
||||||
|
|
||||||
output:
|
output:
|
||||||
|
|
@ -152,9 +151,9 @@ See the detail information about [SSH login without password](http://www.linuxpr
|
||||||
|
|
||||||
**A note** from one of our readers: Depending on your version of SSH you might also have to do the following changes:
|
**A note** from one of our readers: Depending on your version of SSH you might also have to do the following changes:
|
||||||
|
|
||||||
* Put the public key in `.ssh/authorized_keys2`
|
- Put the public key in `.ssh/authorized_keys2`
|
||||||
* Change the permissions of `.ssh` to 700
|
- Change the permissions of `.ssh` to 700
|
||||||
* Change the permissions of `.ssh/authorized_keys2` to 640
|
- Change the permissions of `.ssh/authorized_keys2` to 640
|
||||||
|
|
||||||
### If you are using OpenSSH
|
### If you are using OpenSSH
|
||||||
|
|
||||||
|
|
@ -231,7 +230,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
|
||||||
username: ${{ secrets.USERNAME }}
|
username: ${{ secrets.USERNAME }}
|
||||||
key: ${{ secrets.KEY }}
|
key: ${{ secrets.KEY }}
|
||||||
port: ${{ secrets.PORT }}
|
port: ${{ secrets.PORT }}
|
||||||
script_path: scripts/script.sh
|
script_path: scripts/script.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Multiple Hosts
|
#### Multiple Hosts
|
||||||
|
|
|
||||||
|
|
@ -57,19 +57,18 @@
|
||||||
name: remote ssh command
|
name: remote ssh command
|
||||||
on: [push]
|
on: [push]
|
||||||
jobs:
|
jobs:
|
||||||
|
|
||||||
build:
|
build:
|
||||||
name: Build
|
name: Build
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: executing remote ssh commands using password
|
- name: executing remote ssh commands using password
|
||||||
uses: appleboy/ssh-action@v1.2.0
|
uses: appleboy/ssh-action@v1.2.0
|
||||||
with:
|
with:
|
||||||
host: ${{ secrets.HOST }}
|
host: ${{ secrets.HOST }}
|
||||||
username: ${{ secrets.USERNAME }}
|
username: ${{ secrets.USERNAME }}
|
||||||
password: ${{ secrets.PASSWORD }}
|
password: ${{ secrets.PASSWORD }}
|
||||||
port: ${{ secrets.PORT }}
|
port: ${{ secrets.PORT }}
|
||||||
script: whoami
|
script: whoami
|
||||||
```
|
```
|
||||||
|
|
||||||
画面输出
|
画面输出
|
||||||
|
|
@ -132,9 +131,9 @@ clip < ~/.ssh/id_ed25519
|
||||||
|
|
||||||
**来自读者的注意事项**： 根据您的 SSH 版本，您可能还需要进行以下更改：
|
**来自读者的注意事项**： 根据您的 SSH 版本，您可能还需要进行以下更改：
|
||||||
|
|
||||||
* 将公钥放在 `.ssh/authorized_keys2` 中
|
- 将公钥放在 `.ssh/authorized_keys2` 中
|
||||||
* 将 `.ssh` 的权限更改为700
|
- 将 `.ssh` 的权限更改为 700
|
||||||
* 将 `.ssh/authorized_keys2` 的权限更改为640
|
- 将 `.ssh/authorized_keys2` 的权限更改为 640
|
||||||
|
|
||||||
### 如果你使用的是 OpenSSH
|
### 如果你使用的是 OpenSSH
|
||||||
|
|
||||||
|
|
@ -227,7 +226,7 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“
|
||||||
username: ${{ secrets.USERNAME }}
|
username: ${{ secrets.USERNAME }}
|
||||||
key: ${{ secrets.KEY }}
|
key: ${{ secrets.KEY }}
|
||||||
port: ${{ secrets.PORT }}
|
port: ${{ secrets.PORT }}
|
||||||
script_path: scripts/script.sh
|
script_path: scripts/script.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 多个不同端口的主机
|
#### 多个不同端口的主机
|
||||||
|
|
@ -380,7 +379,7 @@ Host FooServer
|
||||||
|
|
||||||
设置 SSH 主机指纹验证可以帮助防止中间人攻击。在设置之前，运行以下命令以获取 SSH 主机指纹。请记得将 `ed25519` 替换为您适当的密钥类型（`rsa`、 `dsa`等），而 `example.com` 则替换为您的主机。
|
设置 SSH 主机指纹验证可以帮助防止中间人攻击。在设置之前，运行以下命令以获取 SSH 主机指纹。请记得将 `ed25519` 替换为您适当的密钥类型（`rsa`、 `dsa`等），而 `example.com` 则替换为您的主机。
|
||||||
|
|
||||||
现代 OpenSSH 版本中，需要提取的_默认密钥_类型是 `rsa`（从版本 5.1 开始）、`ecdsa`（从版本 6.0 开始）和 `ed25519`（从版本 6.7 开始）。
|
现代 OpenSSH 版本中，需要提取的**默认密钥**类型是 `rsa`（从版本 5.1 开始）、`ecdsa`（从版本 6.0 开始）和 `ed25519`（从版本 6.7 开始）。
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
ssh example.com ssh-keygen -l -f /etc/ssh/ssh_host_ed25519_key.pub | cut -d ’ ‘ -f2
|
ssh example.com ssh-keygen -l -f /etc/ssh/ssh_host_ed25519_key.pub | cut -d ’ ‘ -f2
|
||||||
|
|
|
||||||
|
|
@ -60,19 +60,18 @@
|
||||||
name: remote ssh command
|
name: remote ssh command
|
||||||
on: [push]
|
on: [push]
|
||||||
jobs:
|
jobs:
|
||||||
|
|
||||||
build:
|
build:
|
||||||
name: Build
|
name: Build
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: executing remote ssh commands using password
|
- name: executing remote ssh commands using password
|
||||||
uses: appleboy/ssh-action@v1.2.0
|
uses: appleboy/ssh-action@v1.2.0
|
||||||
with:
|
with:
|
||||||
host: ${{ secrets.HOST }}
|
host: ${{ secrets.HOST }}
|
||||||
username: ${{ secrets.USERNAME }}
|
username: ${{ secrets.USERNAME }}
|
||||||
password: ${{ secrets.PASSWORD }}
|
password: ${{ secrets.PASSWORD }}
|
||||||
port: ${{ secrets.PORT }}
|
port: ${{ secrets.PORT }}
|
||||||
script: whoami
|
script: whoami
|
||||||
```
|
```
|
||||||
|
|
||||||
畫面輸出
|
畫面輸出
|
||||||
|
|
@ -135,9 +134,9 @@ clip < ~/.ssh/id_ed25519
|
||||||
|
|
||||||
**來自讀者的注意事項**： 根據您的 SSH 版本，您可能還需要進行以下更改：
|
**來自讀者的注意事項**： 根據您的 SSH 版本，您可能還需要進行以下更改：
|
||||||
|
|
||||||
* 將公鑰放在 `.ssh/authorized_keys2` 中
|
- 將公鑰放在 `.ssh/authorized_keys2` 中
|
||||||
* 將 `.ssh` 的權限更改為700
|
- 將 `.ssh` 的權限更改為 700
|
||||||
* 將 `.ssh/authorized_keys2` 的權限更改為640
|
- 將 `.ssh/authorized_keys2` 的權限更改為 640
|
||||||
|
|
||||||
### 如果你使用的是 OpenSSH
|
### 如果你使用的是 OpenSSH
|
||||||
|
|
||||||
|
|
@ -214,7 +213,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
|
||||||
username: ${{ secrets.USERNAME }}
|
username: ${{ secrets.USERNAME }}
|
||||||
key: ${{ secrets.KEY }}
|
key: ${{ secrets.KEY }}
|
||||||
port: ${{ secrets.PORT }}
|
port: ${{ secrets.PORT }}
|
||||||
script_path: scripts/script.sh
|
script_path: scripts/script.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 多台主機
|
#### 多台主機
|
||||||
|
|
@ -383,7 +382,7 @@ Host FooServer
|
||||||
|
|
||||||
設置 SSH 主機指紋驗證可以幫助防止中間人攻擊。在設置之前，運行以下命令以獲取 SSH 主機指紋。請記得將 `ed25519` 替換為您的適當金鑰類型（`rsa`、 `dsa`等），而 `example.com` 則替換為您的主機。
|
設置 SSH 主機指紋驗證可以幫助防止中間人攻擊。在設置之前，運行以下命令以獲取 SSH 主機指紋。請記得將 `ed25519` 替換為您的適當金鑰類型（`rsa`、 `dsa`等），而 `example.com` 則替換為您的主機。
|
||||||
|
|
||||||
現代 OpenSSH 版本中，需要提取的_默認金鑰_類型是 `rsa`（從版本 5.1 開始）、`ecdsa`（從版本 6.0 開始）和 `ed25519`（從版本 6.7 開始）。
|
現代 OpenSSH 版本中，需要提取的**默認金鑰**類型是 `rsa`（從版本 5.1 開始）、`ecdsa`（從版本 6.0 開始）和 `ed25519`（從版本 6.7 開始）。
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
ssh example.com ssh-keygen -l -f /etc/ssh/ssh_host_ed25519_key.pub | cut -d ' ' -f2
|
ssh example.com ssh-keygen -l -f /etc/ssh/ssh_host_ed25519_key.pub | cut -d ' ' -f2
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue