From f3f246d798f965276448ad580caa71b48790b587 Mon Sep 17 00:00:00 2001 From: eikek Date: Sun, 10 Mar 2024 10:22:36 +0100 Subject: [PATCH] Rename server -> restserver in nix setup While I'd like to rename it the other way around, it would be a much more breaking change. So for now, this way. --- flake.nix | 14 +++++++------- nix/docker.nix | 6 +++--- nix/modules/server.nix | 4 ++-- nix/pkg.nix | 5 +++-- website/site/content/docs/install/nix.md | 8 ++++---- 5 files changed, 19 insertions(+), 18 deletions(-) diff --git a/flake.nix b/flake.nix index c2ae0178..b8a8cdc0 100644 --- a/flake.nix +++ b/flake.nix @@ -33,31 +33,31 @@ ]; docspellPkgs = pkgs.callPackage (import ./nix/pkg.nix) {}; dockerAmd64 = pkgs.pkgsCross.gnu64.callPackage (import ./nix/docker.nix) { - inherit (docspellPkgs) docspell-server docspell-joex; + inherit (docspellPkgs) docspell-restserver docspell-joex; }; dockerArm64 = pkgs.pkgsCross.aarch64-multiplatform.callPackage (import ./nix/docker.nix) { - inherit (docspellPkgs) docspell-server docspell-joex; + inherit (docspellPkgs) docspell-restserver docspell-joex; }; in { formatter = pkgs.alejandra; packages = { - inherit (docspellPkgs) docspell-server docspell-joex; + inherit (docspellPkgs) docspell-restserver docspell-joex; }; legacyPackages = { docker = { amd64 = { - inherit (dockerAmd64) docspell-server docspell-joex; + inherit (dockerAmd64) docspell-restserver docspell-joex; }; arm64 = { - inherit (dockerArm64) docspell-server docspell-joex; + inherit (dockerArm64) docspell-restserver docspell-joex; }; }; }; checks = { - build-server = self.packages.${system}.docspell-server; + build-server = self.packages.${system}.docspell-restserver; build-joex = self.packages.${system}.docspell-joex; test = with import (nixpkgs + "/nixos/lib/testing-python.nix") @@ -117,7 +117,7 @@ overlays.default = final: prev: let docspellPkgs = final.callPackage (import ./nix/pkg.nix) {}; in { - inherit (docspellPkgs) docspell-server docspell-joex; + inherit (docspellPkgs) docspell-restserver docspell-joex; }; nixosConfigurations = { diff --git a/nix/docker.nix b/nix/docker.nix index d0e69596..29e9f870 100644 --- a/nix/docker.nix +++ b/nix/docker.nix @@ -9,7 +9,7 @@ tesseract4, python3Packages, unoconv, - docspell-server, + docspell-restserver, docspell-joex, }: let mkImage = { @@ -64,10 +64,10 @@ tag = "v${pkg.version}"; }; in { - docspell-server = mkImage { + docspell-restserver = mkImage { name = "docspell-restserver"; port = 7880; - pkg = docspell-server; + pkg = docspell-restserver; tools = []; }; docspell-joex = mkImage { diff --git a/nix/modules/server.nix b/nix/modules/server.nix index 925c2352..0943e42e 100644 --- a/nix/modules/server.nix +++ b/nix/modules/server.nix @@ -12,7 +12,7 @@ with lib; let if cfg.runAs == null then "docspell" else cfg.runAs; - configFile = pkgs.writeText "docspell-server.conf" '' + configFile = pkgs.writeText "docspell-restserver.conf" '' {"docspell": {"server": ${builtins.toJSON (lib.recursiveUpdate declared_config cfg.extraConfig)} }} @@ -878,7 +878,7 @@ in { systemd.services.docspell-restserver = let args = builtins.concatStringsSep " " cfg.jvmArgs; - cmd = "${pkgs.docspell-server}/bin/docspell-restserver ${args} -- ${configFile}"; + cmd = "${pkgs.docspell-restserver}/bin/docspell-restserver ${args} -- ${configFile}"; in { description = "Docspell Rest Server"; after = ["networking.target"]; diff --git a/nix/pkg.nix b/nix/pkg.nix index 1b5733ba..a37db9c2 100644 --- a/nix/pkg.nix +++ b/nix/pkg.nix @@ -14,9 +14,9 @@ sha256 = "sha256-flKWjEsMd2/XT3Bu6EjFgf3lCojvLbKFDEXemP1K+/8="; }; in { - docspell-server = stdenv.mkDerivation { + docspell-restserver = stdenv.mkDerivation { inherit version; - pname = "docspell-server"; + pname = "docspell-restserver"; src = fetchzip server; buildInputs = [jdk17]; @@ -30,6 +30,7 @@ in { $out/docspell-restserver-${version}/bin/docspell-restserver -java-home ${jdk17} "\$@" EOF chmod 755 $out/bin/docspell-restserver + ''; }; diff --git a/website/site/content/docs/install/nix.md b/website/site/content/docs/install/nix.md index dce291d5..be705a14 100644 --- a/website/site/content/docs/install/nix.md +++ b/website/site/content/docs/install/nix.md @@ -14,7 +14,7 @@ described below. You can try out the server and joex packages by running the following: ``` -nix run github:eikek/docspell#docspell-server +nix run github:eikek/docspell#docspell-restserver nix run github:eikek/docspell#docspell-joex ``` @@ -42,7 +42,7 @@ from this repository. You could install the server and joex by running the following: ``` -nix profile install github:eikek/docspell#docspell-server +nix profile install github:eikek/docspell#docspell-restserver nix profile install github:eikek/docspell#docspell-joex ``` @@ -184,7 +184,7 @@ You can also look at `nix/test-vm.nix` for another example. ## Without Flakes Of course, you can also use it without flakes. There is `nix/pkg.nix` -which contains the derivation of both packages, `docspell-server` and +which contains the derivation of both packages, `docspell-restserver` and `docspell-joex`. Just call it with your nixpkgs instance as usual: ``` nix @@ -196,7 +196,7 @@ let docspellPkgs = pkgs.callPackage (import "${repo}/nix/pkg.nix") {}; in # - # use docspellPkgs.docspell-server or docspellPkgs.docspell-joex + # use docspellPkgs.docspell-restserver or docspellPkgs.docspell-joex # ```