Hostux/github.com_burnett01_rsync-deployments
1
0
Fork 1
mirror of https://github.com/Burnett01/rsync-deployments.git synced 2025-04-19 18:51:02 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
Steven Agyekum 2021-08-02 20:08:41 +02:00 committed by GitHub
parent 34440973d1
commit 5a327cffc7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 44 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
README.md
View file

@ -26,11 +26,15 @@ The underlaying base-image of the docker-image is very small (Alpine (no cache))
- `remote_key`* - The remote ssh key - `remote_key`* - The remote ssh key
- `remote_key_pass` - The remote ssh key passphrase (if any)
``* = Required`` ``* = Required``
## Required secret ## Required secret(s)
This action needs a `DEPLOY_KEY` secret variable. This should be the private key part of a ssh key pair. The public key part should be added to the authorized_keys file on the server that receives the deployment. This should be set in the Github secrets section and then referenced as the `remote_key` input. This action needs a secret variable for the ssh private key of your ssh key pair. The public key part should be added to the authorized_keys file on the server that receives the deployment. The secret variable should be set in the Github secrets section of your org/repo and then referenced as the `remote_key` input.
For simplicity, we are using `DEPLOY_*` as the secret variables throughout the examples.
## Example usage ## Example usage
@ -49,7 +53,7 @@ jobs:
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- name: rsync deployments - name: rsync deployments
uses: burnett01/rsync-deployments@4.1 uses: burnett01/rsync-deployments@5.0
with: with:
switches: -avzr --delete switches: -avzr --delete
path: src/ path: src/
@ -68,7 +72,7 @@ jobs:
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- name: rsync deployments - name: rsync deployments
uses: burnett01/rsync-deployments@4.1 uses: burnett01/rsync-deployments@5.0
with: with:
switches: -avzr --delete --exclude="" --include="" --filter="" switches: -avzr --delete --exclude="" --include="" --filter=""
path: src/ path: src/
@ -79,7 +83,7 @@ jobs:
remote_key: ${{ secrets.DEPLOY_KEY }} remote_key: ${{ secrets.DEPLOY_KEY }}
``` ```
For better security, I suggest you create additional secrets for remote_host, remote_port and remote_user inputs. For better security, I suggest you create additional secrets for remote_host, remote_port, remote_user and remote_path inputs.
``` ```
jobs: jobs:
@ -88,17 +92,50 @@ jobs:
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- name: rsync deployments - name: rsync deployments
uses: burnett01/rsync-deployments@4.1 uses: burnett01/rsync-deployments@5.0
with: with:
switches: -avzr --delete switches: -avzr --delete
path: src/ path: src/
remote_path: /var/www/html/ remote_path: ${{ secrets.DEPLOY_PATH }}
remote_host: ${{ secrets.DEPLOY_HOST }} remote_host: ${{ secrets.DEPLOY_HOST }}
remote_port: ${{ secrets.DEPLOY_PORT }} remote_port: ${{ secrets.DEPLOY_PORT }}
remote_user: ${{ secrets.DEPLOY_USER }} remote_user: ${{ secrets.DEPLOY_USER }}
remote_key: ${{ secrets.DEPLOY_KEY }} remote_key: ${{ secrets.DEPLOY_KEY }}
``` ```
If your private key is passphrase protected you should use:
```
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: rsync deployments
uses: burnett01/rsync-deployments@5.0
with:
switches: -avzr --delete
path: src/
remote_path: ${{ secrets.DEPLOY_PATH }}
remote_host: ${{ secrets.DEPLOY_HOST }}
remote_port: ${{ secrets.DEPLOY_PORT }}
remote_user: ${{ secrets.DEPLOY_USER }}
remote_key: ${{ secrets.DEPLOY_KEY }}
remote_key_pass: ${{ secrets.DEPLOY_KEY_PASS }}
```
---
## Version 4.0 & 4.1
Looking for version 4.0 and 4.1?
Check here:
- https://github.com/Burnett01/rsync-deployments/tree/4.0
- https://github.com/Burnett01/rsync-deployments/tree/4.1
Version 4.0 & 4.1 use the ``drinternet/rsync:1.0.1`` base-image.
--- ---
## Version 3.0 ## Version 3.0