Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kielabokkie authored Aug 28, 2022
1 parent 05653ce commit aaea40c
Showing 1 changed file with 6 additions and 15 deletions.
21 changes: 6 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,12 @@ Did this action spark joy, or you find it useful? Please consider sponsoring me

## Inputs

* `ssh-private-key`

**Required** Private key required to access the host.

* `ssh-host`

**Required** Hostname or IP address to add to the known hosts file.

* `ssh-port`

*Optional* Port for key-scanning the server.

* `ssh-socket`

*Optional* The unix file socket that the agent uses for communication with other processes.
| Input | Required | Description
| ------------- | ------------- | ------------- |
| `ssh-private-key` | **Yes** | Private key required to access the host. |
| `ssh-host` | **Yes** | Hostname or IP address of the server you want to access. |
| `ssh-port` | Optional | Port for used for SSH on the host server (port 22 by default). |
| `ssh-socket` | Optional | The unix file socket that the agent uses for communication with other processes. |

## Example usage

Expand Down

0 comments on commit aaea40c

Please sign in to comment.