Unverified Commit 01cb0dae authored by Michael Daniels's avatar Michael Daniels
Browse files

nixos/chatgpt-retrieval-plugin: drop 

Corresponding package has been marked broken for a full release cycle.

Dropping per RFC 180.
parent 7ca55048

nixos/doc/manual/release-notes/rl-2511.section.md

+2 −0
Original line number Diff line number Diff line
@@ -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.

nixos/modules/module-list.nix

+0 −1
Original line number Diff line number Diff line
@@ -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

nixos/modules/rename.nix

+4 −0
Original line number Diff line number Diff line
@@ -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"

nixos/modules/services/web-apps/chatgpt-retrieval-plugin.nix

deleted100644 → 0
+0 −118
Original line number Diff line number Diff line 
{

  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"

    ];

  };

}