Litestream
  • Twitter
  • GitHub
  • Install
  • Guides
  • Reference
  • GitHub
  • Slack
v0.5.x - Latest - Actively maintained with new features and bug fixes| View v0.3.13 (Previous)

Install

  • macOS
  • Linux
  • Build from Source

General

  • Getting Started
  • Tips & Caveats
  • How it works
  • Read Replicas with VFS
  • Alternatives

Infrastructure Guides

  • Running in a Docker container
  • Running in a Kubernetes cluster
  • Running as a Systemd service
  • Running as a Windows Service
  • Directory Watcher

Replica Guides

  • Global Replica Defaults
  • Replicating to Amazon S3
  • AWS SDK v2 Migration
  • Replicating to Alibaba Cloud OSS
  • S3 Advanced Configuration
  • VFS Read Replicas
  • Replicating to Azure Blob Storage
  • Replicating to S3-Compatible Services
  • Replicating to Backblaze B2
  • Replicating to DigitalOcean Spaces
  • Replicating to Scaleway Object Storage
  • Replicating to Tigris (Fly.io)
  • Replicating to Google Cloud Storage
  • Replicating to Linode Object Storage
  • Replicating to an SFTP Server
  • Replicating to a Local File Path
  • Replicating to NATS JetStream
  • Replicating Directories
  • Replicating to a WebDAV Server

Help

  • Migration Guide
  • WAL Truncate Threshold Configuration
  • Troubleshooting

Reference

  • Configuration File
  • Command: databases
  • Command: mcp
  • Command: replicate
  • Command: ltx
  • Command: restore
  • VFS Extension
  • Command: version
  • Command: wal

On this page

  • Installation

macOS

Installation#

A Homebrew tap to is provided to install Litestream in a single command. After installing Homebrew, run:

brew install benbjohnson/litestream/litestream

You should now be able to run litestream version to verify it is installed.

Linux →