Skynet/action-scp
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: fix format

Browse source 
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
This commit is contained in:
Bo-Yi Wu 2022-07-30 10:28:44 +08:00
parent 7f8a7c1019
commit 9ec0623f29
1 changed files with 9 additions and 51 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
README.md
View file

@ -66,82 +66,40 @@ SSH Proxy Setting:
* proxy_fingerprint - fingerprint SHA256 of the host public key, default is to skip verification * proxy_fingerprint - fingerprint SHA256 of the host public key, default is to skip verification
* proxy_use_insecure_cipher - include more ciphers with use_insecure_cipher (see [#15](https://github.com/appleboy/scp-action/issues/15)) * proxy_use_insecure_cipher - include more ciphers with use_insecure_cipher (see [#15](https://github.com/appleboy/scp-action/issues/15))
### Setting up a SSH Key ## Setting up a 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.
The best practice is create the SSH Keys on local machine not remote machine. The best practice is create the SSH Keys on local machine not remote machine.
Login with username specified in Github Secrets. Generate a RSA Key-Pair: Login with username specified in Github Secrets. Generate a RSA Key-Pair:
<details>
<summary>rsa</summary>
<p>
```bash ```bash
# rsa
ssh-keygen -t rsa -b 4096 -C "your_email@example.com" ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
```
</p> # ed25519
</details>
<details>
<summary>ed25519</summary>
<p>
```bash
ssh-keygen -t ed25519 -a 200 -C "your_email@example.com" ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
``` ```
</p>
</details>
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/).
<details>
<summary>rsa</summary>
<p>
```bash ```bash
# rsa
cat .ssh/id_rsa.pub | ssh b@B 'cat >> .ssh/authorized_keys' cat .ssh/id_rsa.pub | ssh b@B 'cat >> .ssh/authorized_keys'
```
</p> # d25519
</details>
<details>
<summary>ed25519</summary>
<p>
```bash
cat .ssh/id_ed25519.pub | ssh b@B 'cat >> .ssh/authorized_keys' cat .ssh/id_ed25519.pub | ssh b@B 'cat >> .ssh/authorized_keys'
``` ```
</p>
</details>
Copy Private Key content and paste in Github Secrets. Copy Private Key content and paste in Github Secrets.
<details>
<summary>rsa</summary>
<p>
```bash ```bash
# rsa
clip < ~/.ssh/id_rsa clip < ~/.ssh/id_rsa
```
</p> # ed25519
</details>
<details>
<summary>ed25519</summary>
<p>
```bash
clip < ~/.ssh/id_ed25519 clip < ~/.ssh/id_ed25519
``` ```
</p>
</details>
See the detail information about [SSH login without password](http://www.linuxproblem.org/art_9.html). See the detail information about [SSH login without password](http://www.linuxproblem.org/art_9.html).
**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:
@ -158,8 +116,8 @@ If you are currently using OpenSSH and are getting the following error:
ssh: handshake failed: ssh: unable to authenticate, attempted methods [none publickey] ssh: handshake failed: ssh: unable to authenticate, attempted methods [none publickey]
``` ```
Make sure that your key algorithm of choice is supported. On Ubuntu 20.04 or later you must explicitly allow the use of the ssh-rsa algorithm. Add the following line to your OpenSSH daemon file (which is either `/etc/ssh/sshd_config` or a drop-in file under Make sure that your key algorithm of choice is supported.
`/etc/ssh/sshd_config.d/`): On Ubuntu 20.04 or later you must explicitly allow the use of the ssh-rsa algorithm. Add the following line to your OpenSSH daemon file (which is either `/etc/ssh/sshd_config` or a drop-in file under `/etc/ssh/sshd_config.d/`):
```bash ```bash
CASignatureAlgorithms +ssh-rsa CASignatureAlgorithms +ssh-rsa