Skip to content

Commit f479c97

Browse files
authored
chore: mention new legacy_allow_rsa_hostkeys option
1 parent 0087195 commit f479c97

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ The base-image [drinternet/rsync](https://github.com/JoshPiper/rsync-docker/) of
1414

1515
- `rsh` - Remote shell commands
1616

17+
- `legacy_allow_rsa_hostkeys` - Enables support for legacy RSA host keys on OpenSSH 8.8+. ("true" / "false")
18+
1719
- `path` - The source path. Defaults to GITHUB_WORKSPACE and is relative to it
1820

1921
- `remote_path`* - The deployment target path
@@ -125,6 +127,35 @@ jobs:
125127
remote_key: ${{ secrets.DEPLOY_KEY }}
126128
remote_key_pass: ${{ secrets.DEPLOY_KEY_PASS }}
127129
```
130+
131+
---
132+
133+
#### Legacy RSA Hostkeys support for OpenSSH Servers >= 8.8+
134+
135+
If your remote OpenSSH Server still uses RSA hostkeys, then you have to
136+
manually enable legacy support for this by using ``legacy_allow_rsa_hostkeys: "true"``.
137+
138+
```
139+
jobs:
140+
deploy:
141+
runs-on: ubuntu-latest
142+
steps:
143+
- uses: actions/checkout@v3
144+
- name: rsync deployments
145+
uses: burnett01/rsync-deployments@6.0.0
146+
with:
147+
switches: -avzr --delete
148+
legacy_allow_rsa_hostkeys: "true"
149+
path: src/
150+
remote_path: ${{ secrets.DEPLOY_PATH }}
151+
remote_host: ${{ secrets.DEPLOY_HOST }}
152+
remote_port: ${{ secrets.DEPLOY_PORT }}
153+
remote_user: ${{ secrets.DEPLOY_USER }}
154+
remote_key: ${{ secrets.DEPLOY_KEY }}
155+
```
156+
157+
See [#49](https://github.com/Burnett01/rsync-deployments/issues/49) and [#24](https://github.com/Burnett01/rsync-deployments/issues/24) for more information.
158+
128159
---
129160

130161
## Version 5.0, 5.1 & 5.2

0 commit comments

Comments
 (0)