chatgpt-retrieval-plugin: init module (5ba4f429) · Commits · nix / nixpkgs

nixos/modules/module-list.nix

+1 −0

Original line number	Diff line number	Diff line
		@@ -1138,6 +1138,7 @@
		./services/web-apps/calibre-web.nix
		./services/web-apps/coder.nix
		./services/web-apps/changedetection-io.nix
		./services/web-apps/chatgpt-retrieval-plugin.nix
		./services/web-apps/cloudlog.nix
		./services/web-apps/code-server.nix
		./services/web-apps/convos.nix

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

0 → 100644

+106 −0

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 (lib.mdDoc "chatgpt-retrieval-plugin service");

		port = mkOption {
		type = types.port;
		default = 8080;
		description = lib.mdDoc "Port the chatgpt-retrieval-plugin service listens on.";
		};

		host = mkOption {
		type = types.str;
		default = "127.0.0.1";
		example = "0.0.0.0";
		description = lib.mdDoc "The hostname or IP address for chatgpt-retrieval-plugin to bind to.";
		};

		bearerTokenPath = mkOption {
		type = types.path;
		description = lib.mdDoc ''
		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 = lib.mdDoc ''
		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 = lib.mdDoc "This specifies the vector database provider you want to use to store and query embeddings.";
		};

		qdrantCollection = mkOption {
		type = types.str;
		description = lib.mdDoc ''
		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"
		];
		};
		}

pkgs/servers/chatgpt-retrieval-plugin/default.nix

+10 −2

Original line number	Diff line number	Diff line
		@@ -3,6 +3,7 @@
		, fetchFromGitHub
		, python3
		, nix-update-script
		, dasel
		}:

		python3Packages.buildPythonApplication {
		@@ -22,14 +23,21 @@ python3Packages.buildPythonApplication {
		substituteInPlace pyproject.toml \
		--replace 'python-dotenv = "^0.21.1"' 'python-dotenv = "*"' \
		--replace 'python-multipart = "^0.0.6"' 'python-multipart = "^0.0.5"' \
		--replace 'tiktoken = "^0.2.0"' 'tiktoken = "^0.3.0"'
		--replace 'tiktoken = "^0.2.0"' 'tiktoken = "^0.3.0"' \
		--replace 'packages = [{include = "server"}]' 'packages = [{include = "server"}, {include = "models"}, {include = "datastore"}, {include = "services"}]'

		substituteInPlace server/main.py \
		--replace 'directory=".well-known"' 'directory="/var/lib/chatgpt-retrieval-plugin/.well-known"' \
		--replace '0.0.0.0' '127.0.0.1' \
		--replace '8000' '8080'

		${dasel}/bin/dasel put -t string -f pyproject.toml -v '.well-known/*' '.tool.poetry.include.[]'
		'';

		nativeBuildInputs = with python3Packages; [
		poetry-core
		];


		propagatedBuildInputs = with python3.pkgs; [
		fastapi
		arrow

Admin message