{"id":33312748,"url":"https://github.com/sqlrsync/client","last_synced_at":"2026-06-13T19:33:08.672Z","repository":{"id":317631411,"uuid":"1046675736","full_name":"sqlrsync/client","owner":"sqlrsync","description":"SQLRsync.com Client","archived":false,"fork":false,"pushed_at":"2025-11-19T05:35:36.000Z","size":18594,"stargazers_count":0,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-19T07:05:23.221Z","etag":null,"topics":["backup","distribution","rsync","sqlite"],"latest_commit_sha":null,"homepage":"https://sqlrsync.com/","language":"C","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/sqlrsync.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-29T03:49:59.000Z","updated_at":"2025-11-19T05:32:15.000Z","dependencies_parsed_at":null,"dependency_job_id":"66c933bf-faa9-4ab8-9d8d-4dd6e6057522","html_url":"https://github.com/sqlrsync/client","commit_stats":null,"previous_names":["sqlrsync/client"],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/sqlrsync/client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqlrsync%2Fclient","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqlrsync%2Fclient/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqlrsync%2Fclient/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqlrsync%2Fclient/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sqlrsync","download_url":"https://codeload.github.com/sqlrsync/client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqlrsync%2Fclient/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34298247,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-13T02:00:06.617Z","response_time":62,"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":["backup","distribution","rsync","sqlite"],"created_at":"2025-11-19T07:04:55.088Z","updated_at":"2026-06-13T19:33:08.659Z","avatar_url":"https://github.com/sqlrsync.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"This project is the client golang application for a wrapper around a statically linked sqlite3_rsync.c file.\n\nsqlite3_rsync allows a guaranteed replication with no-downtime or blocks on the main thread by using the special\nbuild flag SQLITE_ENABLE_DBPAGE_VTAB when sqlite is compiled into the goproject.\n\n## Features:\n- PUSH and PULL rsync of sqlite3 database files to a remote SQLRsync server (defaults to sqlrsync.com)\n- Creates a [`-sqlrsync` file](https://sqlrsync.com/help/dash-sqlrsync) file neighboring the replicated database which can be shared to PULL down the database elsewhere.\n- Stores the PUSH key in ~/.config/sqlrsync/ to allow unattended re-PUSHing of the database (great for a cron job)\n- LOCAL Sync (when sqlrsync is provided 2 arguments, both local file paths) allows for a local-only (no server/network use) rsyncing of a running write-node SQLite database to a running read-only SQLite database with no readlocks.\n- The same mechanism works for PUSH and PULL: the ORIGIN can be a running write-node and the REPLICA can be a running read-only node.  It's pretty magical.\n\n### In PUSH, PULL, or LOCAL mode:\n- Use `--dry` to dry-run the command and see what mode it will trigger, and an explanation of what it will do\n\n\u003e \u003cimg width=\"600\" height=\"157\" alt=\"image\" src=\"https://github.com/user-attachments/assets/1988770e-e79d-473a-bd3b-58815dfd6864\" /\u003e\n\n### When PUSHing:\n- On initial upload you can use the `--public` or `--unlisted` flag to allow others to view the webpage for your database, and optionally download any version of it.\n- Optionally include a commit message (`--message` or `-m`) to keep track of your changes\n\n### When PULLing:\n- You can append an `@` sign and a version reference to download old versions of the database.  For example:\n```\nsqlrsync oregon/elections.db           # Pulls down the latest version\nsqlrsync oregon/elections.db@1         # Pulls down the first version\nsqlrsync oregon/elections.db@latest-2  # Goes backwards 2 versions from the latest\n```\n\n\u003e  \u003cimg width=\"553\" height=\"74\" alt=\"image\" src=\"https://github.com/user-attachments/assets/1a6608d0-0d66-4801-be98-06ce158f8e6f\" /\u003e\n\n### Authentication and Authorization\n\nThere are 3 types of keys used by SQLRsync:\n- Account Admin: Allows the creation of a new Database on REMOTE or PULLing any replica on the account \n- Replica Pull: Allows creating a local copy of any version of a specific existing Database on REMOTE to a local file\n- Replica Push: Allows the creation of a new version of a specific existing Database on REMOTE\n\nAccount Admin keys are never stored locally, and are always interactively prompted or provided as a command line argument.\n\nIf you use an Account Admin key, the server will reply with a new replica-specific Pull key (and Push token if you use an Account Create key). The pull key is stored adjacent to the replicated database in a file ending with the suffix `-sqlrsync`, along with other data.  (For a database at /tmp/my-data.sqlite, the pull key would be stored in /tmp/my-data.sqlite-sqlrsync)\n\nThe more sensitive Replica Push key is stored in ~/.config/sqlrsync/local-secrets.toml and subsequent pushes will use that key.\n\n## Technical Details and Contributing Guidelines\n\nWe're using CGO to directly call into sqlite_rsync.c to use the algorithm explicitly how the sqlite team\nimplemented the rsync function, however our API uses websockets to communicate between local and remote.\n\n### Building\n\n```\ncd sqlite; make build\ncd ../bridge; make build\ncd ../client; make build\n```\n\n### Pre-compiled Binaries\n\nPre-compiled binaries for various platforms are available in the [releases](https://github.com/sqlrsync/client/releases) section of the GitHub repository.\n\n- Mac (since 2020): sqlrsync-darwin-arm64\n- Mac (before 2020): sqlrsync-darwin-amd64\n- Linux: sqlrsync-linux-amd64\n- Windows: sqlrsync-windows-amd64.exe\n\n### Running\n\nRun ./bin/sqlrsync \u003cparams\u003e\n\n### Application Logic and Settings\n\nBy default, REMOTE is SQLRsync.com Version Controlled Storage\n\n### Stored Settings\n\nSettings and defaults are stored in your user directory at ~/.config/sqlrsync. Within that directory, there are two files:\n\n1. defaults.toml\n   Contains default settings for all sqlrsync databases, like server URL, public/private, to generate a new unique clientSideEncryptionKey\n```toml\n# An example ~/.config/defaults.toml\n[defaults]\nserver = \"wss://sqlrsync.com\"\n```\n\n2. local-secrets.toml\n   Contains this-machine-specific settings, including the path to the local SQLite files, push keys, and encryption keys.\n\n```toml\n# An example ~/.config/local-secrets.toml\n[local]\n# When a new SQLRsync Replica is created on the server, we can use this prefix to identify this machine\nhostname = \"homelab3\"\ndefaultClientSideEncryptionKey = \"riot-camel-pass-flash-cereal-journey\"\n\n[[sqlrsync-databases]]\npath = \"/home/matt/webapps/hedgedoc/data/data.db\"\nreplicaID = \"AJK928AK02jidsJA1\"\nprivate-push-key = \"abcd1234abcd1234\"\nclientSideEncryptionKey = \"riot-camel-pass-flash-cereal-journey\"\nlastUpdated = \"2023-01-01T00:00:00Z\"\nserver = \"wss://s9.sqlrsync.com\"\n\n[[sqlrsync-databases]]\npath = \"/home/matt/webapps/wikijs/data/another.db\"\nprivate-push-key = \"efgh5678efgh5678\"\nlastUpdated = \"2023-01-01T00:00:00Z\"\nclientSideEncryptionKey = \"riot-camel-pass-flash-cereal-journey\"\nserver = \"wss://sqlrsync.com\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsqlrsync%2Fclient","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsqlrsync%2Fclient","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsqlrsync%2Fclient/lists"}