diff --git a/nixos/doc/manual/release-notes/rl-2511.section.md b/nixos/doc/manual/release-notes/rl-2511.section.md index 43633514305d..c9d6ba99a724 100644 --- a/nixos/doc/manual/release-notes/rl-2511.section.md +++ b/nixos/doc/manual/release-notes/rl-2511.section.md @@ -176,6 +176,8 @@ - `programs.goldwarden` has been removed, due to the software not working with newer versions of the Bitwarden and Vaultwarden servers, as well as it being abandoned upstream. +- The `chatgpt-retrieval-plugin` package and `services.chatgpt-retrieval-plugin` module were removed due to the package having been broken since at least November 2024. + - The `cardboard` package and `programs.cardboard` module were removed due to the package having been broken since at least November 2024. - The default `kops` version is now 1.33.0 and versions 1.30 and older have been dropped. See [Upgrading Kubernetes](https://kops.sigs.k8s.io/tutorial/upgrading-kubernetes/) for instructions on how to update kOps. diff --git a/nixos/modules/module-list.nix b/nixos/modules/module-list.nix index 9507f4472eb9..6b10044e8f50 100644 --- a/nixos/modules/module-list.nix +++ b/nixos/modules/module-list.nix @@ -1552,7 +1552,6 @@ ./services/web-apps/calibre-web.nix ./services/web-apps/castopod.nix ./services/web-apps/changedetection-io.nix - ./services/web-apps/chatgpt-retrieval-plugin.nix ./services/web-apps/chhoto-url.nix ./services/web-apps/cloudlog.nix ./services/web-apps/code-server.nix diff --git a/nixos/modules/rename.nix b/nixos/modules/rename.nix index c7e541c8a628..d72f1a9c9211 100644 --- a/nixos/modules/rename.nix +++ b/nixos/modules/rename.nix @@ -113,6 +113,10 @@ in "cgmanager" "enable" ] "cgmanager was deprecated by lxc and therefore removed from nixpkgs.") + (mkRemovedOptionModule [ + "services" + "chatgpt-retrieval-plugin" + ] "The corresponding package was removed from nixpkgs.") (mkRemovedOptionModule [ "services" "chronos" diff --git a/nixos/modules/services/web-apps/chatgpt-retrieval-plugin.nix b/nixos/modules/services/web-apps/chatgpt-retrieval-plugin.nix deleted file mode 100644 index dba076436df7..000000000000 --- a/nixos/modules/services/web-apps/chatgpt-retrieval-plugin.nix +++ /dev/null @@ -1,118 +0,0 @@ -{ - config, - pkgs, - lib, - ... -}: - -with lib; - -let - cfg = config.services.chatgpt-retrieval-plugin; -in -{ - options.services.chatgpt-retrieval-plugin = { - enable = mkEnableOption "chatgpt-retrieval-plugin service"; - - port = mkOption { - type = types.port; - default = 8080; - description = "Port the chatgpt-retrieval-plugin service listens on."; - }; - - host = mkOption { - type = types.str; - default = "127.0.0.1"; - example = "0.0.0.0"; - description = "The hostname or IP address for chatgpt-retrieval-plugin to bind to."; - }; - - bearerTokenPath = mkOption { - type = types.path; - description = '' - Path to the secret bearer token used for the http api authentication. - ''; - default = ""; - example = "config.age.secrets.CHATGPT_RETRIEVAL_PLUGIN_BEARER_TOKEN.path"; - }; - - openaiApiKeyPath = mkOption { - type = types.path; - description = '' - Path to the secret openai api key used for embeddings. - ''; - default = ""; - example = "config.age.secrets.CHATGPT_RETRIEVAL_PLUGIN_OPENAI_API_KEY.path"; - }; - - datastore = mkOption { - type = types.enum [ - "pinecone" - "weaviate" - "zilliz" - "milvus" - "qdrant" - "redis" - ]; - default = "qdrant"; - description = "This specifies the vector database provider you want to use to store and query embeddings."; - }; - - qdrantCollection = mkOption { - type = types.str; - description = '' - name of the qdrant collection used to store documents. - ''; - default = "document_chunks"; - }; - }; - - config = mkIf cfg.enable { - - assertions = [ - { - assertion = cfg.bearerTokenPath != ""; - message = "services.chatgpt-retrieval-plugin.bearerTokenPath should not be an empty string."; - } - { - assertion = cfg.openaiApiKeyPath != ""; - message = "services.chatgpt-retrieval-plugin.openaiApiKeyPath should not be an empty string."; - } - ]; - - systemd.services.chatgpt-retrieval-plugin = { - description = "ChatGPT Retrieval Plugin"; - after = [ "network.target" ]; - wantedBy = [ "multi-user.target" ]; - - serviceConfig = { - DynamicUser = true; - Restart = "always"; - LoadCredential = [ - "BEARER_TOKEN:${cfg.bearerTokenPath}" - "OPENAI_API_KEY:${cfg.openaiApiKeyPath}" - ]; - StateDirectory = "chatgpt-retrieval-plugin"; - StateDirectoryMode = "0755"; - }; - - # it doesn't make sense to pass secrets as env vars, this is a hack until - # upstream has proper secret management. - script = '' - export BEARER_TOKEN=$(${pkgs.systemd}/bin/systemd-creds cat BEARER_TOKEN) - export OPENAI_API_KEY=$(${pkgs.systemd}/bin/systemd-creds cat OPENAI_API_KEY) - exec ${pkgs.chatgpt-retrieval-plugin}/bin/start --host ${cfg.host} --port ${toString cfg.port} - ''; - - environment = { - DATASTORE = cfg.datastore; - QDRANT_COLLECTION = mkIf (cfg.datastore == "qdrant") cfg.qdrantCollection; - }; - }; - - systemd.tmpfiles.rules = [ - # create the directory for static files for fastapi - "C /var/lib/chatgpt-retrieval-plugin/.well-known - - - - ${pkgs.chatgpt-retrieval-plugin}/${pkgs.python3Packages.python.sitePackages}/.well-known" - ]; - }; -}