mirror of
https://gitea.com/actions/appleboy-ssh-action.git
synced 2024-11-22 18:19:36 +01:00
docs: update readme
This commit is contained in:
parent
8bd4933b73
commit
ffff33f8fe
1 changed files with 22 additions and 14 deletions
16
README.md
16
README.md
|
@ -80,20 +80,28 @@ SSH Proxy Setting:
|
||||||
* proxy_cipher - the allowed cipher algorithms. If unspecified then a sensible
|
* proxy_cipher - the allowed cipher algorithms. If unspecified then a sensible
|
||||||
|
|
||||||
### Setting up SSH Key
|
### Setting up SSH Key
|
||||||
|
|
||||||
Make sure to follow the below steps while creating SSH Keys and using them.
|
Make sure to follow the below steps while creating SSH Keys and using them.
|
||||||
* Login with username specified in Github Secrets.
|
Login with username specified in Github Secrets. Generate a RSA Key-Pair:
|
||||||
* Generate a RSA Key-Pair.
|
|
||||||
```bash
|
```bash
|
||||||
ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
|
ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
|
||||||
```
|
```
|
||||||
* Add newly generated key into Authorized keys. Read more about authorized keys [here](https://www.ssh.com/ssh/authorized_keys/).
|
|
||||||
|
Add newly generated key into Authorized keys. Read more about authorized keys [here](https://www.ssh.com/ssh/authorized_keys/).
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys
|
cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys
|
||||||
```
|
```
|
||||||
* Copy Private Key content and paste in Github Secrets.
|
|
||||||
|
Copy Private Key content and paste in Github Secrets.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
clip < ~/.ssh/id_rsa
|
clip < ~/.ssh/id_rsa
|
||||||
```
|
```
|
||||||
|
|
||||||
|
See the detail information about [SSH login without password](http://www.linuxproblem.org/art_9.html)
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
|
|
||||||
Executing remote ssh commands using password.
|
Executing remote ssh commands using password.
|
||||||
|
|
Loading…
Reference in a new issue