nixos/linkwarden: init module, linkwarden: init at 2.13.0 (#347353)

- [yubikey-manager](https://github.com/Yubico/yubikey-manager), a tool for configuring YubiKey devices. Available as [programs.yubikey-manager](#opt-programs.yubikey-manager.enable).

- [Linkwarden](https://linkwarden.app/) a self-hosted collaborative bookmark manager to collect, read, annotate, and fully preserve what matters, all in one place. Available as [services.linkwarden](#opt-services.linkwarden.enable).

- [Draupnir](https://github.com/the-draupnir-project/draupnir), a Matrix moderation bot. Available as [services.draupnir](#opt-services.draupnir.enable).

- [Pangolin](https://github.com/fosrl/pangolin), a tunneled reverse proxy server with access control. Available as [services.pangolin](#opt-services.pangolin.enable).

  ./services/web-apps/lemmy.nix

  ./services/web-apps/libretranslate.nix

  ./services/web-apps/limesurvey.nix

  ./services/web-apps/linkwarden.nix

  ./services/web-apps/mainsail.nix

  ./services/web-apps/mastodon.nix

  ./services/web-apps/matomo.nix

{

  lib,

  config,

  pkgs,

  ...

}:

let

  cfg = config.services.linkwarden;

  isPostgresUnixSocket = lib.hasPrefix "/" cfg.database.host;

  inherit (lib)

    types

    mkIf

    mkOption

    mkEnableOption

    ;

  commonServiceConfig = {

    Type = "simple";

    Restart = "on-failure";

    RestartSec = 3;

    EnvironmentFile = cfg.environmentFile;

    StateDirectory = "linkwarden";

    CacheDirectory = "linkwarden";

    User = cfg.user;

    Group = cfg.group;

    # Hardening

    CapabilityBoundingSet = "";

    NoNewPrivileges = true;

    PrivateUsers = true;

    PrivateTmp = true;

    PrivateDevices = true;

    PrivateMounts = true;

    ProtectClock = true;

    ProtectControlGroups = true;

    ProtectHome = true;

    ProtectHostname = true;

    ProtectKernelLogs = true;

    ProtectKernelModules = true;

    ProtectKernelTunables = true;

    RestrictAddressFamilies = [

      "AF_INET"

      "AF_INET6"

      "AF_UNIX"

    ];

    RestrictNamespaces = true;

    RestrictRealtime = true;

    RestrictSUIDSGID = true;

  };

  secret = types.nullOr (

    types.str

    // {

      # We don't want users to be able to pass a path literal here but

      # it should look like a path.

      check = it: lib.isString it && lib.types.path.check it;

    }

  );

  startupScript =

    arg:

    if cfg.secretFiles == { } then

      "${lib.getExe cfg.package}" + arg

    else

      pkgs.writeShellScript "linkwarden-env" ''

        ${lib.strings.concatStringsSep "\n" (

          lib.attrsets.mapAttrsToList (key: path: "export ${key}=$(< \"${path}\")") cfg.secretFiles

        )}

        ${lib.getExe cfg.package}${arg}

      '';

in

{

  options.services.linkwarden = {

    enable = mkEnableOption "Linkwarden";

    package = lib.mkPackageOption pkgs "linkwarden" { };

    storageLocation = mkOption {

      type = types.path;

      default = "/var/lib/linkwarden";

      description = "Directory used to store media files. If it is not the default, the directory has to be created manually such that the linkwarden user is able to read and write to it.";

    };

    cacheLocation = mkOption {

      type = types.path;

      default = "/var/cache/linkwarden";

      description = "Directory used as cache. If it is not the default, the directory has to be created manually such that the linkwarden user is able to read and write to it.";

    };

    enableRegistration = mkEnableOption "registration for new users";

    environment = mkOption {

      type = types.attrsOf types.str;

      default = { };

      example = {

        PAGINATION_TAKE_COUNT = "50";

      };

      description = ''

        Extra configuration environment variables. Refer to the [documentation](https://docs.linkwarden.app/self-hosting/environment-variables) for options.

      '';

    };

    environmentFile = mkOption {

      type = secret;

      example = "/run/secrets/linkwarden";

      default = null;

      description = ''

        Path of a file with extra environment variables to be loaded from disk.

        This file is not added to the nix store, so it can be used to pass secrets to linkwarden.

        Refer to the [documentation](https://docs.linkwarden.app/self-hosting/environment-variables) for options.

        Linkwarden needs at least a nextauth secret. To set a database password use POSTGRES_PASSWORD:

        ```

        NEXTAUTH_SECRET=<secret>

        POSTGRES_PASSWORD=<pass>

        ```

      '';

    };

    secretFiles = mkOption {

      type = types.attrsOf secret;

      example = {

        POSTGRES_PASSWORD = "/run/secrets/linkwarden_postgres_passwd";

        NEXTAUTH_SECRET = "/run/secrets/linkwarden_secret";

      };

      default = { };

      description = ''

        Attribute set containing paths to files to add to the environment of linkwarden.

        The files are not added to the nix store, so they can be used to pass secrets to linkwarden.

        Refer to the [documentation](https://docs.linkwarden.app/self-hosting/environment-variables) for options.

        Linkwarden needs at least a nextauth secret. To set a database password use POSTGRES_PASSWORD:

        ```

        NEXTAUTH_SECRET=<secret>

        POSTGRES_PASSWORD=<pass>

        ```

      '';

    };

    host = mkOption {

      type = types.str;

      default = "localhost";

      description = "The host that Linkwarden will listen on.";

    };

    port = mkOption {

      type = types.port;

      default = 3000;

      description = "The port that Linkwarden will listen on.";

    };

    openFirewall = mkOption {

      type = types.bool;

      default = false;

      description = "Whether to open the Linkwarden port in the firewall";

    };

    user = mkOption {

      type = types.str;

      default = "linkwarden";

      description = "The user Linkwarden should run as.";

    };

    group = mkOption {

      type = types.str;

      default = "linkwarden";

      description = "The group Linkwarden should run as.";

    };

    database = {

      createLocally = mkEnableOption "the automatic creation of the database for Linkwarden." // {

        default = true;

      };

      name = mkOption {

        type = types.str;

        default = "linkwarden";

        description = "The name of the Linkwarden database.";

      };

      host = mkOption {

        type = types.str;

        default = "/run/postgresql";

        example = "localhost";

        description = "Hostname or address of the postgresql server. If an absolute path is given here, it will be interpreted as a unix socket path.";

      };

      port = mkOption {

        type = types.port;

        default = 5432;

        description = "Port of the postgresql server.";

      };

      user = mkOption {

        type = types.str;

        default = "linkwarden";

        description = "The database user for Linkwarden.";

      };

    };

  };

  config = mkIf cfg.enable {

    assertions = [

      {

        assertion = cfg.database.createLocally -> cfg.database.name == cfg.database.user;

        message = "The postgres module requires the database name and the database user name to be the same.";

      }

      {

        assertion = cfg.environmentFile == null -> cfg.secretFiles ? "NEXTAUTH_SECRET";

        message = ''

          Linkwarden needs at least a nextauth secret to run.

          Use either the environmentFile or secretFiles.NEXTAUTH_SECRET to provide one.

        '';

      }

    ];

    services.postgresql = mkIf cfg.database.createLocally {

      enable = true;

      ensureDatabases = [ cfg.database.name ];

      ensureUsers = [

        {

          name = cfg.database.user;

          ensureDBOwnership = true;

          ensureClauses.login = true;

        }

      ];

    };

    networking.firewall.allowedTCPPorts = mkIf cfg.openFirewall [ cfg.port ];

    services.linkwarden.environment = {

      LINKWARDEN_HOST = cfg.host;

      LINKWARDEN_PORT = toString cfg.port;

      LINKWARDEN_CACHE_DIR = cfg.cacheLocation;

      STORAGE_FOLDER = cfg.storageLocation;

      NEXT_PUBLIC_DISABLE_REGISTRATION = mkIf (!cfg.enableRegistration) "true";

      NEXT_TELEMETRY_DISABLED = "1";

      DATABASE_URL = mkIf isPostgresUnixSocket "postgresql://${lib.strings.escapeURL cfg.database.user}@localhost/${lib.strings.escapeURL cfg.database.name}?host=${cfg.database.host}";

      DATABASE_PORT = toString cfg.database.port;

      DATABASE_HOST = mkIf (!isPostgresUnixSocket) cfg.database.host;

      DATABASE_NAME = cfg.database.name;

      DATABASE_USER = cfg.database.user;

    };

    systemd.services.linkwarden = {

      description = "Linkwarden (Self-hosted collaborative bookmark manager to collect, organize, and preserve webpages, articles, and more...)";

      requires = [

        "network-online.target"

      ]

      ++ lib.optionals cfg.database.createLocally [ "postgresql.service" ];

      after = [

        "network-online.target"

      ]

      ++ lib.optionals cfg.database.createLocally [ "postgresql.service" ];

      wantedBy = [ "multi-user.target" ];

      environment = cfg.environment // {

        # Required, otherwise chrome dumps core

        CHROME_CONFIG_HOME = cfg.cacheLocation;

      };

      serviceConfig = commonServiceConfig // {

        ExecStart = startupScript "";

      };

    };

    systemd.services.linkwarden-worker = {

      description = "Linkwarden (worker process)";

      requires = [

        "network-online.target"

        "linkwarden.service"

      ]

      ++ lib.optionals cfg.database.createLocally [ "postgresql.service" ];

      after = [

        "network-online.target"

        "linkwarden.service"

      ]

      ++ lib.optionals cfg.database.createLocally [ "postgresql.service" ];

      wantedBy = [ "multi-user.target" ];

      environment = cfg.environment // {

        # Required, otherwise chrome dumps core

        CHROME_CONFIG_HOME = cfg.cacheLocation;

      };

      serviceConfig = commonServiceConfig // {

        ExecStart = startupScript " worker";

      };

    };

    users.users = mkIf (cfg.user == "linkwarden") {

      linkwarden = {

        name = "linkwarden";

        group = cfg.group;

        isSystemUser = true;

      };

    };

    users.groups = mkIf (cfg.group == "linkwarden") { linkwarden = { }; };

    meta.maintainers = with lib.maintainers; [ jvanbruegge ];

  };

}

  lighttpd = runTest ./lighttpd.nix;

  limesurvey = runTest ./limesurvey.nix;

  limine = import ./limine { inherit runTest; };

  linkwarden = runTest ./web-apps/linkwarden.nix;

  listmonk = handleTestOn [ "x86_64-linux" "aarch64-linux" ] ./listmonk.nix { };

  litellm = runTest ./litellm.nix;

  litestream = runTest ./litestream.nix;

{ ... }:

{

  name = "linkwarden-nixos";

  nodes.machine =

    { pkgs, ... }:

    let

      secretsFile = pkgs.writeText "linkwarden-secret-env" ''

        VERY_SENSITIVE_SECRET

      '';

      webroot = pkgs.runCommand "webroot" { } ''

        mkdir $out

        cd $out

        echo '<!DOCTYPE html><html><body><h1>HELLO LINKWARDEN</h1></body></html>' > index.html

      '';

    in

    {

      services.linkwarden = {

        enable = true;

        enableRegistration = true;

        secretFiles = {

          NEXTAUTH_SECRET = toString secretsFile;

        };

        environment = {

          NEXTAUTH_URL = "http://localhost:3000/api/v1/auth";

        };

      };

      services.nginx = {

        enable = true;

        virtualHosts.localhost.root = webroot;

      };

    };

  testScript = ''

    import json

    machine.wait_for_unit("linkwarden.service")

    machine.wait_for_unit("linkwarden-worker.service")

    machine.wait_for_open_port(3000)

    machine.succeed("curl --fail -s http://localhost:3000/")

    machine.succeed("curl -L --fail -s --data '{\"name\":\"Admin\",\"username\":\"admin\",\"password\":\"adminadmin\"}' -H 'Content-Type: application/json' -X POST http://localhost:3000/api/v1/users")

    response = machine.succeed("curl -L --fail -s -c next_cookies.txt -H 'Content-Type: application/json' -X GET http://localhost:3000/api/v1/auth/csrf")

    csrfToken = json.loads(response)['csrfToken']

    machine.succeed("curl -L --fail -s -b next_cookies.txt -c next_cookies.txt -H 'Content-Type: application/x-www-form-urlencoded' --data-urlencode 'username=admin' --data-urlencode 'password=adminadmin' --data-urlencode 'csrfToken=%s' http://localhost:3000/api/v1/auth/callback/credentials" % csrfToken)

    curlCmd = "curl -L --fail -s -b next_cookies.txt -H 'Content-Type: application/json' "

    machine.succeed(curlCmd + "--data '{\"url\":\"http://localhost/\"}' -X POST http://localhost:3000/api/v1/links")

    machine.succeed(curlCmd + "-X GET http://localhost:3000/api/v1/links")

    machine.wait_for_file("/var/lib/linkwarden/archives/1/1.html")

    machine.succeed("grep -q '<h1>HELLO LINKWARDEN</h1>' </var/lib/linkwarden/archives/1/1.html")

  '';

}