Home Explore Blog Models CI



nixpkgs

nixos/modules/services/network-filesystems/litestream/default.md
e940ee0074c070098de7b5954dfd7db05fed6be649609a470000000300000553
# Litestream {#module-services-litestream}

[Litestream](https://litestream.io/) is a standalone streaming
replication tool for SQLite.

## Configuration {#module-services-litestream-configuration}

Litestream service is managed by a dedicated user named `litestream`
which needs permission to the database file. Here's an example config which gives
required permissions to access [grafana database](#opt-services.grafana.settings.database.path):
```nix
{ pkgs, ... }:
{
  users.users.litestream.extraGroups = [ "grafana" ];

  systemd.services.grafana.serviceConfig.ExecStartPost =
    "+"
    + pkgs.writeShellScript "grant-grafana-permissions" ''
      timeout=10

      while [ ! -f /var/lib/grafana/data/grafana.db ];
      do
        if [ "$timeout" == 0 ]; then
          echo "ERROR: Timeout while waiting for /var/lib/grafana/data/grafana.db."
          exit 1
        fi

        sleep 1

        ((timeout--))
      done

      find /var/lib/grafana -type d -exec chmod -v 775 {} \;
      find /var/lib/grafana -type f -exec chmod -v 660 {} \;
    '';

  services.litestream = {
    enable = true;

    environmentFile = "/run/secrets/litestream";

    settings = {
      dbs = [
        {
          path = "/var/lib/grafana/data/grafana.db";
          replicas = [ { url = "s3://mybkt.litestream.io/grafana"; } ];
        }
      ];
    };
  };
}
```

Chunks
b751774f (1st chunk of `nixos/modules/services/network-filesystems/litestream/default.md`)
Title: Litestream Service Configuration and Replication
Summary
This document introduces Litestream, a standalone streaming replication tool for SQLite databases. It details the configuration of the Litestream service, which runs under a dedicated `litestream` user. The configuration example demonstrates how to grant the `litestream` user the necessary permissions to access a Grafana SQLite database (`/var/lib/grafana/data/grafana.db`) by adding the user to the `grafana` group and using a `systemd.services.grafana.serviceConfig.ExecStartPost` script to set appropriate file permissions. The Litestream service is then configured to enable replication of the Grafana database to an S3 bucket.