You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
style(readme): improve formatting and readability of documentation
- Fix formatting of the checklist items
- Adjust column widths in the properties table for better readability
Signed-off-by: appleboy <appleboy.tw@gmail.com>
Copy file name to clipboardExpand all lines: README.md
+22-22Lines changed: 22 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,10 +12,10 @@ easyssh-proxy provides a simple implementation of some SSH protocol features in
12
12
13
13
This project is forked from [easyssh](https://github.com/hypersleep/easyssh) but add some features as the following.
14
14
15
-
*[x] Support plain text of user private key.
16
-
*[x] Support key path of user private key.
17
-
*[x] Support Timeout for the TCP connection to establish.
18
-
*[x] Support SSH ProxyCommand.
15
+
-[x] Support plain text of user private key.
16
+
-[x] Support key path of user private key.
17
+
-[x] Support Timeout for the TCP connection to establish.
18
+
-[x] Support SSH ProxyCommand.
19
19
20
20
```bash
21
21
+--------+ +----------+ +-----------+
@@ -36,7 +36,7 @@ You can see detailed examples of the `ssh`, `scp`, `Proxy`, and `stream` command
36
36
37
37
### MakeConfig
38
38
39
-
All functionality provided by this package is accessed via methods of the MakeConfig struct.
39
+
All functionality provided by this package is accessed via methods of the MakeConfig struct.
40
40
41
41
```go
42
42
ssh:= &easyssh.MakeConfig{
@@ -54,22 +54,22 @@ All functionality provided by this package is accessed via methods of the MakeCo
54
54
55
55
MakeConfig takes in the following properties:
56
56
57
-
| property | description |
58
-
| -------------- | --------------- |
59
-
| user | The SSH user to be logged in with |
60
-
| Server | The IP or hostname pointing of the server |
61
-
| Key | A string containing the private key to be used when making the connection |
62
-
| KeyPath | The path pointing to the SSH key file to be used when making the connection |
63
-
| Port | The port to use when connecting to the SSH daemon of the server |
64
-
| Protocol | The tcp protocol to be used: `"tcp", "tcp4" "tcp6"`|
65
-
| Passphrase | The Passphrase to unlock the provided SSH key (leave blank if no Passphrase is required) |
66
-
| Password | The Password to use to login the specified user |
67
-
| Timeout | The length of time to wait before timing out the request |
68
-
| Proxy | An additional set of configuration params that will be used to SSH into an additional server via the server configured in this top-level block |
69
-
| Ciphers | An array of ciphers (e.g. aes256-ctr) to enable for the SSH connection |
70
-
| KeyExchanges | An array of key exchanges (e.g. ecdh-sha2-nistp384) to enable for the SSH connection |
71
-
| Fingerprint | The expected fingerprint to be returned by the SSH server, results in a fingerprint error if they do not match |
72
-
| UseInsecureCipher | Enables the use of insecure ciphers and key exchanges that are insecure and can lead to compromise, [see ssh](#ssh)|
| Server | The IP or hostname pointing of the server|
61
+
| Key | A string containing the private key to be used when making the connection|
62
+
| KeyPath | The path pointing to the SSH key file to be used when making the connection|
63
+
| Port | The port to use when connecting to the SSH daemon of the server|
64
+
| Protocol | The tcp protocol to be used: `"tcp", "tcp4" "tcp6"`|
65
+
| Passphrase | The Passphrase to unlock the provided SSH key (leave blank if no Passphrase is required)|
66
+
| Password | The Password to use to login the specified user|
67
+
| Timeout | The length of time to wait before timing out the request|
68
+
| Proxy | An additional set of configuration params that will be used to SSH into an additional server via the server configured in this top-level block |
69
+
| Ciphers | An array of ciphers (e.g. aes256-ctr) to enable for the SSH connection|
70
+
| KeyExchanges | An array of key exchanges (e.g. ecdh-sha2-nistp384) to enable for the SSH connection|
71
+
| Fingerprint | The expected fingerprint to be returned by the SSH server, results in a fingerprint error if they do not match|
72
+
| UseInsecureCipher | Enables the use of insecure ciphers and key exchanges that are insecure and can lead to compromise, [see ssh](#ssh)|
73
73
74
74
NOTE: Please view the reference documentation for the most up to date properties of [MakeConfig](https://pkg.go.dev/github.com/appleboy/easyssh-proxy#MakeConfig) and [DefaultConfig](https://pkg.go.dev/github.com/appleboy/easyssh-proxy#DefaultConfig)
75
75
@@ -190,7 +190,7 @@ See [examples/proxy/proxy.go](./_examples/proxy/proxy.go)
190
190
}
191
191
```
192
192
193
-
NOTE: Properties for the Proxy connection are not inherited from the Jumphost. You must explicitly specify them in the DefaultConfig struct.
193
+
NOTE: Properties for the Proxy connection are not inherited from the Jumphost. You must explicitly specify them in the DefaultConfig struct.
194
194
195
195
e.g. A custom `Timeout` length must be specified for both the Jumphost (intermediary server) and the destination server.
0 commit comments