{"id":15451988,"url":"https://github.com/schollz/patchitup-encrypted","last_synced_at":"2025-03-28T09:24:34.064Z","repository":{"id":144292290,"uuid":"123007114","full_name":"schollz/patchitup-encrypted","owner":"schollz","description":"Backup your file to your remote server using minimum bandwidth (with encryption).","archived":false,"fork":false,"pushed_at":"2018-02-26T20:58:45.000Z","size":1504,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-25T05:33:59.160Z","etag":null,"topics":["cloud-storage","encryption","golang-library","patching","server"],"latest_commit_sha":null,"homepage":null,"language":"Go","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/schollz.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-02-26T17:55:32.000Z","updated_at":"2025-02-17T09:07:03.000Z","dependencies_parsed_at":null,"dependency_job_id":"72149db3-5091-40eb-af0d-a77b0c993b66","html_url":"https://github.com/schollz/patchitup-encrypted","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schollz%2Fpatchitup-encrypted","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schollz%2Fpatchitup-encrypted/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schollz%2Fpatchitup-encrypted/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schollz%2Fpatchitup-encrypted/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/schollz","download_url":"https://codeload.github.com/schollz/patchitup-encrypted/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246000691,"owners_count":20707767,"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","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":["cloud-storage","encryption","golang-library","patching","server"],"created_at":"2024-10-01T21:40:42.303Z","updated_at":"2025-03-28T09:24:34.045Z","avatar_url":"https://github.com/schollz.png","language":"Go","funding_links":["https://www.paypal.me/ZackScholl/5.00"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003cimg\n    src=\"https://raw.githubusercontent.com/schollz/patchitup-encrypted/master/.github/logo.png\"\n    width=\"260px\" border=\"0\" alt=\"patchitup-encrypted\"\u003e\n\u003cbr\u003e\n\u003ca href=\"https://github.com/schollz/patchitup-encrypted/releases/latest\"\u003e\u003cimg src=\"https://img.shields.io/badge/version-0.1.0-brightgreen.svg?style=flat-square\" alt=\"Version\"\u003e\u003c/a\u003e\n\u003ca href=\"https://godoc.org/github.com/schollz/patchitup-encrypted/patchitup\"\u003e\u003cimg src=\"https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square\" alt=\"Code Coverage\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.paypal.me/ZackScholl/5.00\"\u003e\u003cimg src=\"https://img.shields.io/badge/donate-$5-brown.svg?style=flat-square\" alt=\"Donate\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003eBackup your file to a cloud server using minimum bandwidth.\u003c/p\u003e\n\n*patchitup-encrypted* is a way to keep the cloud up-to-date through incremental patches. In a nutshell, this is a pure-Golang library and a CLI tool for creating a client+server that exchange incremental encrypted and compressed patches to overwrite a remote copy to keep it up-to-date with the client's local file. The files on the server stay encrypted so that only the client ever has access to them.\n\n\u003cem\u003e\u003cstrong\u003eWhy?\u003c/strong\u003e\u003c/em\u003e I wrote this program to reduce the bandwidth usage when backing up SQLite databases to a remote server from Raspberry Pis. I have deployed some software on Raspberry Pis that periodically [dumps the database to SQL text](http://www.sqlitetutorial.net/sqlite-dump/). Since Raspberry Pi's can die sometimes, I want to keep their data stored remotely. As the databases can get fairly large, a patch from SQL text will only ever be the changed/new records. *patchitup-encrypted* allows the client to just send to the cloud only the changed/new records and still maintain the exact copy on the cloud. This can massively reduce bandwidth between the client and the cloud. \n\n\u003cem\u003e\u003cstrong\u003eWhy not git?\u003c/strong\u003e\u003c/em\u003e While *git* basically  does this already, its not terribly easy to setup a *git* server to support multiple users (though [gitolite](https://github.com/sitaramc/gitolite) does a great job of simplifying the process).  Also, most of the features of *git* are not necessary for my use-case.\n\n_Note: this is an encrypted version of [github.com/schollz/patchitup](https://github.com/schollz/patchitup)._\n\n# Quickstart\n\nIn addition to being a Golang library, the *patchitup-encrypted* is a server+client. To try it, first install *patchitup-encrypted* with Go:\n\n```\n$ go install -u -v github.com/schollz/patchitup-encrypted/...\n```\n\nThen start a *patchitup-encrypted* server:\n\n```\n$ patchitup-encrypted -host\nRunning at http://0.0.0.0:8002\n```\n\nThen you can patch a file:\n\n```\n$ patchitup-encrypted -s http://localhost:8002 -f SOMEFILE\n2018-02-23 08:56:44 [INFO] patched 2.4 kB (62.8%) to remote 'SOMEFILE' for 'yourpublickey'\n\n$ vim SOMEFILE # make some edits\n\n$ patchitup-encrypted -s http://localhost:8002 -f SOMEFILE\n2018-02-23 08:57:40 [INFO] patched 408 B (9.9%) to remote 'SOMEFILE' for 'yourpublickey'\n```\n\nThe first time you patch will basically just send up the gzipped file. Subsequent edits will just send up the patches. The percentage (e.g. `9.9%`) specifies the percentage of the entire file size that is being sent (to get an idea of bandwidth savings). The server also will log bandwidth usage.\n\n# Roadmap\n\nI would love PRs.\n\nSome ideas I'd like to add:\n\n- [x] Built-in security (authentication tokens?)\n- [x] Encryption option (to keep data on server private)\n- [ ] Allow -rebuild to output to file\n\n# License\n\nMIT\n\n# Thanks\n\nLogo designed by \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://www.vecteezy.com\"\u003ewww.Vecteezy.com\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschollz%2Fpatchitup-encrypted","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fschollz%2Fpatchitup-encrypted","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschollz%2Fpatchitup-encrypted/lists"}