HarmonyLite is a distributed SQLite replication system with leaderless architecture and eventual consistency. It enables robust multi-directional replication between nodes using NATS JetStream.
This project is a fork of Marmot, which appears to be no longer maintained.
HarmonyLite continues and extends the vision of Marmot by providing:
- Leaderless, eventually consistent SQLite replication
- Easy horizontal scaling for read-heavy SQLite applications
- Minimal configuration with a modern, maintained codebase
- Enhanced testing and reliability
- Active development and community support
Download the latest release and extract:
tar vxzf harmonylite-v*.tar.gzFrom the extracted directory, run the example cluster:
./examples/run-cluster.shMake changes to one database and watch them propagate:
# Insert data in the first database
sqlite3 /tmp/harmonylite-1.db
> PRAGMA trusted_schema = ON;
> INSERT INTO Books (title, author, publication_year) VALUES ('Project Hail Mary', 'Andy Weir', 2021);
# See it appear in the second database
sqlite3 /tmp/harmonylite-2.db
> SELECT * FROM Books;Unlike other SQLite replication solutions that require a leader-follower architecture, HarmonyLite:
- Has no primary node - any node can write to its local database
- Operates with eventual consistency - no global locking or blocking
- Requires no changes to your existing SQLite application code
- Runs as a sidecar to your existing processes
- Multiple snapshot storage options:
- NATS Blob Storage
- WebDAV
- SFTP
- S3 Compatible (AWS S3, Minio, Blackblaze, SeaweedFS)
- Embedded NATS server
- Log compression for content-heavy applications
- Sleep timeout support for serverless environments
- Comprehensive E2E testing
Future plans for HarmonyLite include:
- Improved documentation and examples
For detailed documentation, see the docs directory.
HarmonyLite is designed for simplicity with minimal configuration. Key command line options:
config- Path to TOML configuration filenode-id- Override node ID from config filecleanup- Clean up hooks and exitsave-snapshot- Create and upload a snapshotcluster-addr- Binding address for clustercluster-peers- Comma-separated list of NATS peersleaf-server- Leaf node connection listversion- Display version information
See config.toml for detailed configuration options.
HarmonyLite includes a comprehensive versioning system that provides detailed information about the build:
# Display version information
./harmonylite -versionThe version information includes:
- Semantic version (based on Git tags)
- Git commit hash
- Git tag (if available)
- Build date and time
- Go version used for building
- Platform information
This helps with troubleshooting and ensures you're using the expected version in your deployment.
- Go 1.24 or later
- SQLite development libraries
make buildThe Makefile automatically injects version information from Git during the build process.
Run the tests:
go run github.com/onsi/ginkgo/v2/ginkgo tests/e2eMIT License - See LICENSE for details.
This project is a fork of Marmot by Zohaib Sibte Hassan. We are grateful for the solid foundation provided by the original project.