Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/schollz/patchitup-encrypted
Backup your file to your remote server using minimum bandwidth (with encryption).
https://github.com/schollz/patchitup-encrypted
cloud-storage encryption golang-library patching server
Last synced: 20 days ago
JSON representation
Backup your file to your remote server using minimum bandwidth (with encryption).
- Host: GitHub
- URL: https://github.com/schollz/patchitup-encrypted
- Owner: schollz
- License: mit
- Created: 2018-02-26T17:55:32.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-02-26T20:58:45.000Z (over 6 years ago)
- Last Synced: 2024-10-08T00:17:02.800Z (about 1 month ago)
- Topics: cloud-storage, encryption, golang-library, patching, server
- Language: Go
- Size: 1.43 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Backup your file to a cloud server using minimum bandwidth.
*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.
Why? 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.
Why not git? 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.
_Note: this is an encrypted version of [github.com/schollz/patchitup](https://github.com/schollz/patchitup)._
# Quickstart
In addition to being a Golang library, the *patchitup-encrypted* is a server+client. To try it, first install *patchitup-encrypted* with Go:
```
$ go install -u -v github.com/schollz/patchitup-encrypted/...
```
Then start a *patchitup-encrypted* server:
```
$ patchitup-encrypted -host
Running at http://0.0.0.0:8002
```
Then you can patch a file:
```
$ patchitup-encrypted -s http://localhost:8002 -f SOMEFILE
2018-02-23 08:56:44 [INFO] patched 2.4 kB (62.8%) to remote 'SOMEFILE' for 'yourpublickey'
$ vim SOMEFILE # make some edits
$ patchitup-encrypted -s http://localhost:8002 -f SOMEFILE
2018-02-23 08:57:40 [INFO] patched 408 B (9.9%) to remote 'SOMEFILE' for 'yourpublickey'
```
The 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.
# Roadmap
I would love PRs.
Some ideas I'd like to add:
- [x] Built-in security (authentication tokens?)
- [x] Encryption option (to keep data on server private)
- [ ] Allow -rebuild to output to file
# License
MIT
# Thanks
Logo designed by www.Vecteezy.com