Skip to content

Commit d99ccf8

Browse files
committed
docs: improve documentation clarity and consistency
- Change "GitHub Action" to "A GitHub Action" for clarity. - Update phrasing from "built using" to "built with" for consistency. - Revise "Make sure to follow the below steps" to "Follow the steps below" for improved readability. - Modify "best practice is create" to "It is best practice to create" for grammatical correctness. - Change "Add newly generated key into Authorized keys" to "Add the newly generated key to the Authorized keys" for clarity. - Update "Copy Private Key content and paste in Github Secrets" to "Copy the Private Key content and paste it into GitHub Secrets" for consistency. - Change "install `clip` command" to "install the `clip` command" for grammatical correctness. - Revise "See the detail information about" to "See detailed information about" for improved readability. - Update "A note from one of our readers" to "Note: Depending on your version of SSH" for clarity. - Change "Make sure that your key algorithm of choice is supported" to "Ensure that your chosen key algorithm is supported" for conciseness. - Revise "Alternatively, `ed25519` keys are accepted by default" to "Alternatively, `ed25519` keys are accepted by default in OpenSSH" for clarity. - Update "if you are running a command in a non interactive shell" to "If you are running a command in a non-interactive shell" for grammatical correctness. Signed-off-by: appleboy <appleboy.tw@gmail.com>
1 parent 9273705 commit d99ccf8

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
[繁體中文](./README.zh-tw.md) | [简体中文](./README.zh-cn.md)
44

5-
[GitHub Action](https://github.com/features/actions) for executing remote SSH commands.
5+
A [GitHub Action](https://github.com/features/actions) for executing remote SSH commands.
66

77
![ssh workflow](./images/ssh-workflow.png)
88

99
[![testing main branch](https://github.com/appleboy/ssh-action/actions/workflows/main.yml/badge.svg)](https://github.com/appleboy/ssh-action/actions/workflows/main.yml)
1010

11-
This project is built using [Golang](https://go.dev) and [drone-ssh](https://github.com/appleboy/drone-ssh). 🚀
11+
This project is built with [Golang](https://go.dev) and [drone-ssh](https://github.com/appleboy/drone-ssh). 🚀
1212

1313
## Input variables
1414

15-
See [action.yml](./action.yml) for more detailed information.
15+
Refer to [action.yml](./action.yml) for more detailed information.
1616

1717
| Input Parameter | Description | Default Value |
1818
| ------------------------- | ---------------------------------------------------------------------------------------- | ------------- |
@@ -88,9 +88,9 @@ linuxserver.io
8888

8989
### Setting up a SSH Key
9090

91-
Make sure to follow the below steps while creating SSH Keys and using them.
92-
The best practice is create the SSH Keys on local machine not remote machine.
93-
Login with username specified in Github Secrets. Generate a RSA Key-Pair:
91+
Follow the steps below to create and use SSH Keys.
92+
It is best practice to create SSH Keys on your local machine, not on a remote machine.
93+
Log in with the username specified in GitHub Secrets and generate an RSA Key-Pair:
9494

9595
### Generate rsa key
9696

@@ -104,7 +104,7 @@ ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
104104
ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
105105
```
106106

107-
Add newly generated key into Authorized keys. Read more about authorized keys [here](https://www.ssh.com/ssh/authorized_keys/).
107+
Add the newly generated key to the Authorized keys. Read more about authorized keys [here](https://www.ssh.com/ssh/authorized_keys/).
108108

109109
### Add rsa key into Authorized keys
110110

@@ -118,18 +118,18 @@ cat .ssh/id_rsa.pub | ssh b@B 'cat >> .ssh/authorized_keys'
118118
cat .ssh/id_ed25519.pub | ssh b@B 'cat >> .ssh/authorized_keys'
119119
```
120120

121-
Copy Private Key content and paste in Github Secrets.
121+
Copy the Private Key content and paste it into GitHub Secrets.
122122

123123
### Copy rsa Private key
124124

125-
Before copying the private key, install `clip` command as shown below:
125+
Before copying the private key, install the `clip` command as shown below:
126126

127127
```bash
128128
# Ubuntu
129129
sudo apt-get install xclip
130130
```
131131

132-
copy the private key:
132+
Copy the private key:
133133

134134
```bash
135135
# macOS
@@ -147,9 +147,9 @@ pbcopy < ~/.ssh/id_ed25519
147147
xclip < ~/.ssh/id_ed25519
148148
```
149149

150-
See the detail information about [SSH login without password](http://www.linuxproblem.org/art_9.html).
150+
See detailed information about [SSH login without a password](http://www.linuxproblem.org/art_9.html).
151151

152-
**A note** from one of our readers: Depending on your version of SSH you might also have to do the following changes:
152+
**Note**: Depending on your version of SSH, you might also need to make the following changes:
153153

154154
- Put the public key in `.ssh/authorized_keys2`
155155
- Change the permissions of `.ssh` to 700
@@ -163,13 +163,13 @@ If you are currently using OpenSSH and are getting the following error:
163163
ssh: handshake failed: ssh: unable to authenticate, attempted methods [none publickey]
164164
```
165165

166-
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 `/etc/ssh/sshd_config.d/`):
166+
Ensure that your chosen key algorithm 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 (either `/etc/ssh/sshd_config` or a drop-in file under `/etc/ssh/sshd_config.d/`):
167167

168168
```bash
169169
CASignatureAlgorithms +ssh-rsa
170170
```
171171

172-
Alternatively, `ed25519` keys are accepted by default in OpenSSH. You could use this instead of rsa if needed:
172+
Alternatively, `ed25519` keys are accepted by default in OpenSSH. You can use this instead of rsa if needed:
173173

174174
```bash
175175
ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
@@ -400,7 +400,7 @@ Now you can adjust you config:
400400

401401
See the [issue comment](https://github.com/appleboy/ssh-action/issues/31#issuecomment-1006565847) about interactive vs non interactive shell. Thanks @kocyigityunus for the solution.
402402

403-
Basically, if you are running a command in a non interactive shell, like ssh-action, on many linux distros,
403+
If you are running a command in a non-interactive shell, like ssh-action, on many Linux distros,
404404

405405
`/etc/bash.bashrc` file has a specific command that returns only, so some of the files didn't run and some specific commands doesn't add to path,
406406

@@ -415,7 +415,7 @@ Basically, if you are running a command in a non interactive shell, like ssh-act
415415
[ -z "$PS1" ] && return`
416416
```
417417

418-
just comment out the line that returns early and everything should work fine, or you can use the real paths of the commands that you would like to use.
418+
comment out the line that returns early, and everything should work fine. Alternatively, you can use the real paths of the commands you want to use.
419419

420420
## Contributing
421421

0 commit comments

Comments
 (0)