/
akkoma.nix
1146 lines (981 loc) · 39.8 KB
/
akkoma.nix
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.services.akkoma;
ex = cfg.config;
db = ex.":pleroma"."Pleroma.Repo";
web = ex.":pleroma"."Pleroma.Web.Endpoint";
isConfined = config.systemd.services.akkoma.confinement.enable;
hasSmtp = (attrByPath [ ":pleroma" "Pleroma.Emails.Mailer" "adapter" "value" ] null ex) == "Swoosh.Adapters.SMTP";
isAbsolutePath = v: isString v && substring 0 1 v == "/";
isSecret = v: isAttrs v && v ? _secret && isAbsolutePath v._secret;
absolutePath = with types; mkOptionType {
name = "absolutePath";
description = "absolute path";
descriptionClass = "noun";
check = isAbsolutePath;
inherit (str) merge;
};
secret = mkOptionType {
name = "secret";
description = "secret value";
descriptionClass = "noun";
check = isSecret;
nestedTypes = {
_secret = absolutePath;
};
};
ipAddress = with types; mkOptionType {
name = "ipAddress";
description = "IPv4 or IPv6 address";
descriptionClass = "conjunction";
check = x: str.check x && builtins.match "[.0-9:A-Fa-f]+" x != null;
inherit (str) merge;
};
elixirValue = let
elixirValue' = with types;
nullOr (oneOf [ bool int float str (attrsOf elixirValue') (listOf elixirValue') ]) // {
description = "Elixir value";
};
in elixirValue';
frontend = {
options = {
package = mkOption {
type = types.package;
description = mdDoc "Akkoma frontend package.";
example = literalExpression "pkgs.akkoma-frontends.akkoma-fe";
};
name = mkOption {
type = types.nonEmptyStr;
description = mdDoc "Akkoma frontend name.";
example = "akkoma-fe";
};
ref = mkOption {
type = types.nonEmptyStr;
description = mdDoc "Akkoma frontend reference.";
example = "stable";
};
};
};
sha256 = builtins.hashString "sha256";
replaceSec = let
replaceSec' = { }@args: v:
if isAttrs v
then if v ? _secret
then if isAbsolutePath v._secret
then sha256 v._secret
else abort "Invalid secret path (_secret = ${v._secret})"
else mapAttrs (_: val: replaceSec' args val) v
else if isList v
then map (replaceSec' args) v
else v;
in replaceSec' { };
# Erlang/Elixir uses a somewhat special format for IP addresses
erlAddr = addr: fileContents
(pkgs.runCommand addr {
nativeBuildInputs = [ cfg.package.elixirPackage ];
code = ''
case :inet.parse_address('${addr}') do
{:ok, addr} -> IO.inspect addr
{:error, _} -> System.halt(65)
end
'';
passAsFile = [ "code" ];
} ''elixir "$codePath" >"$out"'');
format = pkgs.formats.elixirConf { elixir = cfg.package.elixirPackage; };
configFile = format.generate "config.exs"
(replaceSec
(attrsets.updateManyAttrsByPath [{
path = [ ":pleroma" "Pleroma.Web.Endpoint" "http" "ip" ];
update = addr:
if isAbsolutePath addr
then format.lib.mkTuple
[ (format.lib.mkAtom ":local") addr ]
else format.lib.mkRaw (erlAddr addr);
}] cfg.config));
writeShell = { name, text, runtimeInputs ? [ ] }:
pkgs.writeShellApplication { inherit name text runtimeInputs; } + "/bin/${name}";
genScript = writeShell {
name = "akkoma-gen-cookie";
runtimeInputs = with pkgs; [ coreutils util-linux ];
text = ''
install -m 0400 \
-o ${escapeShellArg cfg.user } \
-g ${escapeShellArg cfg.group} \
<(hexdump -n 16 -e '"%02x"' /dev/urandom) \
"$RUNTIME_DIRECTORY/cookie"
'';
};
copyScript = writeShell {
name = "akkoma-copy-cookie";
runtimeInputs = with pkgs; [ coreutils ];
text = ''
install -m 0400 \
-o ${escapeShellArg cfg.user} \
-g ${escapeShellArg cfg.group} \
${escapeShellArg cfg.dist.cookie._secret} \
"$RUNTIME_DIRECTORY/cookie"
'';
};
secretPaths = catAttrs "_secret" (collect isSecret cfg.config);
vapidKeygen = pkgs.writeText "vapidKeygen.exs" ''
[public_path, private_path] = System.argv()
{public_key, private_key} = :crypto.generate_key :ecdh, :prime256v1
File.write! public_path, Base.url_encode64(public_key, padding: false)
File.write! private_path, Base.url_encode64(private_key, padding: false)
'';
initSecretsScript = writeShell {
name = "akkoma-init-secrets";
runtimeInputs = with pkgs; [ coreutils cfg.package.elixirPackage ];
text = let
key-base = web.secret_key_base;
jwt-signer = ex.":joken".":default_signer";
signing-salt = web.signing_salt;
liveview-salt = web.live_view.signing_salt;
vapid-private = ex.":web_push_encryption".":vapid_details".private_key;
vapid-public = ex.":web_push_encryption".":vapid_details".public_key;
in ''
secret() {
# Generate default secret if non‐existent
test -e "$2" || install -D -m 0600 <(tr -dc 'A-Za-z-._~' </dev/urandom | head -c "$1") "$2"
if [ "$(stat --dereference --format='%s' "$2")" -lt "$1" ]; then
echo "Secret '$2' is smaller than minimum size of $1 bytes." >&2
exit 65
fi
}
secret 64 ${escapeShellArg key-base._secret}
secret 64 ${escapeShellArg jwt-signer._secret}
secret 8 ${escapeShellArg signing-salt._secret}
secret 8 ${escapeShellArg liveview-salt._secret}
${optionalString (isSecret vapid-public) ''
{ test -e ${escapeShellArg vapid-private._secret} && \
test -e ${escapeShellArg vapid-public._secret}; } || \
elixir ${escapeShellArgs [ vapidKeygen vapid-public._secret vapid-private._secret ]}
''}
'';
};
configScript = writeShell {
name = "akkoma-config";
runtimeInputs = with pkgs; [ coreutils replace-secret ];
text = ''
cd "$RUNTIME_DIRECTORY"
tmp="$(mktemp config.exs.XXXXXXXXXX)"
trap 'rm -f "$tmp"' EXIT TERM
cat ${escapeShellArg configFile} >"$tmp"
${concatMapStrings (file: ''
replace-secret ${escapeShellArgs [ (sha256 file) file ]} "$tmp"
'') secretPaths}
chown ${escapeShellArg cfg.user}:${escapeShellArg cfg.group} "$tmp"
chmod 0400 "$tmp"
mv -f "$tmp" config.exs
'';
};
pgpass = let
esc = escape [ ":" ''\'' ];
in if (cfg.initDb.password != null)
then pkgs.writeText "pgpass.conf" ''
*:*:*${esc cfg.initDb.username}:${esc (sha256 cfg.initDb.password._secret)}
''
else null;
escapeSqlId = x: ''"${replaceStrings [ ''"'' ] [ ''""'' ] x}"'';
escapeSqlStr = x: "'${replaceStrings [ "'" ] [ "''" ] x}'";
setupSql = pkgs.writeText "setup.psql" ''
\set ON_ERROR_STOP on
ALTER ROLE ${escapeSqlId db.username}
LOGIN PASSWORD ${if db ? password
then "${escapeSqlStr (sha256 db.password._secret)}"
else "NULL"};
ALTER DATABASE ${escapeSqlId db.database}
OWNER TO ${escapeSqlId db.username};
\connect ${escapeSqlId db.database}
CREATE EXTENSION IF NOT EXISTS citext;
CREATE EXTENSION IF NOT EXISTS pg_trgm;
CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
'';
dbHost = if db ? socket_dir then db.socket_dir
else if db ? socket then db.socket
else if db ? hostname then db.hostname
else null;
initDbScript = writeShell {
name = "akkoma-initdb";
runtimeInputs = with pkgs; [ coreutils replace-secret config.services.postgresql.package ];
text = ''
pgpass="$(mktemp -t pgpass-XXXXXXXXXX.conf)"
setupSql="$(mktemp -t setup-XXXXXXXXXX.psql)"
trap 'rm -f "$pgpass $setupSql"' EXIT TERM
${optionalString (dbHost != null) ''
export PGHOST=${escapeShellArg dbHost}
''}
export PGUSER=${escapeShellArg cfg.initDb.username}
${optionalString (pgpass != null) ''
cat ${escapeShellArg pgpass} >"$pgpass"
replace-secret ${escapeShellArgs [
(sha256 cfg.initDb.password._secret) cfg.initDb.password._secret ]} "$pgpass"
export PGPASSFILE="$pgpass"
''}
cat ${escapeShellArg setupSql} >"$setupSql"
${optionalString (db ? password) ''
replace-secret ${escapeShellArgs [
(sha256 db.password._secret) db.password._secret ]} "$setupSql"
''}
# Create role if non‐existent
psql -tAc "SELECT 1 FROM pg_roles
WHERE rolname = "${escapeShellArg (escapeSqlStr db.username)} | grep -F -q 1 || \
psql -tAc "CREATE ROLE "${escapeShellArg (escapeSqlId db.username)}
# Create database if non‐existent
psql -tAc "SELECT 1 FROM pg_database
WHERE datname = "${escapeShellArg (escapeSqlStr db.database)} | grep -F -q 1 || \
psql -tAc "CREATE DATABASE "${escapeShellArg (escapeSqlId db.database)}"
OWNER "${escapeShellArg (escapeSqlId db.username)}"
TEMPLATE template0
ENCODING 'utf8'
LOCALE 'C'"
psql -f "$setupSql"
'';
};
envWrapper = let
script = writeShell {
name = "akkoma-env";
text = ''
cd "${cfg.package}"
RUNTIME_DIRECTORY="''${RUNTIME_DIRECTORY:-/run/akkoma}"
AKKOMA_CONFIG_PATH="$RUNTIME_DIRECTORY/config.exs" \
ERL_EPMD_ADDRESS="${cfg.dist.address}" \
ERL_EPMD_PORT="${toString cfg.dist.epmdPort}" \
ERL_FLAGS=${lib.escapeShellArg (lib.escapeShellArgs ([
"-kernel" "inet_dist_use_interface" (erlAddr cfg.dist.address)
"-kernel" "inet_dist_listen_min" (toString cfg.dist.portMin)
"-kernel" "inet_dist_listen_max" (toString cfg.dist.portMax)
] ++ cfg.dist.extraFlags))} \
RELEASE_COOKIE="$(<"$RUNTIME_DIRECTORY/cookie")" \
RELEASE_NAME="akkoma" \
exec "${cfg.package}/bin/$(basename "$0")" "$@"
'';
};
in pkgs.runCommandLocal "akkoma-env" { } ''
mkdir -p "$out/bin"
ln -r -s ${escapeShellArg script} "$out/bin/pleroma"
ln -r -s ${escapeShellArg script} "$out/bin/pleroma_ctl"
'';
userWrapper = pkgs.writeShellApplication {
name = "pleroma_ctl";
text = ''
if [ "''${1-}" == "update" ]; then
echo "OTP releases are not supported on NixOS." >&2
exit 64
fi
exec sudo -u ${escapeShellArg cfg.user} \
"${envWrapper}/bin/pleroma_ctl" "$@"
'';
};
socketScript = if isAbsolutePath web.http.ip
then writeShell {
name = "akkoma-socket";
runtimeInputs = with pkgs; [ coreutils inotify-tools ];
text = ''
coproc {
inotifywait -q -m -e create ${escapeShellArg (dirOf web.http.ip)}
}
trap 'kill "$COPROC_PID"' EXIT TERM
until test -S ${escapeShellArg web.http.ip}
do read -r -u "''${COPROC[0]}"
done
chmod 0666 ${escapeShellArg web.http.ip}
'';
}
else null;
staticDir = ex.":pleroma".":instance".static_dir;
uploadDir = ex.":pleroma".":instance".upload_dir;
staticFiles = pkgs.runCommandLocal "akkoma-static" { } ''
${concatStringsSep "\n" (mapAttrsToList (key: val: ''
mkdir -p $out/frontends/${escapeShellArg val.name}/
ln -s ${escapeShellArg val.package} $out/frontends/${escapeShellArg val.name}/${escapeShellArg val.ref}
'') cfg.frontends)}
${optionalString (cfg.extraStatic != null)
(concatStringsSep "\n" (mapAttrsToList (key: val: ''
mkdir -p "$out/$(dirname ${escapeShellArg key})"
ln -s ${escapeShellArg val} $out/${escapeShellArg key}
'') cfg.extraStatic))}
'';
in {
options = {
services.akkoma = {
enable = mkEnableOption (mdDoc "Akkoma");
package = mkOption {
type = types.package;
default = pkgs.akkoma;
defaultText = literalExpression "pkgs.akkoma";
description = mdDoc "Akkoma package to use.";
};
user = mkOption {
type = types.nonEmptyStr;
default = "akkoma";
description = mdDoc "User account under which Akkoma runs.";
};
group = mkOption {
type = types.nonEmptyStr;
default = "akkoma";
description = mdDoc "Group account under which Akkoma runs.";
};
initDb = {
enable = mkOption {
type = types.bool;
default = true;
description = mdDoc ''
Whether to automatically initialise the database on startup. This will create a
database role and database if they do not already exist, and (re)set the role password
and the ownership of the database.
This setting can be used safely even if the database already exists and contains data.
The database settings are configured through
[{option}`config.services.akkoma.config.":pleroma"."Pleroma.Repo"`](#opt-services.akkoma.config.__pleroma_._Pleroma.Repo_).
If disabled, the database has to be set up manually:
```SQL
CREATE ROLE akkoma LOGIN;
CREATE DATABASE akkoma
OWNER akkoma
TEMPLATE template0
ENCODING 'utf8'
LOCALE 'C';
\connect akkoma
CREATE EXTENSION IF NOT EXISTS citext;
CREATE EXTENSION IF NOT EXISTS pg_trgm;
CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
```
'';
};
username = mkOption {
type = types.nonEmptyStr;
default = config.services.postgresql.superUser;
defaultText = literalExpression "config.services.postgresql.superUser";
description = mdDoc ''
Name of the database user to initialise the database with.
This user is required to have the `CREATEROLE` and `CREATEDB` capabilities.
'';
};
password = mkOption {
type = types.nullOr secret;
default = null;
description = mdDoc ''
Password of the database user to initialise the database with.
If set to `null`, no password will be used.
The attribute `_secret` should point to a file containing the secret.
'';
};
};
initSecrets = mkOption {
type = types.bool;
default = true;
description = mdDoc ''
Whether to initialise non‐existent secrets with random values.
If enabled, appropriate secrets for the following options will be created automatically
if the files referenced in the `_secrets` attribute do not exist during startup.
- {option}`config.":pleroma"."Pleroma.Web.Endpoint".secret_key_base`
- {option}`config.":pleroma"."Pleroma.Web.Endpoint".signing_salt`
- {option}`config.":pleroma"."Pleroma.Web.Endpoint".live_view.signing_salt`
- {option}`config.":web_push_encryption".":vapid_details".private_key`
- {option}`config.":web_push_encryption".":vapid_details".public_key`
- {option}`config.":joken".":default_signer"`
'';
};
installWrapper = mkOption {
type = types.bool;
default = true;
description = mdDoc ''
Whether to install a wrapper around `pleroma_ctl` to simplify administration of the
Akkoma instance.
'';
};
extraPackages = mkOption {
type = with types; listOf package;
default = with pkgs; [ exiftool ffmpeg_5-headless graphicsmagick-imagemagick-compat ];
defaultText = literalExpression "with pkgs; [ exiftool graphicsmagick-imagemagick-compat ffmpeg_5-headless ]";
example = literalExpression "with pkgs; [ exiftool imagemagick ffmpeg_5-full ]";
description = mdDoc ''
List of extra packages to include in the executable search path of the service unit.
These are needed by various configurable components such as:
- ExifTool for the `Pleroma.Upload.Filter.Exiftool` upload filter,
- ImageMagick for still image previews in the media proxy as well as for the
`Pleroma.Upload.Filters.Mogrify` upload filter, and
- ffmpeg for video previews in the media proxy.
'';
};
frontends = mkOption {
description = mdDoc "Akkoma frontends.";
type = with types; attrsOf (submodule frontend);
default = {
primary = {
package = pkgs.akkoma-frontends.akkoma-fe;
name = "akkoma-fe";
ref = "stable";
};
admin = {
package = pkgs.akkoma-frontends.admin-fe;
name = "admin-fe";
ref = "stable";
};
};
defaultText = literalExpression ''
{
primary = {
package = pkgs.akkoma-frontends.akkoma-fe;
name = "akkoma-fe";
ref = "stable";
};
admin = {
package = pkgs.akkoma-frontends.admin-fe;
name = "admin-fe";
ref = "stable";
};
}
'';
};
extraStatic = mkOption {
type = with types; nullOr (attrsOf package);
description = mdDoc ''
Attribute set of extra packages to add to the static files directory.
Do not add frontends here. These should be configured through
[{option}`services.akkoma.frontends`](#opt-services.akkoma.frontends).
'';
default = null;
example = literalExpression ''
{
"emoji/blobs.gg" = pkgs.akkoma-emoji.blobs_gg;
"static/terms-of-service.html" = pkgs.writeText "terms-of-service.html" '''
…
''';
"favicon.png" = let
rev = "697a8211b0f427a921e7935a35d14bb3e32d0a2c";
in pkgs.stdenvNoCC.mkDerivation {
name = "favicon.png";
src = pkgs.fetchurl {
url = "https://raw.githubusercontent.com/TilCreator/NixOwO/''${rev}/NixOwO_plain.svg";
hash = "sha256-tWhHMfJ3Od58N9H5yOKPMfM56hYWSOnr/TGCBi8bo9E=";
};
nativeBuildInputs = with pkgs; [ librsvg ];
dontUnpack = true;
installPhase = '''
rsvg-convert -o $out -w 96 -h 96 $src
''';
};
}
'';
};
dist = {
address = mkOption {
type = ipAddress;
default = "127.0.0.1";
description = mdDoc ''
Listen address for Erlang distribution protocol and Port Mapper Daemon (epmd).
'';
};
epmdPort = mkOption {
type = types.port;
default = 4369;
description = mdDoc "TCP port to bind Erlang Port Mapper Daemon to.";
};
extraFlags = mkOption {
type = with types; listOf str;
default = [ ];
description = mdDoc "Extra flags to pass to Erlang";
example = [ "+sbwt" "none" "+sbwtdcpu" "none" "+sbwtdio" "none" ];
};
portMin = mkOption {
type = types.port;
default = 49152;
description = mdDoc "Lower bound for Erlang distribution protocol TCP port.";
};
portMax = mkOption {
type = types.port;
default = 65535;
description = mdDoc "Upper bound for Erlang distribution protocol TCP port.";
};
cookie = mkOption {
type = types.nullOr secret;
default = null;
example = { _secret = "/var/lib/secrets/akkoma/releaseCookie"; };
description = mdDoc ''
Erlang release cookie.
If set to `null`, a temporary random cookie will be generated.
'';
};
};
config = mkOption {
description = mdDoc ''
Configuration for Akkoma. The attributes are serialised to Elixir DSL.
Refer to <https://docs.akkoma.dev/stable/configuration/cheatsheet/> for
configuration options.
Settings containing secret data should be set to an attribute set containing the
attribute `_secret` - a string pointing to a file containing the value the option
should be set to.
'';
type = types.submodule {
freeformType = format.type;
options = {
":pleroma" = {
":instance" = {
name = mkOption {
type = types.nonEmptyStr;
description = mdDoc "Instance name.";
};
email = mkOption {
type = types.nonEmptyStr;
description = mdDoc "Instance administrator email.";
};
description = mkOption {
type = types.nonEmptyStr;
description = mdDoc "Instance description.";
};
static_dir = mkOption {
type = types.path;
default = toString staticFiles;
defaultText = literalMD ''
Derivation gathering the following paths into a directory:
- [{option}`services.akkoma.frontends`](#opt-services.akkoma.frontends)
- [{option}`services.akkoma.extraStatic`](#opt-services.akkoma.extraStatic)
'';
description = mdDoc ''
Directory of static files.
This directory can be built using a derivation, or it can be managed as mutable
state by setting the option to an absolute path.
'';
};
upload_dir = mkOption {
type = absolutePath;
default = "/var/lib/akkoma/uploads";
description = mdDoc ''
Directory where Akkoma will put uploaded files.
'';
};
};
"Pleroma.Repo" = mkOption {
type = elixirValue;
default = {
adapter = format.lib.mkRaw "Ecto.Adapters.Postgres";
socket_dir = "/run/postgresql";
username = cfg.user;
database = "akkoma";
};
defaultText = literalExpression ''
{
adapter = (pkgs.formats.elixirConf { }).lib.mkRaw "Ecto.Adapters.Postgres";
socket_dir = "/run/postgresql";
username = config.services.akkoma.user;
database = "akkoma";
}
'';
description = mdDoc ''
Database configuration.
Refer to
<https://hexdocs.pm/ecto_sql/Ecto.Adapters.Postgres.html#module-connection-options>
for options.
'';
};
"Pleroma.Web.Endpoint" = {
url = {
host = mkOption {
type = types.nonEmptyStr;
default = config.networking.fqdn;
defaultText = literalExpression "config.networking.fqdn";
description = mdDoc "Domain name of the instance.";
};
scheme = mkOption {
type = types.nonEmptyStr;
default = "https";
description = mdDoc "URL scheme.";
};
port = mkOption {
type = types.port;
default = 443;
description = mdDoc "External port number.";
};
};
http = {
ip = mkOption {
type = types.either absolutePath ipAddress;
default = "/run/akkoma/socket";
example = "::1";
description = mdDoc ''
Listener IP address or Unix socket path.
The value is automatically converted to Elixir’s internal address
representation during serialisation.
'';
};
port = mkOption {
type = types.port;
default = if isAbsolutePath web.http.ip then 0 else 4000;
defaultText = literalExpression ''
if isAbsolutePath config.services.akkoma.config.:pleroma"."Pleroma.Web.Endpoint".http.ip
then 0
else 4000;
'';
description = mdDoc ''
Listener port number.
Must be 0 if using a Unix socket.
'';
};
};
secret_key_base = mkOption {
type = secret;
default = { _secret = "/var/lib/secrets/akkoma/key-base"; };
description = mdDoc ''
Secret key used as a base to generate further secrets for encrypting and
signing data.
The attribute `_secret` should point to a file containing the secret.
This key can generated can be generated as follows:
```ShellSession
$ tr -dc 'A-Za-z-._~' </dev/urandom | head -c 64
```
'';
};
live_view = {
signing_salt = mkOption {
type = secret;
default = { _secret = "/var/lib/secrets/akkoma/liveview-salt"; };
description = mdDoc ''
LiveView signing salt.
The attribute `_secret` should point to a file containing the secret.
This salt can be generated as follows:
```ShellSession
$ tr -dc 'A-Za-z0-9-._~' </dev/urandom | head -c 8
```
'';
};
};
signing_salt = mkOption {
type = secret;
default = { _secret = "/var/lib/secrets/akkoma/signing-salt"; };
description = mdDoc ''
Signing salt.
The attribute `_secret` should point to a file containing the secret.
This salt can be generated as follows:
```ShellSession
$ tr -dc 'A-Za-z0-9-._~' </dev/urandom | head -c 8
```
'';
};
};
"Pleroma.Upload" = let
httpConf = cfg.config.":pleroma"."Pleroma.Web.Endpoint".url;
in {
base_url = mkOption {
type = types.nonEmptyStr;
default = if lib.versionOlder config.system.stateVersion "24.05"
then "${httpConf.scheme}://${httpConf.host}:${builtins.toString httpConf.port}/media/"
else null;
defaultText = literalExpression ''
if lib.versionOlder config.system.stateVersion "24.05"
then "$\{httpConf.scheme}://$\{httpConf.host}:$\{builtins.toString httpConf.port}/media/"
else null;
'';
description = mdDoc ''
Base path which uploads will be stored at.
Whilst this can just be set to a subdirectory of the main domain, it is now recommended to use a different subdomain.
'';
};
};
":frontends" = mkOption {
type = elixirValue;
default = mapAttrs
(key: val: format.lib.mkMap { name = val.name; ref = val.ref; })
cfg.frontends;
defaultText = literalExpression ''
lib.mapAttrs (key: val:
(pkgs.formats.elixirConf { }).lib.mkMap { name = val.name; ref = val.ref; })
config.services.akkoma.frontends;
'';
description = mdDoc ''
Frontend configuration.
Users should rely on the default value and prefer to configure frontends through
[{option}`config.services.akkoma.frontends`](#opt-services.akkoma.frontends).
'';
};
":media_proxy" = let
httpConf = cfg.config.":pleroma"."Pleroma.Web.Endpoint".url;
in {
enabled = mkOption {
type = types.bool;
default = false;
defaultText = literalExpression "false";
description = mdDoc ''
Whether to enable proxying of remote media through the instance's proxy.
'';
};
base_url = mkOption {
type = types.nullOr types.nonEmptyStr;
default = if lib.versionOlder config.system.stateVersion "24.05"
then "${httpConf.scheme}://${httpConf.host}:${builtins.toString httpConf.port}/media/"
else null;
defaultText = literalExpression ''
if lib.versionOlder config.system.stateVersion "24.05"
then "$\{httpConf.scheme}://$\{httpConf.host}:$\{builtins.toString httpConf.port}/media/"
else null;
'';
description = mdDoc ''
Base path for the media proxy.
Whilst this can just be set to a subdirectory of the main domain, it is now recommended to use a different subdomain.
'';
};
};
};
":web_push_encryption" = mkOption {
default = { };
description = mdDoc ''
Web Push Notifications configuration.
The necessary key pair can be generated as follows:
```ShellSession
$ nix-shell -p nodejs --run 'npx web-push generate-vapid-keys'
```
'';
type = types.submodule {
freeformType = elixirValue;
options = {
":vapid_details" = {
subject = mkOption {
type = types.nonEmptyStr;
default = "mailto:${ex.":pleroma".":instance".email}";
defaultText = literalExpression ''
"mailto:''${config.services.akkoma.config.":pleroma".":instance".email}"
'';
description = mdDoc "mailto URI for administrative contact.";
};
public_key = mkOption {
type = with types; either nonEmptyStr secret;
default = { _secret = "/var/lib/secrets/akkoma/vapid-public"; };
description = mdDoc "base64-encoded public ECDH key.";
};
private_key = mkOption {
type = secret;
default = { _secret = "/var/lib/secrets/akkoma/vapid-private"; };
description = mdDoc ''
base64-encoded private ECDH key.
The attribute `_secret` should point to a file containing the secret.
'';
};
};
};
};
};
":joken" = {
":default_signer" = mkOption {
type = secret;
default = { _secret = "/var/lib/secrets/akkoma/jwt-signer"; };
description = mdDoc ''
JWT signing secret.
The attribute `_secret` should point to a file containing the secret.
This secret can be generated as follows:
```ShellSession
$ tr -dc 'A-Za-z0-9-._~' </dev/urandom | head -c 64
```
'';
};
};
":logger" = {
":backends" = mkOption {
type = types.listOf elixirValue;
visible = false;
default = with format.lib; [
(mkTuple [ (mkRaw "ExSyslogger") (mkAtom ":ex_syslogger") ])
];
};
":ex_syslogger" = {
ident = mkOption {
type = types.str;
visible = false;
default = "akkoma";
};
level = mkOption {
type = types.nonEmptyStr;
apply = format.lib.mkAtom;
default = ":info";
example = ":warning";
description = mdDoc ''
Log level.
Refer to
<https://hexdocs.pm/logger/Logger.html#module-levels>
for options.
'';
};
};
};
":tzdata" = {
":data_dir" = mkOption {
type = elixirValue;
internal = true;
default = format.lib.mkRaw ''
Path.join(System.fetch_env!("CACHE_DIRECTORY"), "tzdata")
'';
};
};
};
};
};
nginx = mkOption {
type = with types; nullOr (submodule
(import ../web-servers/nginx/vhost-options.nix { inherit config lib; }));
default = null;
description = mdDoc ''
Extra configuration for the nginx virtual host of Akkoma.
If set to `null`, no virtual host will be added to the nginx configuration.
'';
};
};
};
config = mkIf cfg.enable {
assertions = optionals (cfg.config.":pleroma".":media_proxy".enabled && cfg.config.":pleroma".":media_proxy".base_url == null) [''
`services.akkoma.config.":pleroma".":media_proxy".base_url` must be set when the media proxy is enabled.
''];
warnings = optionals (with config.security; (!sudo.enable) && (!sudo-rs.enable)) [''
The pleroma_ctl wrapper enabled by the installWrapper option relies on
sudo, which appears to have been disabled through security.sudo.enable.
''];
users = {
users."${cfg.user}" = {
description = "Akkoma user";
group = cfg.group;
isSystemUser = true;
};
groups."${cfg.group}" = { };
};
# Confinement of the main service unit requires separation of the
# configuration generation into a separate unit to permit access to secrets
# residing outside of the chroot.
systemd.services.akkoma-config = {
description = "Akkoma social network configuration";
reloadTriggers = [ configFile ] ++ secretPaths;
unitConfig.PropagatesReloadTo = [ "akkoma.service" ];
serviceConfig = {
Type = "oneshot";
RemainAfterExit = true;
UMask = "0077";
RuntimeDirectory = "akkoma";
ExecStart = mkMerge [
(mkIf (cfg.dist.cookie == null) [ genScript ])
(mkIf (cfg.dist.cookie != null) [ copyScript ])
(mkIf cfg.initSecrets [ initSecretsScript ])
[ configScript ]
];