commit b62d48b28175c876a90e0b12dd3c6a2ae9f66b05 · pyrox.dev/nixpkgs

+34

nixos/modules/services/misc/paperless.nix

···

       323
        
             };

     

       324
        
           };

     

       325
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       326
        
           exporter = {

     

       327
        
             enable = lib.mkEnableOption "regular automatic document exports";

     

       328
        
       

     
···

       380
        
               services.paperless.manage = manage;

     

       381
        
               environment.systemPackages = [ manage ];

     

       382
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       383
        
               services.redis.servers.paperless.enable = lib.mkIf enableRedis true;

     

       384
        
       

     

       385
        
               services.postgresql = lib.mkIf cfg.database.createLocally {

     
···

       394
        
               };

     

       395
        
       

     

       396
        
               services.paperless.settings = lib.mkMerge [

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       397
        
                 (lib.mkIf cfg.database.createLocally {

     

       398
        
                   PAPERLESS_DBENGINE = "postgresql";

     

       399
        
                   PAPERLESS_DBHOST = "/run/postgresql";

···

       323
        
             };

     

       324
        
           };

     

       325
        
       

     

       326
       +
           configureNginx = lib.mkEnableOption "" // {

     

       327
       +
             description = "Whether to configure nginx as a reverse proxy.";

     

       328
       +
           };

     

       329
       +
       

     

       330
       +
           domain = lib.mkOption {

     

       331
       +
             type = lib.types.str;

     

       332
       +
             example = "paperless.example.com";

     

       333
       +
             description = "Domain under which paperless will be available.";

     

       334
       +
           };

     

       335
       +
       

     

       336
        
           exporter = {

     

       337
        
             enable = lib.mkEnableOption "regular automatic document exports";

     

       338
        
       

     
···

       390
        
               services.paperless.manage = manage;

     

       391
        
               environment.systemPackages = [ manage ];

     

       392
        
       

     

       393
       +
               services.nginx = lib.mkIf cfg.configureNginx {

     

       394
       +
                 enable = true;

     

       395
       +
                 upstreams.paperless.servers."${cfg.address}:${toString cfg.port}" = { };

     

       396
       +
                 virtualHosts.${cfg.domain} = {

     

       397
       +
                   forceSSL = lib.mkDefault true;

     

       398
       +
                   locations = {

     

       399
       +
                     "/".proxyPass = "http://paperless";

     

       400
       +
                     "/static/" = {

     

       401
       +
                       root = config.services.paperless.package;

     

       402
       +
                       extraConfig = ''

     

       403
       +
                         rewrite ^/(.*)$ /lib/paperless-ngx/$1 break;

     

       404
       +
                       '';

     

       405
       +
                     };

     

       406
       +
                     "/ws/status" = {

     

       407
       +
                       proxyPass = "http://paperless";

     

       408
       +
                       proxyWebsockets = true;

     

       409
       +
                     };

     

       410
       +
                   };

     

       411
       +
                 };

     

       412
       +
               };

     

       413
       +
       

     

       414
        
               services.redis.servers.paperless.enable = lib.mkIf enableRedis true;

     

       415
        
       

     

       416
        
               services.postgresql = lib.mkIf cfg.database.createLocally {

     
···

       425
        
               };

     

       426
        
       

     

       427
        
               services.paperless.settings = lib.mkMerge [

     

       428
       +
                 (lib.mkIf (cfg.domain != "") {

     

       429
       +
                   PAPERLESS_URL = "https://${cfg.domain}";

     

       430
       +
                 })

     

       431
        
                 (lib.mkIf cfg.database.createLocally {

     

       432
        
                   PAPERLESS_DBENGINE = "postgresql";

     

       433
        
                   PAPERLESS_DBHOST = "/run/postgresql";

+27 -24

nixos/tests/paperless.nix

···

       17
        
                     imagemagick

     

       18
        
                     jq

     

       19
        
                   ];

     

       20
       -
                   services.paperless = {

     

       21
       -
                     enable = true;

     

       22
       -
                     passwordFile = builtins.toFile "password" "admin";

     

       23
       -
       

     

       24
       -
                     exporter = {

     

       25
        
                       enable = true;

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       26
        
       

     

       27
       -
                       settings = {

     

       28
       -
                         "no-color" = lib.mkForce false; # override a default option

     

       29
       -
                         "no-thumbnail" = true; # add a new option

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       30
        
                       };

     

       31
        
                     };

     

       32
        
                   };

     

       33
        
                 };

     

       34
       -
               postgres =

     

       35
       -
                 { config, pkgs, ... }:

     

       36
       -
                 {

     

       37
       -
                   imports = [ self.simple ];

     

       38
       -
                   services.paperless.database.createLocally = true;

     

       39
       -
                   services.paperless.settings = {

     

       40
       -
                     PAPERLESS_OCR_LANGUAGE = "deu";

     

       41
       -
                   };

     

       42
        
                 };

     

       0
        
       
     

       43
        
             };

     

       44
        
           in

     

       45
        
           self;

     
···

       59
        
             with subtest("Web interface gets ready"):

     

       60
        
               node.wait_for_unit("paperless-web.service")

     

       61
        
               # Wait until server accepts connections

     

       62
       -
               node.wait_until_succeeds("curl -fs localhost:28981")

     

       63
        
       

     

       64
        
             # Required for consuming documents via the web interface

     

       65
        
             with subtest("Task-queue gets ready"):

     
···

       70
        
                 "convert -size 400x40 xc:white -font 'DejaVu-Sans' -pointsize 20 -fill black "

     

       71
        
                 "-annotate +5+20 'hello web 16-10-2005' /tmp/webdoc.png"

     

       72
        
               )

     

       73
       -
               node.wait_until_succeeds("curl -u admin:admin -F document=@/tmp/webdoc.png -fs localhost:28981/api/documents/post_document/")

     

       74
        
       

     

       75
        
             with subtest("Add a txt document via the web interface"):

     

       76
        
               node.succeed(

     

       77
        
                 "echo 'hello web 16-10-2005' > /tmp/webdoc.txt"

     

       78
        
               )

     

       79
       -
               node.wait_until_succeeds("curl -u admin:admin -F document=@/tmp/webdoc.txt -fs localhost:28981/api/documents/post_document/")

     

       80
        
       

     

       81
        
             with subtest("Documents are consumed"):

     

       82
        
               node.wait_until_succeeds(

     

       83
       -
                 "(($(curl -u admin:admin -fs localhost:28981/api/documents/ | jq .count) == 3))"

     

       84
        
               )

     

       85
       -
               docs = json.loads(node.succeed("curl -u admin:admin -fs localhost:28981/api/documents/"))['results']

     

       86
        
               assert "2005-10-16" in docs[0]['created']

     

       87
        
               assert "2005-10-16" in docs[1]['created']

     

       88
        
               assert "2005-10-16" in docs[2]['created']

     

       89
        
       

     

       90
        
             # Detects gunicorn issues, see PR #190888

     

       91
        
             with subtest("Document metadata can be accessed"):

     

       92
       -
               metadata = json.loads(node.succeed("curl -u admin:admin -fs localhost:28981/api/documents/1/metadata/"))

     

       93
        
               assert "original_checksum" in metadata

     

       94
        
       

     

       95
       -
               metadata = json.loads(node.succeed("curl -u admin:admin -fs localhost:28981/api/documents/2/metadata/"))

     

       96
        
               assert "original_checksum" in metadata

     

       97
        
       

     

       98
       -
               metadata = json.loads(node.succeed("curl -u admin:admin -fs localhost:28981/api/documents/3/metadata/"))

     

       99
        
               assert "original_checksum" in metadata

     

       100
        
       

     

       101
        
             with subtest("Exporter"):

···

       17
        
                     imagemagick

     

       18
        
                     jq

     

       19
        
                   ];

     

       20
       +
                   services = {

     

       21
       +
                     nginx.virtualHosts."localhost".forceSSL = false;

     

       22
       +
                     paperless = {

     

       0
        
       
     

       0
        
       
     

       23
        
                       enable = true;

     

       24
       +
                       configureNginx = true;

     

       25
       +
                       domain = "localhost";

     

       26
       +
                       passwordFile = builtins.toFile "password" "admin";

     

       27
        
       

     

       28
       +
                       exporter = {

     

       29
       +
                         enable = true;

     

       30
       +
       

     

       31
       +
                         settings = {

     

       32
       +
                           "no-color" = lib.mkForce false; # override a default option

     

       33
       +
                           "no-thumbnail" = true; # add a new option

     

       34
       +
                         };

     

       35
        
                       };

     

       36
        
                     };

     

       37
        
                   };

     

       38
        
                 };

     

       39
       +
               postgres = {

     

       40
       +
                 imports = [ self.simple ];

     

       41
       +
                 services.paperless.database.createLocally = true;

     

       42
       +
                 services.paperless.settings = {

     

       43
       +
                   PAPERLESS_OCR_LANGUAGE = "deu";

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       44
        
                 };

     

       45
       +
               };

     

       46
        
             };

     

       47
        
           in

     

       48
        
           self;

     
···

       62
        
             with subtest("Web interface gets ready"):

     

       63
        
               node.wait_for_unit("paperless-web.service")

     

       64
        
               # Wait until server accepts connections

     

       65
       +
               node.wait_until_succeeds("curl -fs localhost")

     

       66
        
       

     

       67
        
             # Required for consuming documents via the web interface

     

       68
        
             with subtest("Task-queue gets ready"):

     
···

       73
        
                 "convert -size 400x40 xc:white -font 'DejaVu-Sans' -pointsize 20 -fill black "

     

       74
        
                 "-annotate +5+20 'hello web 16-10-2005' /tmp/webdoc.png"

     

       75
        
               )

     

       76
       +
               node.wait_until_succeeds("curl -u admin:admin -F document=@/tmp/webdoc.png -fs localhost/api/documents/post_document/")

     

       77
        
       

     

       78
        
             with subtest("Add a txt document via the web interface"):

     

       79
        
               node.succeed(

     

       80
        
                 "echo 'hello web 16-10-2005' > /tmp/webdoc.txt"

     

       81
        
               )

     

       82
       +
               node.wait_until_succeeds("curl -u admin:admin -F document=@/tmp/webdoc.txt -fs localhost/api/documents/post_document/")

     

       83
        
       

     

       84
        
             with subtest("Documents are consumed"):

     

       85
        
               node.wait_until_succeeds(

     

       86
       +
                 "(($(curl -u admin:admin -fs localhost/api/documents/ | jq .count) == 3))"

     

       87
        
               )

     

       88
       +
               docs = json.loads(node.succeed("curl -u admin:admin -fs localhost/api/documents/"))['results']

     

       89
        
               assert "2005-10-16" in docs[0]['created']

     

       90
        
               assert "2005-10-16" in docs[1]['created']

     

       91
        
               assert "2005-10-16" in docs[2]['created']

     

       92
        
       

     

       93
        
             # Detects gunicorn issues, see PR #190888

     

       94
        
             with subtest("Document metadata can be accessed"):

     

       95
       +
               metadata = json.loads(node.succeed("curl -u admin:admin -fs localhost/api/documents/1/metadata/"))

     

       96
        
               assert "original_checksum" in metadata

     

       97
        
       

     

       98
       +
               metadata = json.loads(node.succeed("curl -u admin:admin -fs localhost/api/documents/2/metadata/"))

     

       99
        
               assert "original_checksum" in metadata

     

       100
        
       

     

       101
       +
               metadata = json.loads(node.succeed("curl -u admin:admin -fs localhost/api/documents/3/metadata/"))

     

       102
        
               assert "original_checksum" in metadata

     

       103
        
       

     

       104
        
             with subtest("Exporter"):