commit 0b93bf6c2200343b6c5c6b5ecbca04c92c35e7f0 · pyrox.dev/nixpkgs

+1 -1

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

···

       198
        
       

     

       199
        
       - `services.ntpd-rs` now performs configuration validation.

     

       200
        
       

     

       201
       -
       - Immich now has support for [VectorChord](https://github.com/tensorchord/VectorChord) when using the PostgreSQL configuration provided by `services.immich.database.enable`, which replaces `pgvecto-rs`. VectorChord support can be toggled with the option `services.immich.database.enableVectorChord`.

     

       202
        
       

     

       203
        
       - `services.postsrsd` now automatically integrates with the local Postfix instance, when enabled. This behavior can disabled using the [services.postsrsd.configurePostfix](#opt-services.postsrsd.configurePostfix) option.

     

       204

···

       198
        
       

     

       199
        
       - `services.ntpd-rs` now performs configuration validation.

     

       200
        
       

     

       201
       +
       - Immich now has support for [VectorChord](https://github.com/tensorchord/VectorChord) when using the PostgreSQL configuration provided by `services.immich.database.enable`, which replaces `pgvecto-rs`. VectorChord support can be toggled with the option `services.immich.database.enableVectorChord`. Additionally, `pgvecto-rs` support is now disabled from NixOS 25.11 onwards using the option `services.immich.database.enableVectors`. This option will be removed fully in the future once Immich drops support for `pgvecto-rs` fully.

     

       202
        
       

     

       203
        
       - `services.postsrsd` now automatically integrates with the local Postfix instance, when enabled. This behavior can disabled using the [services.postsrsd.configurePostfix](#opt-services.postsrsd.configurePostfix) option.

     

       204

+25 -10

nixos/modules/services/web-apps/immich.nix

···

       187
        
               // {

     

       188
        
                 default = true;

     

       189
        
               };

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       190
        
             createDB = mkEnableOption "the automatic creation of the database for immich." // {

     

       191
        
               default = true;

     

       192
        
             };

     
···

       238
        
             }

     

       239
        
             {

     

       240
        
               # When removing this assertion, please adjust the nixosTests accordingly.

     

       241
       -
               assertion = cfg.database.enable -> lib.versionOlder config.services.postgresql.package.version "17";

     

       242
       -
               message = "Immich doesn't support PostgreSQL 17+, yet.";

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       243
        
             }

     

       244
        
           ];

     

       245
        
       

     
···

       255
        
             ];

     

       256
        
             extensions =

     

       257
        
               ps:

     

       258
       -
               [ ps.pgvecto-rs ]

     

       259
        
               ++ lib.optionals cfg.database.enableVectorChord [

     

       260
       -
                 ps.vectors

     

       261
        
                 ps.vectorchord

     

       262
        
               ];

     

       263
        
             settings = {

     

       264
       -
               shared_preload_libraries = [

     

       265
       -
                 "vectors.so"

     

       266
       -
               ]

     

       267
       -
               ++ lib.optionals cfg.database.enableVectorChord [ "vchord.so" ];

     

       0
        
       
     

       268
        
               search_path = "\"$user\", public, vectors";

     

       269
        
             };

     

       270
        
           };

     
···

       273
        
               extensions = [

     

       274
        
                 "unaccent"

     

       275
        
                 "uuid-ossp"

     

       276
       -
                 "vectors"

     

       277
        
                 "cube"

     

       278
        
                 "earthdistance"

     

       279
        
                 "pg_trgm"

     

       280
        
               ]

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       281
        
               ++ lib.optionals cfg.database.enableVectorChord [

     

       282
        
                 "vector"

     

       283
        
                 "vchord"

     
···

       286
        
                 ${lib.concatMapStringsSep "\n" (ext: "CREATE EXTENSION IF NOT EXISTS \"${ext}\";") extensions}

     

       287
        
       

     

       288
        
                 ALTER SCHEMA public OWNER TO ${cfg.database.user};

     

       289
       -
                 ALTER SCHEMA vectors OWNER TO ${cfg.database.user};

     

       290
        
                 GRANT SELECT ON TABLE pg_vector_index_stat TO ${cfg.database.user};

     

       291
        
       

     

       292
        
                 ${lib.concatMapStringsSep "\n" (ext: "ALTER EXTENSION \"${ext}\" UPDATE;") extensions}

···

       187
        
               // {

     

       188
        
                 default = true;

     

       189
        
               };

     

       190
       +
             enableVectors =

     

       191
       +
               mkEnableOption "pgvecto.rs in the database. You may disable this, if you have migrated to VectorChord and deleted the `vectors` schema."

     

       192
       +
               // {

     

       193
       +
                 default = lib.versionOlder config.system.stateVersion "25.11";

     

       194
       +
                 defaultText = lib.literalExpression "lib.versionOlder config.system.stateVersion \"25.11\"";

     

       195
       +
               };

     

       196
        
             createDB = mkEnableOption "the automatic creation of the database for immich." // {

     

       197
        
               default = true;

     

       198
        
             };

     
···

       244
        
             }

     

       245
        
             {

     

       246
        
               # When removing this assertion, please adjust the nixosTests accordingly.

     

       247
       +
               assertion =

     

       248
       +
                 (cfg.database.enable && cfg.database.enableVectors)

     

       249
       +
                 -> lib.versionOlder config.services.postgresql.package.version "17";

     

       250
       +
               message = "Immich doesn't support PostgreSQL 17+ when using pgvecto.rs. Consider disabling it using services.immich.database.enableVectors if it is not needed anymore.";

     

       251
       +
             }

     

       252
       +
             {

     

       253
       +
               assertion = cfg.database.enable -> (cfg.database.enableVectorChord || cfg.database.enableVectors);

     

       254
       +
               message = "At least one of services.immich.database.enableVectorChord and services.immich.database.enableVectors has to be enabled.";

     

       255
        
             }

     

       256
        
           ];

     

       257
        
       

     
···

       267
        
             ];

     

       268
        
             extensions =

     

       269
        
               ps:

     

       270
       +
               lib.optionals cfg.database.enableVectors [ ps.pgvecto-rs ]

     

       271
        
               ++ lib.optionals cfg.database.enableVectorChord [

     

       272
       +
                 ps.pgvector

     

       273
        
                 ps.vectorchord

     

       274
        
               ];

     

       275
        
             settings = {

     

       276
       +
               shared_preload_libraries =

     

       277
       +
                 lib.optionals cfg.database.enableVectors [

     

       278
       +
                   "vectors.so"

     

       279
       +
                 ]

     

       280
       +
                 ++ lib.optionals cfg.database.enableVectorChord [ "vchord.so" ];

     

       281
        
               search_path = "\"$user\", public, vectors";

     

       282
        
             };

     

       283
        
           };

     
···

       286
        
               extensions = [

     

       287
        
                 "unaccent"

     

       288
        
                 "uuid-ossp"

     

       0
        
       
     

       289
        
                 "cube"

     

       290
        
                 "earthdistance"

     

       291
        
                 "pg_trgm"

     

       292
        
               ]

     

       293
       +
               ++ lib.optionals cfg.database.enableVectors [

     

       294
       +
                 "vectors"

     

       295
       +
               ]

     

       296
        
               ++ lib.optionals cfg.database.enableVectorChord [

     

       297
        
                 "vector"

     

       298
        
                 "vchord"

     
···

       301
        
                 ${lib.concatMapStringsSep "\n" (ext: "CREATE EXTENSION IF NOT EXISTS \"${ext}\";") extensions}

     

       302
        
       

     

       303
        
                 ALTER SCHEMA public OWNER TO ${cfg.database.user};

     

       304
       +
                 ${lib.optionalString cfg.database.enableVectors "ALTER SCHEMA vectors OWNER TO ${cfg.database.user};"}

     

       305
        
                 GRANT SELECT ON TABLE pg_vector_index_stat TO ${cfg.database.user};

     

       306
        
       

     

       307
        
                 ${lib.concatMapStringsSep "\n" (ext: "ALTER EXTENSION \"${ext}\" UPDATE;") extensions}

nixos/tests/all-tests.nix

···

       741
        
         ifm = runTest ./ifm.nix;

     

       742
        
         iftop = runTest ./iftop.nix;

     

       743
        
         immich = runTest ./web-apps/immich.nix;

     

       0
        
       
     

       744
        
         immich-public-proxy = runTest ./web-apps/immich-public-proxy.nix;

     

       745
        
         incron = runTest ./incron.nix;

     

       746
        
         incus = pkgs.recurseIntoAttrs (

···

       741
        
         ifm = runTest ./ifm.nix;

     

       742
        
         iftop = runTest ./iftop.nix;

     

       743
        
         immich = runTest ./web-apps/immich.nix;

     

       744
       +
         immich-vectorchord-migration = runTest ./web-apps/immich-vectorchord-migration.nix;

     

       745
        
         immich-public-proxy = runTest ./web-apps/immich-public-proxy.nix;

     

       746
        
         incron = runTest ./incron.nix;

     

       747
        
         incus = pkgs.recurseIntoAttrs (

+71

nixos/tests/web-apps/immich-vectorchord-migration.nix

···

       1
       +
       { ... }:

     

       2
       +
       {

     

       3
       +
         name = "immich-vectorchord-migration";

     

       4
       +
       

     

       5
       +
         nodes.machine =

     

       6
       +
           { lib, pkgs, ... }:

     

       7
       +
           {

     

       8
       +
             # These tests need a little more juice

     

       9
       +
             virtualisation = {

     

       10
       +
               cores = 2;

     

       11
       +
               memorySize = 2048;

     

       12
       +
               diskSize = 4096;

     

       13
       +
             };

     

       14
       +
       

     

       15
       +
             environment.systemPackages = with pkgs; [ immich-cli ];

     

       16
       +
       

     

       17
       +
             services.immich = {

     

       18
       +
               enable = true;

     

       19
       +
               environment.IMMICH_LOG_LEVEL = "verbose";

     

       20
       +
               # Simulate an existing setup

     

       21
       +
               database.enableVectorChord = lib.mkDefault false;

     

       22
       +
               database.enableVectors = lib.mkDefault true;

     

       23
       +
             };

     

       24
       +
       

     

       25
       +
             # TODO: Remove when PostgreSQL 17 is supported.

     

       26
       +
             services.postgresql.package = pkgs.postgresql_16;

     

       27
       +
       

     

       28
       +
             specialisation."immich-vectorchord-enabled".configuration = {

     

       29
       +
               services.immich.database.enableVectorChord = true;

     

       30
       +
             };

     

       31
       +
       

     

       32
       +
             specialisation."immich-vectorchord-only".configuration = {

     

       33
       +
               services.immich.database = {

     

       34
       +
                 enableVectorChord = true;

     

       35
       +
                 enableVectors = false;

     

       36
       +
               };

     

       37
       +
             };

     

       38
       +
           };

     

       39
       +
       

     

       40
       +
         testScript =

     

       41
       +
           { nodes, ... }:

     

       42
       +
           let

     

       43
       +
             specBase = "${nodes.machine.system.build.toplevel}/specialisation";

     

       44
       +
             vectorchordEnabled = "${specBase}/immich-vectorchord-enabled";

     

       45
       +
             vectorchordOnly = "${specBase}/immich-vectorchord-only";

     

       46
       +
           in

     

       47
       +
           ''

     

       48
       +
             def psql(command: str):

     

       49
       +
               machine.succeed(f"sudo -u postgres psql -d ${nodes.machine.services.immich.database.name} -c '{command}'")

     

       50
       +
       

     

       51
       +
             def immich_works():

     

       52
       +
               machine.wait_for_unit("immich-server.service")

     

       53
       +
       

     

       54
       +
               machine.wait_for_open_port(2283) # Server

     

       55
       +
               machine.wait_for_open_port(3003) # Machine learning

     

       56
       +
               machine.succeed("curl --fail http://localhost:2283/")

     

       57
       +
       

     

       58
       +
             immich_works()

     

       59
       +
       

     

       60
       +
             machine.succeed("${vectorchordEnabled}/bin/switch-to-configuration test")

     

       61
       +
       

     

       62
       +
             immich_works()

     

       63
       +
       

     

       64
       +
             psql("DROP EXTENSION vectors;")

     

       65
       +
             psql("DROP SCHEMA vectors;")

     

       66
       +
       

     

       67
       +
             machine.succeed("${vectorchordOnly}/bin/switch-to-configuration test")

     

       68
       +
       

     

       69
       +
             immich_works()

     

       70
       +
           '';

     

       71
       +
       }

-3

nixos/tests/web-apps/immich.nix

···

       18
        
               enable = true;

     

       19
        
               environment.IMMICH_LOG_LEVEL = "verbose";

     

       20
        
             };

     

       21
       -
       

     

       22
       -
             # TODO: Remove when PostgreSQL 17 is supported.

     

       23
       -
             services.postgresql.package = pkgs.postgresql_16;

     

       24
        
           };

     

       25
        
       

     

       26
        
         testScript = ''

···

       18
        
               enable = true;

     

       19
        
               environment.IMMICH_LOG_LEVEL = "verbose";

     

       20
        
             };

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       21
        
           };

     

       22
        
       

     

       23
        
         testScript = ''

+1 -1

pkgs/by-name/im/immich/package.nix

···

       273
        
       

     

       274
        
         passthru = {

     

       275
        
           tests = {

     

       276
       -
             inherit (nixosTests) immich;

     

       277
        
           };

     

       278
        
       

     

       279
        
           machine-learning = immich-machine-learning;

···

       273
        
       

     

       274
        
         passthru = {

     

       275
        
           tests = {

     

       276
       +
             inherit (nixosTests) immich immich-vectorchord-migration;

     

       277
        
           };

     

       278
        
       

     

       279
        
           machine-learning = immich-machine-learning;