nixos/preload: init
[NixPkgs.git] / nixos / modules / services / network-filesystems / litestream / default.md
blob8d8486507b77e8c4266dff18c751230ce9d1794c
1 # Litestream {#module-services-litestream}
3 [Litestream](https://litestream.io/) is a standalone streaming
4 replication tool for SQLite.
6 ## Configuration {#module-services-litestream-configuration}
8 Litestream service is managed by a dedicated user named `litestream`
9 which needs permission to the database file. Here's an example config which gives
10 required permissions to access [grafana database](#opt-services.grafana.settings.database.path):
11 ```
12 { pkgs, ... }:
14   users.users.litestream.extraGroups = [ "grafana" ];
16   systemd.services.grafana.serviceConfig.ExecStartPost = "+" + pkgs.writeShellScript "grant-grafana-permissions" ''
17     timeout=10
19     while [ ! -f /var/lib/grafana/data/grafana.db ];
20     do
21       if [ "$timeout" == 0 ]; then
22         echo "ERROR: Timeout while waiting for /var/lib/grafana/data/grafana.db."
23         exit 1
24       fi
26       sleep 1
28       ((timeout--))
29     done
31     find /var/lib/grafana -type d -exec chmod -v 775 {} \;
32     find /var/lib/grafana -type f -exec chmod -v 660 {} \;
33   '';
35   services.litestream = {
36     enable = true;
38     environmentFile = "/run/secrets/litestream";
40     settings = {
41       dbs = [
42         {
43           path = "/var/lib/grafana/data/grafana.db";
44           replicas = [{
45             url = "s3://mybkt.litestream.io/grafana";
46           }];
47         }
48       ];
49     };
50   };
52 ```