summaryrefslogtreecommitdiffstats
path: root/nixos/modules/services/databases/tigerbeetle.md
diff options
context:
space:
mode:
Diffstat (limited to 'nixos/modules/services/databases/tigerbeetle.md')
-rw-r--r--nixos/modules/services/databases/tigerbeetle.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/nixos/modules/services/databases/tigerbeetle.md b/nixos/modules/services/databases/tigerbeetle.md
index ed05c982350d..12d920e7bcc7 100644
--- a/nixos/modules/services/databases/tigerbeetle.md
+++ b/nixos/modules/services/databases/tigerbeetle.md
@@ -8,7 +8,9 @@ TigerBeetle is a distributed financial accounting database designed for mission
To enable TigerBeetle, add the following to your {file}`configuration.nix`:
```nix
+{
services.tigerbeetle.enable = true;
+}
```
When first started, the TigerBeetle service will create its data file at {file}`/var/lib/tigerbeetle` unless the file already exists, in which case it will just use the existing file.
@@ -21,12 +23,14 @@ To configure it to listen on a different interface (and to configure it to conne
Note that the TigerBeetle module won't open any firewall ports automatically, so if you configure it to listen on an external interface, you'll need to ensure that connections can reach it:
```nix
+{
services.tigerbeetle = {
enable = true;
addresses = [ "0.0.0.0:3001" ];
};
networking.firewall.allowedTCPPorts = [ 3001 ];
+}
```
A complete list of options for TigerBeetle can be found [here](#opt-services.tigerbeetle.enable).