{"id":18026375,"url":"https://github.com/miked49er/rsync-deployments","last_synced_at":"2026-04-19T15:02:00.318Z","repository":{"id":65160905,"uuid":"267137080","full_name":"miked49er/rsync-deployments","owner":"miked49er","description":"GitHub Action for deploying code via rsync over ssh ","archived":false,"fork":false,"pushed_at":"2020-05-29T19:22:13.000Z","size":6,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-06T23:49:17.001Z","etag":null,"topics":["action","actions","deploy","deployment","github-actions"],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/miked49er.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-26T19:47:36.000Z","updated_at":"2021-01-31T08:24:26.000Z","dependencies_parsed_at":"2023-01-13T15:44:12.154Z","dependency_job_id":null,"html_url":"https://github.com/miked49er/rsync-deployments","commit_stats":{"total_commits":8,"total_committers":2,"mean_commits":4.0,"dds":0.125,"last_synced_commit":"dadf4ecd6fc4d880b64eeeff4a0d41cce64239b9"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/miked49er/rsync-deployments","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miked49er%2Frsync-deployments","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miked49er%2Frsync-deployments/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miked49er%2Frsync-deployments/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miked49er%2Frsync-deployments/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/miked49er","download_url":"https://codeload.github.com/miked49er/rsync-deployments/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miked49er%2Frsync-deployments/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267834751,"owners_count":24151637,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-30T02:00:09.044Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["action","actions","deploy","deployment","github-actions"],"created_at":"2024-10-30T08:06:28.212Z","updated_at":"2026-04-19T15:01:55.294Z","avatar_url":"https://github.com/miked49er.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rsync deployments\n\nThis GitHub Action deploys files in `GITHUB_WORKSPACE` to a remote folder via rsync over ssh. \n\nUse this action in a CD workflow which leaves deployable code in `GITHUB_WORKSPACE`.\n\nThe base-image is very small (Alpine+Cache) which results in faster deployments.\n\n---\n\n## Inputs\n\n- `switches`* - The first is for any initial/required rsync flags, eg: `-avzr --delete`\n\n- `rsh` - Remote shell commands\n\n- `path` - The source path. Defaults to GITHUB_WORKSPACE\n\n- `remote_path`* - The deployment target path\n\n- `remote_host`* - The remote host\n\n- `remote_port` - The remote port. Defaults to 22\n\n- `remote_user`* - The remote user\n\n- `remote_key`* - The remote ssh key\n\n``* = Required``\n\n## Required secret\n\nThis 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.\n\n## Example usage\n\nSimple:\n\n```\nname: DEPLOY\non:\n  push:\n    branches:\n    - master\n\njobs:\n  deploy:\n    runs-on: ubuntu-latest\n    steps:\n    - uses: actions/checkout@v1\n    - name: rsync deployments\n      uses: miked49er/rsync-deployments@v1.0\n      with:\n        switches: -avzr --delete\n        path: src/\n        remote_path: /var/www/html/\n        remote_host: example.com\n        remote_user: debian\n        remote_key: ${{ secrets.DEPLOY_KEY }}\n```\n\nAdvanced:\n\n```\njobs:\n  deploy:\n    runs-on: ubuntu-latest\n    steps:\n    - uses: actions/checkout@v1\n    - name: rsync deployments\n      uses: miked49er/rsync-deployments@v1.0\n      with:\n        switches: -avzr --delete --exclude=\"\" --include=\"\" --filter=\"\"\n        path: src/\n        remote_path: /var/www/html/\n        remote_host: example.com\n        remote_port: 5555\n        remote_user: debian\n        remote_key: ${{ secrets.DEPLOY_KEY }}\n```\n\nFor better security, I suggest you create additional secrets for remote_host, remote_port and remote_user inputs.\n\n```\njobs:\n  deploy:\n    runs-on: ubuntu-latest\n    steps:\n    - uses: actions/checkout@v1\n    - name: rsync deployments\n      uses: miked49er/rsync-deployments@v1.0\n      with:\n        switches: -avzr --delete\n        path: src/\n        remote_path: /var/www/html/\n        remote_host: ${{ secrets.DEPLOY_HOST }}\n        remote_port: ${{ secrets.DEPLOY_PORT }}\n        remote_user: ${{ secrets.DEPLOY_USER }}\n        remote_key: ${{ secrets.DEPLOY_KEY }}\n```\n\nFor maximum speed limit the checkout action (``actions/checkout@v1``) to a depth of 1:\n\n```\njobs:\n  deploy:\n    runs-on: ubuntu-latest\n    steps:\n    - uses: actions/checkout@v1\n      with:\n        fetch-depth: 1\n    - name: rsync deployments\n      uses: miked49er/rsync-deployments@v1.0\n      with:\n        switches: -avzr --delete\n        path: src/\n        remote_path: /var/www/html/\n        remote_host: ${{ secrets.DEPLOY_HOST }}\n        remote_port: ${{ secrets.DEPLOY_PORT }}\n        remote_user: ${{ secrets.DEPLOY_USER }}\n        remote_key: ${{ secrets.DEPLOY_KEY }}\n```\n\n---\n\n## Acknowledgements\n\n+ This project is a fork of [Burnett01/rsync-deployments](https://github.com/Burnett01/rsync-deployments)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmiked49er%2Frsync-deployments","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmiked49er%2Frsync-deployments","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmiked49er%2Frsync-deployments/lists"}