blob: c316d074cbaab96fdf07e3f80f5b1866da5221a0 (
plain) (
blame)
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
{ config
, pkgs
, lib
, ...
}:
let
cfg = config.services.silverbullet;
defaultUser = "silverbullet";
defaultGroup = defaultUser;
defaultSpaceDir = "/var/lib/silverbullet";
in
{
options = {
services.silverbullet = {
enable = lib.mkEnableOption "Silverbullet, an open-source, self-hosted, offline-capable Personal Knowledge Management (PKM) web application.";
package = lib.mkPackageOptionMD pkgs "silverbullet" { };
openFirewall = lib.mkOption {
type = lib.types.bool;
default = false;
description = "Open port in the firewall.";
};
listenPort = lib.mkOption {
type = lib.types.int;
default = 3000;
description = "Port to listen on.";
};
listenAddress = lib.mkOption {
type = lib.types.str;
default = "127.0.0.1";
description = "Address or hostname to listen on. Defaults to 127.0.0.1.";
};
spaceDir = lib.mkOption {
type = lib.types.path;
default = defaultSpaceDir;
example = "/home/yourUser/silverbullet";
description = ''
Folder to store Silverbullet's space/workspace.
By default it is located at `${defaultSpaceDir}`.
'';
};
user = lib.mkOption {
type = lib.types.str;
default = defaultUser;
example = "yourUser";
description = ''
The user to run Silverbullet as.
By default, a user named `${defaultUser}` will be created whose space
directory is [spaceDir](#opt-services.silverbullet.spaceDir).
'';
};
group = lib.mkOption {
type = lib.types.str;
default = defaultGroup;
example = "yourGroup";
description = ''
The group to run Silverbullet under.
By default, a group named `${defaultGroup}` will be created.
'';
};
envFile = lib.mkOption {
type = lib.types.nullOr lib.types.path;
default = null;
example = "/etc/silverbullet.env";
description = ''
File containing extra environment variables. For example:
```
SB_USER=user:password
SB_AUTH_TOKEN=abcdefg12345
```
'';
};
extraArgs = lib.mkOption {
type = lib.types.listOf lib.types.str;
default = [ ];
example = [ "--db /path/to/silverbullet.db" ];
description = "Extra arguments passed to silverbullet.";
};
};
};
config = lib.mkIf cfg.enable {
systemd.services.silverbullet = {
description = "Silverbullet service";
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
preStart = lib.mkIf (!lib.hasPrefix "/var/lib/" cfg.spaceDir) "mkdir -p '${cfg.spaceDir}'";
serviceConfig = {
Type = "simple";
User = "${cfg.user}";
Group = "${cfg.group}";
EnvironmentFile = lib.mkIf (cfg.envFile != null) "${cfg.envFile}";
StateDirectory = lib.mkIf (lib.hasPrefix "/var/lib/" cfg.spaceDir) (lib.last (lib.splitString "/" cfg.spaceDir));
ExecStart = "${lib.getExe cfg.package} --port ${toString cfg.listenPort} --hostname '${cfg.listenAddress}' '${cfg.spaceDir}' " + lib.concatStringsSep " " cfg.extraArgs;
Restart = "on-failure";
};
};
networking.firewall = lib.mkIf cfg.openFirewall {
allowedTCPPorts = [ cfg.listenPort ];
};
users.users.${defaultUser} = lib.mkIf (cfg.user == defaultUser) {
isSystemUser = true;
group = cfg.group;
description = "Silverbullet daemon user";
};
users.groups.${defaultGroup} = lib.mkIf (cfg.group == defaultGroup) { };
};
meta.maintainers = with lib.maintainers; [ aorith ];
}
|