Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,9 @@ The keys should be generated using the PEM format. You can use this command
```
ssh-keygen -m PEM -t rsa -b 4096
```
**Please Note:** You should not set a Passphrase (keep it empty) for the private key you generated.
Because rsync ssh (used for deploy) does not support private key password to be entered as a command line parameter.
> [!NOTE]
> **Please:** You should not set a Passphrase (keep it empty) for the private key you generated.
> Because rsync ssh (used for deploy) does not support private key password to be entered as a command line parameter.

##### 2. `REMOTE_HOST` [required]

Expand Down Expand Up @@ -90,7 +91,7 @@ A list of ssh arguments, they must be prefixed with -o and separated by a comma,
Use the latest version from Marketplace,eg: ssh-deploy@v5.1.0
or use the latest version from a branch, eg: ssh-deploy@main

```
```yaml
- name: Deploy to Staging server
uses: easingthemes/ssh-deploy@main
with:
Expand All @@ -112,7 +113,7 @@ or use the latest version from a branch, eg: ssh-deploy@main

# Example usage in workflow

```
```yaml
name: Node CI

on: [push]
Expand Down