nixos/websurfx: init module (#471684)

2026-03-18 23:45:32 +00:00
parent 115098b2b0 b99f23b3f6
commit c6ea892dbf
2 changed files with 116 additions and 0 deletions
@@ -1780,6 +1780,7 @@
  ./services/web-apps/vikunja.nix
  ./services/web-apps/wakapi.nix
  ./services/web-apps/weblate.nix
+  ./services/web-apps/websurfx.nix
  ./services/web-apps/whitebophir.nix
  ./services/web-apps/whoami.nix
  ./services/web-apps/wiki-js.nix
@@ -0,0 +1,115 @@
+{
+  config,
+  lib,
+  pkgs,
+  ...
+}:
+
+let
+  cfg = config.services.websurfx;
+  settingsFormat = pkgs.formats.lua { asBindings = true; };
+  settingsFile = settingsFormat.generate "config.lua" cfg.settings;
+in
+{
+  options = {
+    services.websurfx = {
+      enable = lib.mkEnableOption "Websurfx, a metasearch engine";
+      package = lib.mkPackageOption pkgs "websurfx" { };
+      openFirewall = lib.mkEnableOption "Whether to open the used port in the firewall";
+      settings = lib.mkOption {
+        type = lib.types.submodule {
+          freeformType = settingsFormat.type;
+
+          options.binding_ip = lib.mkOption {
+            type = lib.types.str;
+            default = "127.0.0.1";
+            description = "IP address on which the server should be launched";
+          };
+          options.port = lib.mkOption {
+            type = lib.types.port;
+            default = 4567;
+            description = "Port on which the server should be launched";
+          };
+        };
+        default = { };
+        description = ''
+          Configuration options for Websurfx, see
+          [websurfx/config.lua](https://github.com/neon-mmd/websurfx/blob/rolling/websurfx/config.lua)
+          for supported values.
+        '';
+      };
+    };
+  };
+
+  config = lib.mkIf cfg.enable {
+    services.websurfx.settings = {
+      # General
+      logging = lib.mkDefault true;
+      debug = lib.mkDefault false;
+      threads = lib.mkDefault 10;
+
+      # Server
+      production_use = lib.mkDefault false;
+      request_timeout = lib.mkDefault 30;
+      tcp_connection_keep_alive = lib.mkDefault 30;
+      pool_idle_connection_timeout = lib.mkDefault 30;
+      rate_limiter = {
+        number_of_requests = lib.mkDefault 20;
+        time_limit = lib.mkDefault 3;
+      };
+      https_adaptive_window_size = lib.mkDefault true;
+
+      operating_system_tls_certificates = lib.mkDefault true;
+
+      number_of_https_connections = lib.mkDefault 10;
+      client_connection_keep_alive = lib.mkDefault 120;
+
+      # Search
+      safe_search = lib.mkDefault 2;
+
+      # Website
+      colorscheme = lib.mkDefault "catppuccin-mocha";
+      theme = lib.mkDefault "simple";
+      animation = lib.mkDefault "simple-frosted-glow";
+
+      # Caching
+      #redis_url = "redis://127.0.0.1:8082"; # The nixpkgs build doesn't have the redis-cache feature enabled
+      cache_expiry_time = lib.mkDefault 600;
+
+      # Search Engines
+      upstream_search_engines = {
+        DuckDuckGo = lib.mkDefault true;
+        Searx = lib.mkDefault false;
+        Brave = lib.mkDefault false;
+        Startpage = lib.mkDefault false;
+        LibreX = lib.mkDefault false;
+        Mojeek = lib.mkDefault false;
+        Bing = lib.mkDefault false;
+        Wikipedia = lib.mkDefault true;
+        Yahoo = lib.mkDefault false;
+      };
+
+      proxy = lib.mkDefault null;
+    };
+
+    networking.firewall.allowedTCPPorts = lib.mkIf cfg.openFirewall [ cfg.settings.port ];
+
+    systemd.services.websurfx = {
+      description = "Websurfx, a metasearch engine";
+
+      serviceConfig = {
+        ExecStart = lib.getExe cfg.package;
+        DynamicUser = true;
+        RuntimeDirectory = "websurfx";
+        Environment = [ "HOME=%t/websurfx" ];
+        BindReadOnlyPaths = [ "${settingsFile}:%t/websurfx/.config/websurfx/config.lua" ];
+      };
+
+      wants = [ "network-online.target" ];
+      after = [ "network-online.target" ];
+      wantedBy = [ "multi-user.target" ];
+    };
+  };
+
+  meta.maintainers = [ lib.maintainers.SchweGELBin ];
+}