Merge pull request #303388 from SuperSandro2000/paperless-only-enabled-languages

nixos/paperless: override enabled tesseract languages with the in paperless configured ones

authored by Leona Maroni and committed by GitHub 025d3a2f b2307803

+30 -18
+24 -15
nixos/modules/services/misc/paperless.nix
··· 3 3 with lib; 4 4 let 5 5 cfg = config.services.paperless; 6 - pkg = cfg.package; 7 6 8 7 defaultUser = "paperless"; 9 8 defaultFont = "${pkgs.liberation_ttf}/share/fonts/truetype/LiberationSerif-Regular.ttf"; ··· 25 24 } // optionalAttrs (cfg.settings.PAPERLESS_ENABLE_NLTK or true) { 26 25 PAPERLESS_NLTK_DIR = pkgs.symlinkJoin { 27 26 name = "paperless_ngx_nltk_data"; 28 - paths = pkg.nltkData; 27 + paths = cfg.package.nltkData; 29 28 }; 30 29 } // optionalAttrs (cfg.openMPThreadingWorkaround) { 31 30 OMP_NUM_THREADS = "1"; ··· 38 37 manage = pkgs.writeShellScript "manage" '' 39 38 set -o allexport # Export the following env vars 40 39 ${lib.toShellVars env} 41 - exec ${pkg}/bin/paperless-ngx "$@" 40 + exec ${cfg.package}/bin/paperless-ngx "$@" 42 41 ''; 43 42 44 43 # Secure the services ··· 200 199 description = "User under which Paperless runs."; 201 200 }; 202 201 203 - package = mkPackageOption pkgs "paperless-ngx" { }; 202 + package = mkPackageOption pkgs "paperless-ngx" { } // { 203 + apply = pkg: pkg.override { 204 + tesseract5 = pkg.tesseract5.override { 205 + # always enable detection modules 206 + enableLanguages = if cfg.settings ? PAPERLESS_OCR_LANGUAGE then 207 + [ "equ" "osd" ] 208 + ++ lib.splitString "+" cfg.settings.PAPERLESS_OCR_LANGUAGE 209 + else null; 210 + }; 211 + }; 212 + }; 204 213 205 214 openMPThreadingWorkaround = mkEnableOption '' 206 215 a workaround for document classifier timeouts. ··· 237 246 wants = [ "paperless-consumer.service" "paperless-web.service" "paperless-task-queue.service" ]; 238 247 serviceConfig = defaultServiceConfig // { 239 248 User = cfg.user; 240 - ExecStart = "${pkg}/bin/celery --app paperless beat --loglevel INFO"; 249 + ExecStart = "${cfg.package}/bin/celery --app paperless beat --loglevel INFO"; 241 250 Restart = "on-failure"; 242 251 LoadCredential = lib.optionalString (cfg.passwordFile != null) "PAPERLESS_ADMIN_PASSWORD:${cfg.passwordFile}"; 243 252 }; ··· 250 259 versionFile="${cfg.dataDir}/src-version" 251 260 version=$(cat "$versionFile" 2>/dev/null || echo 0) 252 261 253 - if [[ $version != ${pkg.version} ]]; then 254 - ${pkg}/bin/paperless-ngx migrate 262 + if [[ $version != ${cfg.package.version} ]]; then 263 + ${cfg.package}/bin/paperless-ngx migrate 255 264 256 265 # Parse old version string format for backwards compatibility 257 266 version=$(echo "$version" | grep -ohP '[^-]+$') ··· 264 273 if versionLessThan 1.12.0; then 265 274 # Reindex documents as mentioned in https://github.com/paperless-ngx/paperless-ngx/releases/tag/v1.12.1 266 275 echo "Reindexing documents, to allow searching old comments. Required after the 1.12.x upgrade." 267 - ${pkg}/bin/paperless-ngx document_index reindex 276 + ${cfg.package}/bin/paperless-ngx document_index reindex 268 277 fi 269 278 270 - echo ${pkg.version} > "$versionFile" 279 + echo ${cfg.package.version} > "$versionFile" 271 280 fi 272 281 '' 273 282 + optionalString (cfg.passwordFile != null) '' ··· 277 286 superuserStateFile="${cfg.dataDir}/superuser-state" 278 287 279 288 if [[ $(cat "$superuserStateFile" 2>/dev/null) != $superuserState ]]; then 280 - ${pkg}/bin/paperless-ngx manage_superuser 289 + ${cfg.package}/bin/paperless-ngx manage_superuser 281 290 echo "$superuserState" > "$superuserStateFile" 282 291 fi 283 292 ''; ··· 290 299 after = [ "paperless-scheduler.service" ]; 291 300 serviceConfig = defaultServiceConfig // { 292 301 User = cfg.user; 293 - ExecStart = "${pkg}/bin/celery --app paperless worker --loglevel INFO"; 302 + ExecStart = "${cfg.package}/bin/celery --app paperless worker --loglevel INFO"; 294 303 Restart = "on-failure"; 295 304 # The `mbind` syscall is needed for running the classifier. 296 305 SystemCallFilter = defaultServiceConfig.SystemCallFilter ++ [ "mbind" ]; ··· 308 317 after = [ "paperless-scheduler.service" ]; 309 318 serviceConfig = defaultServiceConfig // { 310 319 User = cfg.user; 311 - ExecStart = "${pkg}/bin/paperless-ngx document_consumer"; 320 + ExecStart = "${cfg.package}/bin/paperless-ngx document_consumer"; 312 321 Restart = "on-failure"; 313 322 }; 314 323 environment = env; ··· 340 349 echo "PAPERLESS_SECRET_KEY is empty, refusing to start." 341 350 exit 1 342 351 fi 343 - exec ${pkg.python.pkgs.gunicorn}/bin/gunicorn \ 344 - -c ${pkg}/lib/paperless-ngx/gunicorn.conf.py paperless.asgi:application 352 + exec ${cfg.package.python.pkgs.gunicorn}/bin/gunicorn \ 353 + -c ${cfg.package}/lib/paperless-ngx/gunicorn.conf.py paperless.asgi:application 345 354 ''; 346 355 serviceConfig = defaultServiceConfig // { 347 356 User = cfg.user; ··· 357 366 CapabilityBoundingSet = [ "CAP_NET_BIND_SERVICE" ]; 358 367 }; 359 368 environment = env // { 360 - PYTHONPATH = "${pkg.python.pkgs.makePythonPath pkg.propagatedBuildInputs}:${pkg}/lib/paperless-ngx/src"; 369 + PYTHONPATH = "${cfg.package.python.pkgs.makePythonPath cfg.package.propagatedBuildInputs}:${cfg.package}/lib/paperless-ngx/src"; 361 370 }; 362 371 # Allow the web interface to access the private /tmp directory of the server. 363 372 # This is required to support uploading files via the web interface.
+6 -3
pkgs/applications/office/paperless-ngx/default.nix
··· 37 37 # https://github.com/NixOS/nixpkgs/issues/298719 38 38 # https://github.com/paperless-ngx/paperless-ngx/issues/5494 39 39 python = python3.override { 40 - packageOverrides = self: super: { 41 - uvicorn = super.uvicorn.overridePythonAttrs (oldAttrs: { 40 + packageOverrides = final: prev: { 41 + # tesseract5 may be overwritten in the paperless module and we need to propagate that to make the closure reduction effective 42 + ocrmypdf = prev.ocrmypdf.override { tesseract = tesseract5; }; 43 + 44 + uvicorn = prev.uvicorn.overridePythonAttrs (_: { 42 45 version = "0.25.0"; 43 46 src = fetchFromGitHub { 44 47 owner = "encode"; ··· 245 248 doCheck = !stdenv.isDarwin; 246 249 247 250 passthru = { 248 - inherit python path frontend; 251 + inherit python path frontend tesseract5; 249 252 nltkData = with nltk-data; [ punkt snowball_data stopwords ]; 250 253 tests = { inherit (nixosTests) paperless; }; 251 254 };