nixos/modules/services/misc/pinnwand.nix

   1 { config, lib, pkgs, ... }:
   2 let
   3   cfg = config.services.pinnwand;
   4
   5   format = pkgs.formats.toml {};
   6   configFile = format.generate "pinnwand.toml" cfg.settings;
   7 in
   8 {
   9   options.services.pinnwand = {
  10     enable = lib.mkEnableOption "Pinnwand, a pastebin";
  11
  12     port = lib.mkOption {
  13       type = lib.types.port;
  14       description = "The port to listen on.";
  15       default = 8000;
  16     };
  17
  18     settings = lib.mkOption {
  19       default = {};
  20       description = ''
  21         Your {file}`pinnwand.toml` as a Nix attribute set. Look up
  22         possible options in the [documentation](https://pinnwand.readthedocs.io/en/v${pkgs.pinnwand.version}/configuration.html).
  23       '';
  24       type = lib.types.submodule {
  25         freeformType = format.type;
  26         options = {
  27           database_uri = lib.mkOption {
  28             type = lib.types.str;
  29             default = "sqlite:////var/lib/pinnwand/pinnwand.db";
  30             example = "sqlite:///:memory";
  31             description = ''
  32               Database URI compatible with [SQLAlchemyhttps://docs.sqlalchemy.org/en/14/core/engines.html#database-urls].
  33
  34               Additional packages may need to be introduced into the environment for certain databases.
  35             '';
  36           };
  37
  38           paste_size = lib.mkOption {
  39             type = lib.types.ints.positive;
  40             default = 262144;
  41             example = 524288;
  42             description = ''
  43               Maximum size of a paste in bytes.
  44             '';
  45           };
  46           paste_help = lib.mkOption {
  47             type = lib.types.str;
  48             default = ''
  49               <p>Welcome to pinnwand, this site is a pastebin. It allows you to share code with others. If you write code in the text area below and press the paste button you will be given a link you can share with others so they can view your code as well.</p><p>People with the link can view your pasted code, only you can remove your paste and it expires automatically. Note that anyone could guess the URI to your paste so don't rely on it being private.</p>
  50               '';
  51             description = ''
  52               Raw HTML help text shown in the header area.
  53             '';
  54           };
  55           footer = lib.mkOption {
  56             type = lib.types.str;
  57             default = ''
  58               View <a href="//github.com/supakeen/pinnwand" target="_BLANK">source code</a>, the <a href="/removal">removal</a> or <a href="/expiry">expiry</a> stories, or read the <a href="/about">about</a> page.
  59             '';
  60             description = ''
  61               The footer in raw HTML.
  62             '';
  63           };
  64         };
  65       };
  66     };
  67   };
  68
  69   config = lib.mkIf cfg.enable {
  70     systemd.services.pinnwand = {
  71       description = "Pinnwannd HTTP Server";
  72       after = [ "network.target" ];
  73       wantedBy = [ "multi-user.target" ];
  74
  75       unitConfig.Documentation = "https://pinnwand.readthedocs.io/en/latest/";
  76
  77       serviceConfig = {
  78         ExecStart = "${pkgs.pinnwand}/bin/pinnwand --configuration-path ${configFile} http --port ${toString cfg.port}";
  79         User = "pinnwand";
  80         DynamicUser = true;
  81
  82         StateDirectory = "pinnwand";
  83         StateDirectoryMode = "0700";
  84
  85         AmbientCapabilities = [];
  86         CapabilityBoundingSet = "";
  87         DevicePolicy = "closed";
  88         LockPersonality = true;
  89         MemoryDenyWriteExecute = true;
  90         PrivateDevices = true;
  91         PrivateUsers = true;
  92         ProcSubset = "pid";
  93         ProtectClock = true;
  94         ProtectControlGroups = true;
  95         ProtectHome = true;
  96         ProtectHostname = true;
  97         ProtectKernelLogs = true;
  98         ProtectKernelModules = true;
  99         ProtectKernelTunables = true;
 100         ProtectProc = "invisible";
 101         RestrictAddressFamilies = [
 102           "AF_UNIX"
 103           "AF_INET"
 104           "AF_INET6"
 105         ];
 106         RestrictNamespaces = true;
 107         RestrictRealtime = true;
 108         SystemCallArchitectures = "native";
 109         SystemCallFilter = [
 110           "@system-service"
 111           "~@privileged"
 112         ];
 113         UMask = "0077";
 114       };
 115     };
 116   };
 117
 118   meta.buildDocsInSandbox = false;
 119 }