github.com/benbjohnson/litestream

Platform Support

⚠️ Windows Notice: Windows binaries are provided for convenience but Windows is NOT an officially supported platform. Use at your own risk. Community contributions for Windows improvements are welcome.

✅ Supported Platforms: Linux (amd64, arm64, armv6, armv7), macOS (amd64, arm64)

Installation

Homebrew (macOS and Linux)

brew tap benbjohnson/litestream
brew install litestream

Debian/Ubuntu

Download the .deb file for your architecture and install:

sudo dpkg -i litestream-*.deb

RPM-based systems

Download the .rpm file for your architecture and install:

sudo rpm -i litestream-*.rpm

Binary installation

Download the appropriate archive for your platform, extract, and move to your PATH.

VFS Extension (Experimental)

SQLite loadable extensions for read-only access to Litestream replicas are available for supported platforms:

Install via package managers:

pip install litestream-vfs    # Python
npm install litestream-vfs    # Node.js
gem install litestream-vfs    # Ruby

Changelog

• ad0c7b7 chore(deps): bump grpc for govulncheck (#1401)
• 0427915 chore(deps): bump sqlite3vfs upstream (#1359)
• 6d61ef5 chore(deps): bump superfly/ltx to v0.5.2 (#1422)
• 2d7ebf1 chore(deps): bump x/text and otel for govulncheck (#1399)
• 904a307 docs(security): document private vulnerability reporting (#1398)
• 764dcea feat(cli): print proper version string on dev builds (#1338)
• b308bd3 fix(ci): stabilize nightly workflow (#1396)
• 794ca47 fix(cli): honor part-size and concurrency replica URL params (#1330)
• 9d5488f fix(cli): show one replica URL in usage (#1356)
• d0a74b4 fix(config): detect Hetzner endpoints (#1357)
• 599ddcb fix(db): make SnapshotReader closeable (#1346)
• 77a322b fix(db): retain truncate backstop at zero (#1348)
• 0af69c7 fix(db): skip repeated passive before truncate (#1347)
• 4bae662 fix(nats): apply TLS replica options (#1362)
• 59c1b25 fix(nats): propagate object store init errors (#1361)
• 3ad668b fix(replica): bound resumable reader retries (#1360)
• 11b050e fix(replica): drain limited sync batches (#1345)
• eeba874 fix(replica): fsync directory after durable renames (#1344)
• 00a17c4 fix(s3): exclude accept encoding for GCS (#1394)
• 2c1d70b perf(s3): single PutObject for small ltx objects (#1328)

Platform Support

⚠️ Windows Notice: Windows binaries are provided for convenience but Windows is NOT an officially supported platform. Use at your own risk. Community contributions for Windows improvements are welcome.

✅ Supported Platforms: Linux (amd64, arm64, armv6, armv7), macOS (amd64, arm64)

Installation

Homebrew (macOS and Linux)

brew tap benbjohnson/litestream
brew install litestream

Debian/Ubuntu

Download the .deb file for your architecture and install:

sudo dpkg -i litestream-*.deb

RPM-based systems

Download the .rpm file for your architecture and install:

sudo rpm -i litestream-*.rpm

Binary installation

Download the appropriate archive for your platform, extract, and move to your PATH.

VFS Extension (Experimental)

SQLite loadable extensions for read-only access to Litestream replicas are available for supported platforms:

Install via package managers:

pip install litestream-vfs    # Python
npm install litestream-vfs    # Node.js
gem install litestream-vfs    # Ruby

Changelog

• d1dad70 fix(db): bound sync executor work (#1290)
• d26cb54 fix(db): harden checkpoint snapshots (#1292)
• 4e3f0c0 fix(db): surface disk-full staging errors (#1322)
• c96c0f4 fix(security): bump Go 1.25.12 + deps to clear govulncheck (#1341)
• ba448ca fix(sync): bound replica sync waits (#1291)
• 9ca1201 fix(sync): fix SnapshotReader goroutine race and fsync ordering (#1166)
• 69e9b9e test(integration): add replicate restore soak test (#1302)

Platform Support

⚠️ Windows Notice: Windows binaries are provided for convenience but Windows is NOT an officially supported platform. Use at your own risk. Community contributions for Windows improvements are welcome.

✅ Supported Platforms: Linux (amd64, arm64, armv6, armv7), macOS (amd64, arm64)

Installation

Homebrew (macOS and Linux)

brew tap benbjohnson/litestream
brew install litestream

Debian/Ubuntu

Download the .deb file for your architecture and install:

sudo dpkg -i litestream-*.deb

RPM-based systems

Download the .rpm file for your architecture and install:

sudo rpm -i litestream-*.rpm

Binary installation

Download the appropriate archive for your platform, extract, and move to your PATH.

VFS Extension (Experimental)

SQLite loadable extensions for read-only access to Litestream replicas are available for supported platforms:

Install via package managers:

pip install litestream-vfs    # Python
npm install litestream-vfs    # Node.js
gem install litestream-vfs    # Ruby

Changelog

• 6c85477 feat(s3): add storage class option (#1321)
• bffb888 fix(compaction): resume remote source reads (#1326)
• 71a1b37 fix(config): respect explicit replica type (#1319)
• 2b34013 fix(retention): retain prior snapshot txid (#1325)
• 64cb695 fix(s3): keep retrying through sustained transport flaps (#1305)
• 9bbc255 fix(sftp): write ltx files atomically (#1320)

Platform Support

⚠️ Windows Notice: Windows binaries are provided for convenience but Windows is NOT an officially supported platform. Use at your own risk. Community contributions for Windows improvements are welcome.

✅ Supported Platforms: Linux (amd64, arm64, armv6, armv7), macOS (amd64, arm64)

Installation

Homebrew (macOS and Linux)

brew tap benbjohnson/litestream
brew install litestream

Debian/Ubuntu

Download the .deb file for your architecture and install:

sudo dpkg -i litestream-*.deb

RPM-based systems

Download the .rpm file for your architecture and install:

sudo rpm -i litestream-*.rpm

Binary installation

Download the appropriate archive for your platform, extract, and move to your PATH.

VFS Extension (Experimental)

SQLite loadable extensions for read-only access to Litestream replicas are available for supported platforms:

Install via package managers:

pip install litestream-vfs    # Python
npm install litestream-vfs    # Node.js
gem install litestream-vfs    # Ruby

Changelog

• c30c5ff Revert "refactor(db): split sync executor lifecycle (#1289)" (#1313)
• 0a2a39f feat(config): add meta-dir for directory dbs (#1315)
• f8b7c60 fix(security): bump Go toolchain to 1.25.11 to clear govulncheck (#1304)
• 53e155d refactor(db): split sync executor lifecycle (#1289)
• 32c7929 refactor(db): split sync executor lifecycle (#1314)

Platform Support

⚠️ Windows Notice: Windows binaries are provided for convenience but Windows is NOT an officially supported platform. Use at your own risk. Community contributions for Windows improvements are welcome.

✅ Supported Platforms: Linux (amd64, arm64, armv6, armv7), macOS (amd64, arm64)

Installation

Homebrew (macOS and Linux)

brew tap benbjohnson/litestream
brew install litestream

Debian/Ubuntu

Download the .deb file for your architecture and install:

sudo dpkg -i litestream-*.deb

RPM-based systems

Download the .rpm file for your architecture and install:

sudo rpm -i litestream-*.rpm

Binary installation

Download the appropriate archive for your platform, extract, and move to your PATH.

VFS Extension (Experimental)

SQLite loadable extensions for read-only access to Litestream replicas are available for supported platforms:

Install via package managers:

pip install litestream-vfs    # Python
npm install litestream-vfs    # Node.js
gem install litestream-vfs    # Ruby

Changelog

• 817ebb0 docs(cli): add databases help examples (#1243)
• e266164 docs(cli): add info help examples (#1242)
• 265be76 docs(cli): add list help examples (#1241)
• 3a9df4b docs(cli): add register help examples (#1237)
• 739312f docs(cli): add start stop help examples (#1239)
• 5bd5ca3 docs(cli): add status help examples (#1246)
• 72d7533 docs(cli): add sync help examples (#1240)
• 7c63954 docs(cli): add unregister help examples (#1238)
• d932bc0 docs(cli): document json output schemas (#1250)
• 2e8c73a feat(cli): add databases json output (#1247)
• eeb3801 feat(cli): add ltx json output (#1248)
• 2d38d20 feat(cli): add register success payload (#1255)
• 8aa7945 feat(cli): add reset dry run (#1252)
• fbe1739 feat(cli): add restore dry run (#1251)
• 30c039f feat(cli): add restore json output (#1249)
• 64e8757 feat(cli): add start stop success payload (#1256)
• 19d6064 feat(cli): add status json output (#1245)
• a08a5e7 feat(cli): add sync success payload (#1257)
• fd4b600 feat(cli): add unregister dry run (#1253)
• dd59010 feat(cli): add unregister success payload (#1258)
• 552672f feat(cli): guard restore overwrites (#1254)
• 0de07a3 feat(db): expose sync diagnostics (#1287)
• 9cc2f2d fix(build): bump Go toolchain to 1.25.9 for stdlib vulns (#1235)
• 6ebcacc fix(cli): add try hints for required flags (#1236)
• dbcd1a0 fix(cli): clarify register idempotency (#1259)
• 8e9b907 fix(cli): clarify unregister idempotency (#1261)
• fc050c9 fix(cli): exit 0 for explicit help (#1233)
• 853cbf3 fix(cli): make start stop idempotent (#1260)
• 4784cc9 fix(cli): polish agent-facing errors (#1297)
• edc4328 fix(compactor): close pipe on upload failure (#1286)
• c32f63c fix(config): honor database snapshot settings (#1285)
• 4cb2d7c fix(deps): bump x/crypto and x/net to clear govulncheck (#1294)
• a590e05 fix(restore): check for wal segment gaps in v3 restore (#1230)
• c28a318 fix(restore): clean failed restore temp file (#1282)
• d4c00e3 fix(restore): retry initial ltx opens (#1284)
• a25a11f fix(security): bump Go 1.25.10 + deps to clear govulncheck (#1283)
• 6b8bb01 refactor(db): return sync results explicitly (#1224)
• 0c670da test(cli): drop static-string usage tests, restore captureStdout helper (#1295)

Platform Support

⚠️ Windows Notice: Windows binaries are provided for convenience but Windows is NOT an officially supported platform. Use at your own risk. Community contributions for Windows improvements are welcome.

✅ Supported Platforms: Linux (amd64, arm64, armv6, armv7), macOS (amd64, arm64)

Installation

Homebrew (macOS and Linux)

brew tap benbjohnson/litestream
brew install litestream

Debian/Ubuntu

Download the .deb file for your architecture and install:

sudo dpkg -i litestream-*.deb

RPM-based systems

Download the .rpm file for your architecture and install:

sudo rpm -i litestream-*.rpm

Binary installation

Download the appropriate archive for your platform, extract, and move to your PATH.

VFS Extension (Experimental)

SQLite loadable extensions for read-only access to Litestream replicas are available for supported platforms:

Install via package managers:

pip install litestream-vfs    # Python
npm install litestream-vfs    # Node.js
gem install litestream-vfs    # Ruby

Changelog

• ad55ec1 feat(ci): add nightly stability CI, LTX behavioral tests, and release gating (#1195)
• 13ef323 feat(logging): add tint pretty handler, optional source info, and path cleaning (#1204)
• 1678a9b fix(ci): dedupe nightly stability issues (#1217)
• d65fa36 fix(cmd): add helpful hint when 'litestream start' is run without args (#1208)
• 4cb0f8c fix(db): wrap raw errors with LTXError in paths reaching replica monitor (#1227)
• 5780f4d fix(replica): wrap missing LTX file error with LTXError in uploadLTXFile (#1225)
• 016c368 fix(restore): fix v3 restore (#1229)

Platform Support

⚠️ Windows Notice: Windows binaries are provided for convenience but Windows is NOT an officially supported platform. Use at your own risk. Community contributions for Windows improvements are welcome.

✅ Supported Platforms: Linux (amd64, arm64, armv6, armv7), macOS (amd64, arm64)

Installation

Homebrew (macOS and Linux)

brew tap benbjohnson/litestream
brew install litestream

Debian/Ubuntu

Download the .deb file for your architecture and install:

sudo dpkg -i litestream-*.deb

RPM-based systems

Download the .rpm file for your architecture and install:

sudo rpm -i litestream-*.rpm

Binary installation

Download the appropriate archive for your platform, extract, and move to your PATH.

VFS Extension (Experimental)

SQLite loadable extensions for read-only access to Litestream replicas are available for supported platforms:

Install via package managers:

pip install litestream-vfs    # Python
npm install litestream-vfs    # Node.js
gem install litestream-vfs    # Ruby

Changelog

• 5531fab Revert "fix(db): add warning log and test for WAL change detection (#946)" (#1187)
• ab55194 Revert "fix(db): detect WAL changes via shm mxFrame (#1087)" (#1185)
• 40af24a ci(pr-metrics): add PR build metrics workflow (#1158)
• f404f2f ci(pr-metrics): replace collapsible sections with plain headers (#1184)
• ae88b16 feat(logging): add .With() system identifiers to all top-level loggers (#1191)
• 2d5f628 feat(restore): add crash recovery txid file for follow mode (#1136)
• f6ba05f feat(restore): add post-restore integrity validation (#1170)
• 1345ed7 feat(vfs): distribute VFS extension via PyPI, npm, and RubyGems (#1148)
• 1f423d7 fix(ci): publish latest-scratch Docker tag (#1180)
• 166cbe3 fix(deps): bump Go to 1.25.0/toolchain 1.25.8 for security patches (#1188)
• d514bc7 fix(logging): use db.Logger and s.Logger instead of default slog in Store (#1181)
• 6843423 fix(replica): promote LTX upload log to Info level with size field (#1182)
• e8b2ada fix(security): upgrade Go toolchain to 1.24.13 (#1162)
• 0b3facd fix(test): resolve 4 failing tests on main (#1156)
• 038b296 fix(vfs): coordinate expectedTXID across pooled write connections (#1140)
• bd2c6e6 perf(db): cache Pos() result to avoid repeated disk reads (#1192)
• 80b1b3b test(profile): add idle CPU profiling test (#1190)

Platform Support

⚠️ Windows Notice: Windows binaries are provided for convenience but Windows is NOT an officially supported platform. Use at your own risk. Community contributions for Windows improvements are welcome.

✅ Supported Platforms: Linux (amd64, arm64, armv6, armv7), macOS (amd64, arm64)

Installation

Homebrew (macOS and Linux)

brew tap benbjohnson/litestream
brew install litestream

Debian/Ubuntu

Download the .deb file for your architecture and install:

sudo dpkg -i litestream-*.deb

RPM-based systems

Download the .rpm file for your architecture and install:

sudo rpm -i litestream-*.rpm

Binary installation

Download the appropriate archive for your platform, extract, and move to your PATH.

VFS Extension (Experimental)

SQLite loadable extensions for read-only access to Litestream replicas are available for supported platforms:

Changelog

• 3a67f13 Add cross-version upgrade integration test (v0.3.x → v0.5.x) (#1137)
• 5b8a7d1 add Hetzner S3 signed-payload preset (#1026)
• 249f46d ci: enable automatic Homebrew tap updates on release (#1117)
• 09c2313 docs(agent): update replica-client-developer with v0.3.x and ResumableReader (#1112)
• 84a5d31 docs(agents): add IPC, leasing, library API, and retention references (#1107)
• 5e6a91c docs(architecture): add IPC server, distributed leasing, and library API (#1108)
• c835786 docs(claude): add debug-ipc command and provider compatibility reference (#1116)
• 23f8b5a docs(command): add IPC, retention, and v0.3.x issues to fix-common-issues (#1113)
• 6bcedb2 docs(command): add debug-ipc command for IPC socket troubleshooting (#1114)
• b2980bd docs(patterns): add ResumableReader, retention bypass, and conditional write patterns (#1109)
• 0f80b4d docs(provider-compat): update R2 detection defaults and version compat (#1111)
• d4130d5 docs(replica-client): add v0.3.x restore interface and ResumableReader note (#1110)
• d87d657 feat(docker): add hardened scratch-based image variant (#1126)
• 020da8e feat(ipc): add sync command for on-demand database replication (#1120)
• 0df6829 feat(restore): add -f follow mode for continuous restore (#1102)
• aa81289 feat(s3): add LITESTREAM_S3_ENDPOINT env var for URL-based restore (#1145)
• 70bb846 feat(s3): add Supabase S3-compatible provider auto-detection (#1135)
• 61a2def feat(sync): add replicated_txid to sync response (#1141)
• fe7fb7a feat(vfs): add PRAGMA litestream_write_enabled for runtime write control (#1009)
• 95253c4 fix(ci): authenticate GitHub API call in NATS test setup (#1144)
• 155507b fix(db): count sync errors when db.init() fails (#1129)
• 48ecd53 fix(db): detect WAL changes via shm mxFrame (#1087)
• 634c74f fix(restore): expose -follow-interval CLI flag for follow mode (#1139)
• 47e9010 fix(vfs): persist hydration file across connection restarts (#1125)
• 0ad19ff test(ci): add smoke tests for hardened scratch Docker image (#1132)
• a404d7b test(metrics): add coverage for all Prometheus metrics (#1127)

Platform Support

⚠️ Windows Notice: Windows binaries are provided for convenience but Windows is NOT an officially supported platform. Use at your own risk. Community contributions for Windows improvements are welcome.

✅ Supported Platforms: Linux (amd64, arm64, armv6, armv7), macOS (amd64, arm64)

Installation

Homebrew (macOS and Linux)

brew tap benbjohnson/litestream
brew install litestream

Debian/Ubuntu

Download the .deb file for your architecture and install:

sudo dpkg -i litestream-*.deb

RPM-based systems

Download the .rpm file for your architecture and install:

sudo rpm -i litestream-*.rpm

Binary installation

Download the appropriate archive for your platform, extract, and move to your PATH.

VFS Extension (Experimental)

SQLite loadable extensions for read-only access to Litestream replicas are available for supported platforms:

Changelog

• b2d8145 Stream restore plan selection across levels (#1076)
• 2172ff2 docs(ai): add litestream reset and auto-recover to AI docs (#1091)
• 7d2b369 feat(db): add SyncStatus, SyncAndWait, and EnsureExists for library usage (#1092)
• 7e12162 feat(ipc): add dynamic database management commands (register/unregister) (#1021)
• bab4fd4 feat(ipc): add list and info query commands with lastSyncAt (#1015)
• e0370ba feat(ltx): add -level flag to view LTX files at any compaction level (#1072)
• 7265b6b feat(retention): add skip-remote-deletion for cloud-managed retention (#1094)
• 44b65e2 feat(s3): add R2 concurrency default, multipart threshold test, fix docs (#1100)
• 90fc5b6 feat(s3): add distributed leasing with If-Match conditional writes (#1073)
• c194e86 feat(tls): add x509roots/fallback for embedded root CA bundle (#1099)
• ff1c063 feat: add agent skill for cross-platform LLM agent support (#1064)
• c32f6c8 fix(compactor): add mutex to protect Compactor.client from concurrent access (#1086)
• cfe03fc fix(dir-watch): prevent thundering herd at startup with many databases (#1055)
• 4800f27 fix(restore): resume S3 streams on drop (#1082)
• 3358c8c fix(s3): add hyphenated URL query param aliases for consistency (#1101)
• 1d602ea fix(shutdown): allow second Ctrl+C to interrupt shutdown sync retry loop (#998)
• c16755d test(db): add regression test for #994 runaway disk usage (#1088)
• 68dadcf test(db): prove SQLite writes all new pages to WAL during DB growth (#1103)