{"id":16124318,"url":"https://github.com/jongacnik/rploy","last_synced_at":"2026-02-22T20:03:29.123Z","repository":{"id":42058745,"uuid":"283360871","full_name":"jongacnik/rploy","owner":"jongacnik","description":"Minimal rsync deployment","archived":false,"fork":false,"pushed_at":"2023-07-12T06:43:24.000Z","size":71,"stargazers_count":78,"open_issues_count":2,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-01T19:25:21.008Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jongacnik.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-29T00:47:34.000Z","updated_at":"2024-11-03T21:33:57.000Z","dependencies_parsed_at":"2022-08-12T03:40:30.117Z","dependency_job_id":null,"html_url":"https://github.com/jongacnik/rploy","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/jongacnik/rploy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jongacnik%2Frploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jongacnik%2Frploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jongacnik%2Frploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jongacnik%2Frploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jongacnik","download_url":"https://codeload.github.com/jongacnik/rploy/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jongacnik%2Frploy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29725296,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-22T19:57:12.410Z","status":"ssl_error","status_checked_at":"2026-02-22T19:54:50.710Z","response_time":110,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2024-10-09T21:20:33.271Z","updated_at":"2026-02-22T20:03:29.105Z","avatar_url":"https://github.com/jongacnik.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rploy 🚚\n\nMinimal rsync deployment\n\n\u003cimg src=\"https://files.jongacnik.com/rploy.gif\" width=\"707\" height=\"auto\" /\u003e\n\n## Usage\n\n```\nnpm i rploy -D\n```\n\nAdd source and destination options to your `package.json`:\n\n```json\n{\n  \"rploy\": {\n    \"source\": \"public/\",\n    \"destination\": \"user@ip:/var/www/public/\"\n  }\n}\n```\n\nAlternatively, you can create an `rploy.config.js` file in your document root:\n\n```js\nmodule.exports = {\n  source: 'public/',\n  destination: \"user@ip:/var/www/public/\"\n}\n```\n\nDeploy:\n\n```\nnpx rploy\n```\n\n## Config\n\n`rploy` wraps [`node-rsync`](https://github.com/mattijs/node-rsync), so you can pass any relevant options to configure flags, progress, excludes, etc. Here is an example:\n\n```json\n{\n  \"rploy\": {\n    \"source\": \"public/\",\n    \"destination\": \"user@ip:/var/www/public/\",\n    \"exclude\": [\n      \".DS_Store\",\n      \"Icon\",\n      \"node_modules\",\n      \".git\"\n    ],\n    \"progress\": true\n  }\n}\n```\n\n## Branches\n\nWhen deploying git repositories, `rploy` offers a `branches` option, which provides a way to be explicit about a destination for each branch:\n\n```json\n{\n  \"rploy\": {\n    \"source\": \"public/\",\n    \"branches\": {\n      \"master\": \"user@ip:/var/www/prod/public/\",\n      \"dev\": \"user@ip:/var/www/dev/public/\"\n    }\n  }\n}\n```\n\nYou will now be notified of your current working branch and the destination:\n\n\n\u003cimg src=\"https://files.jongacnik.com/rploy-3.gif\" width=\"707\" height=\"auto\"\u003e\n\n\u003cbr\u003eThis provides an easy way to prevent issues like accidentally deploying your staging branch to production. It will always check your working branch and look for a deploy context. You can even pass `node-rsync` options into each branch, to get even more granular:\n\n```json\n{\n  \"rploy\": {\n    \"source\": \"public/\",\n    \"branches\": {\n      \"master\": {\n        \"destination\": \"user@ip:/var/www/prod/public/\",\n        \"exclude\": [\n          \"readme.md\"\n        ]\n      },\n      \"dev\": {\n        \"destination\": \"user@ip:/var/www/dev/public/\",\n        \"delete\": false\n      }\n    }\n  }\n}\n```\n\n## Tips\n\n- I recommend adding your ssh key to the server you are deploying to, for easy passwordless auth.\n- Use a lifecycle script to build assets before a deploy:\n\n```json\n{\n  \"scripts\": {\n    \"build\": \"parcel src/index.js\",\n    \"deploy\": \"npx rploy\",\n    \"predeploy\": \"npm run build\"\n  },\n  \"rploy\": {\n    \"source\": \"public/\",\n    \"destination\": \"user@ip:/var/www/public/\"\n  }\n}\n```\n\n## Why?\n\nI’ve been using a similar little bash script to deploy things with rsync for a while. Figured should finally package this up since there somehow still seems to be a lack of simple deployment tools for “websites.” This brings some of the ease of deploying to platforms like [netlify](https://www.netlify.com/) or [vercel](https://vercel.com), but without any ecosystem. Works great with traditional php projects, like [kirby](https://getkirby.com/). `git`-based deployment is also cool, but sometimes it’s nice to have them decoupled, to quickly deploy to staging during dev, for example.\n\nProvided as-is, but hopefully you find it useful! 🥂\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjongacnik%2Frploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjongacnik%2Frploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjongacnik%2Frploy/lists"}