about summary refs log tree commit diff stats
path: root/docs/running.md
blob: 8310c99918ebf799ca8742c55f80ef3553e639ec (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# Running an instance

## Requirements:

-   400MiB disk space
-   <100MiB RAM

This [repository](https://git.alanpearce.eu/searchix) (or its [sourcehut mirror](https://git.sr.ht/~alanpearce/searchix)) is importable as a flake containing a NixOS module.

```nix
{
  inputs.searchix.url = "git+https://git.alanpearce.eu/searchix";
  # or
  inputs.searchix.url = "sourcehut:~alanpearce/searchix";

  outputs = { self, nixpkgs, searchix }: {
    nixosConfigurations.<hostname> = nixpkgs.lib.nixosSystem {
      modules = [
        searchix.modules.web
      ];
    };
  };
}
```

This will then expose the following schema:

```nix
services.searchix = {
  enable = true;
# user = "searchix";
# group = "searchix";
# homeDir = "/var/lib/searchix";
# settings = {
#   web = {
#     port = 51313;
#     listenAddress = "localhost";
#     baseURL = "http://localhost:51313";
#   };
# };
};
```

Where `settings` complies with [NixOS RFC 42 (settings options)](https://github.com/NixOS/rfcs/pull/42); see the [default values](../defaults.toml) for reference.