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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
kittybox:
{ config, pkgs, lib, ... }:
with lib;
let
cfg = config.services.kittybox;
in {
options = {
services.kittybox = {
enable = mkOption {
type = types.bool;
default = false;
description = ''
Whether to enable Kittybox, the IndieWeb blogging solution.
'';
};
package = mkOption {
type = types.package;
default = kittybox.packages.${config.nixpkgs.localSystem.system}.kittybox;
defaultText = "<kittybox package from the upstream flake>";
description = "Which Kittybox derivation to use.";
};
bind = mkOption {
type = types.nullOr types.str;
default = "127.0.0.1";
description = "The host for Kittybox to bind to.";
example = "192.168.1.100";
};
port = mkOption {
type = types.int;
default = 8080;
description = "The port for Kittybox to listen at.";
example = 16420;
};
logLevel = mkOption {
type = types.str;
default = "warn";
example = "info";
description = "Specify the server verbosity level. Uses RUST_LOG environment variable internally.";
};
backendUri = mkOption {
type = types.str;
default = "file:///var/lib/kittybox/data";
example = "redis://192.168.1.200:6379";
description = ''
Set the backend used for storing data. Available backends are:
- file:// - static folder backend (recommended)
- redis:// - Redis backend (currently unavailable)
Make sure that if you are using the file backend, the state
directory is accessible by Kittybox. By default, the unit config
uses DynamicUser=true, which prevents the unit from accessing
data outside of its directory. It is recommended to reconfigure
the sandboxing or use a bind-mount to /var/lib/private/kittybox
if you require the state directory to reside elsewhere.
'';
};
blobstoreUri = mkOption {
type = types.nullOr types.str;
default = "file:///var/lib/kittybox/media";
description = ''
Set the backend used for the media endpoint storage. Available options are:
- file:// - content-addressed storage using flat files (recommended)
When using the file backend, check notes in the `backendUri` option too.
'';
};
authstoreUri = mkOption {
type = types.nullOr types.str;
default = "file:///var/lib/kittybox/auth";
description = ''
Set the backend used for persisting authentication data. Available options are:
- file:// - flat files. Codes are stored globally, tokens and
credentials are stored per-site.
'';
};
microsubServer = mkOption {
type = types.nullOr types.str;
default = null;
example = "https://aperture.p3k.io/microsub/69420";
description = ''
The URL of your Microsub server, which saves feeds for you
and allows you to browse Web content from one place. Try
https://aperture.p3k.io/ if you don't have one yet!
'';
};
webmentionEndpoint = mkOption {
type = types.nullOr types.str;
default = null;
example = "https://webmention.io/example.com/webmention";
description = ''
The URL of your webmention endpoint, which allows you to
receive notifications about your site's content being featured
or interacted with elsewhere on the IndieWeb.
By default Kittybox expects the Webmention endpoint to post
updates using an internal token. kittybox-webmention is an
endpoint capable of that.
'';
};
internalTokenFile = mkOption {
type = types.nullOr types.str;
default = null;
example = "/run/secrets/kittybox-shared-secret";
description = "A shared secret that will, when passed, allow unlimited editing access to database. Keep it safe.";
};
cookieSecretFile = mkOption {
type = types.str;
default = "/var/lib/kittybox/cookie_secret_key";
example = "/run/secrets/kittybox-cookie-secret";
description = "A secret file to encrypt cookies with the contents of. Should be at least 32 bytes in length. A random persistent file will be generated if this variable is left untouched.";
};
};
};
config = lib.mkIf cfg.enable {
systemd.services.kittybox = {
description = "An IndieWeb-enabled blog engine";
wantedBy = [ "multi-user.target" ];
after = [ "network.target" ];
restartTriggers = [
cfg.package
cfg.backendUri cfg.blobstoreUri cfg.authstoreUri
cfg.internalTokenFile
cfg.bind cfg.port
cfg.cookieSecretFile
];
environment = {
SERVE_AT = "${cfg.bind}:${builtins.toString cfg.port}";
MICROSUB_ENDPOINT = cfg.microsubServer;
WEBMENTION_ENDPOINT = cfg.webmentionEndpoint;
BACKEND_URI = cfg.backendUri;
BLOBSTORE_URI = cfg.blobstoreUri;
AUTH_STORE_URI = cfg.authstoreUri;
RUST_LOG = "${cfg.logLevel}";
COOKIE_SECRET_FILE = "${cfg.cookieSecretFile}";
};
script = ''
${lib.optionalString (cfg.internalTokenFile != null) ''
if [[ -f ${cfg.internalTokenFile} ]]; then
export KITTYBOX_INTERNAL_TOKEN=$(${pkgs.coreutils}/bin/cat ${cfg.internalTokenFile})
fi
''}
if [[ ${cfg.cookieSecretFile} == /var/lib/kittybox/cookie_secret_key && ! -f /var/lib/kittybox/cookie_secret_key ]]; then
cat /dev/urandom | tr -Cd '[:alnum:]' | head -c 128 > /var/lib/kittybox/cookie_secret_key
fi
exec ${cfg.package}/bin/kittybox
'';
serviceConfig = {
DynamicUser = true;
StateDirectory = "kittybox";
};
};
};
}
|
