nixpkgs/nixos/modules/services/web-apps/miniflux.nix

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

135 lines
3.8 KiB
Nix
Raw Normal View History

2018-12-21 19:36:58 +01:00
{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.services.miniflux;
2022-01-02 13:00:00 +01:00
defaultAddress = "localhost:8080";
2018-12-21 19:36:58 +01:00
dbUser = "miniflux";
dbName = "miniflux";
pgbin = "${config.services.postgresql.package}/bin";
preStart = pkgs.writeScript "miniflux-pre-start" ''
#!${pkgs.runtimeShell}
${pgbin}/psql "${dbName}" -c "CREATE EXTENSION IF NOT EXISTS hstore"
2018-12-21 19:36:58 +01:00
'';
in
{
options = {
services.miniflux = {
enable = mkEnableOption (lib.mdDoc "miniflux and creates a local postgres database for it");
2018-12-21 19:36:58 +01:00
2022-12-16 16:11:40 +01:00
package = mkOption {
type = types.package;
default = pkgs.miniflux;
defaultText = literalExpression "pkgs.miniflux";
description = lib.mdDoc "Miniflux package to use.";
};
2018-12-21 19:36:58 +01:00
config = mkOption {
type = types.attrsOf types.str;
example = literalExpression ''
2018-12-21 19:36:58 +01:00
{
CLEANUP_FREQUENCY = "48";
LISTEN_ADDR = "localhost:8080";
}
'';
description = lib.mdDoc ''
2018-12-21 19:36:58 +01:00
Configuration for Miniflux, refer to
<https://miniflux.app/docs/configuration.html>
2018-12-21 19:36:58 +01:00
for documentation on the supported values.
2022-01-02 13:00:00 +01:00
Correct configuration for the database is already provided.
By default, listens on ${defaultAddress}.
2018-12-21 19:36:58 +01:00
'';
};
adminCredentialsFile = mkOption {
type = types.path;
description = lib.mdDoc ''
File containing the ADMIN_USERNAME and
ADMIN_PASSWORD (length >= 6) in the format of
2018-12-21 19:36:58 +01:00
an EnvironmentFile=, as described by systemd.exec(5).
'';
example = "/etc/nixos/miniflux-admin-credentials";
};
};
};
config = mkIf cfg.enable {
services.miniflux.config = {
2022-01-02 13:00:00 +01:00
LISTEN_ADDR = mkDefault defaultAddress;
DATABASE_URL = "user=${dbUser} host=/run/postgresql dbname=${dbName}";
2018-12-21 19:36:58 +01:00
RUN_MIGRATIONS = "1";
CREATE_ADMIN = "1";
};
services.postgresql = {
enable = true;
ensureUsers = [ {
name = dbUser;
ensurePermissions = {
"DATABASE ${dbName}" = "ALL PRIVILEGES";
};
} ];
ensureDatabases = [ dbName ];
};
2018-12-21 19:36:58 +01:00
systemd.services.miniflux-dbsetup = {
description = "Miniflux database setup";
requires = [ "postgresql.service" ];
after = [ "network.target" "postgresql.service" ];
serviceConfig = {
Type = "oneshot";
User = config.services.postgresql.superUser;
ExecStart = preStart;
};
};
2018-12-21 19:36:58 +01:00
systemd.services.miniflux = {
description = "Miniflux service";
wantedBy = [ "multi-user.target" ];
requires = [ "miniflux-dbsetup.service" ];
after = [ "network.target" "postgresql.service" "miniflux-dbsetup.service" ];
2018-12-21 19:36:58 +01:00
serviceConfig = {
2022-12-16 16:11:40 +01:00
ExecStart = "${cfg.package}/bin/miniflux";
User = dbUser;
2018-12-21 19:36:58 +01:00
DynamicUser = true;
RuntimeDirectory = "miniflux";
RuntimeDirectoryMode = "0700";
EnvironmentFile = cfg.adminCredentialsFile;
# Hardening
CapabilityBoundingSet = [ "" ];
DeviceAllow = [ "" ];
LockPersonality = true;
MemoryDenyWriteExecute = true;
PrivateDevices = true;
PrivateUsers = true;
ProcSubset = "pid";
ProtectClock = true;
ProtectControlGroups = true;
ProtectHome = true;
ProtectHostname = true;
ProtectKernelLogs = true;
ProtectKernelModules = true;
ProtectKernelTunables = true;
ProtectProc = "invisible";
RestrictAddressFamilies = [ "AF_INET" "AF_INET6" "AF_UNIX" ];
RestrictNamespaces = true;
RestrictRealtime = true;
RestrictSUIDSGID = true;
SystemCallArchitectures = "native";
SystemCallFilter = [ "@system-service" "~@privileged" ];
UMask = "0077";
2018-12-21 19:36:58 +01:00
};
environment = cfg.config;
};
2022-12-16 16:11:40 +01:00
environment.systemPackages = [ cfg.package ];
2018-12-21 19:36:58 +01:00
};
}