commit fb9e8b9bd4f5d6c25dd297fd387ec8748fd0b549 · pyrox.dev/nixpkgs

nixos/doc/manual/from_md/release-notes/rl-2305.section.xml

···

       99
       99
        
                 <link xlink:href="options.html#opt-services.ulogd.enable">services.ulogd</link>.

     

       100
       100
        
               </para>

     

       101
       101
        
             </listitem>

     

       102
       102
       +
             <listitem>

     

       103
       103
       +
               <para>

     

       104
       104
       +
                 <link xlink:href="https://photoprism.app/">photoprism</link>,

     

       105
       105
       +
                 a AI-Powered Photos App for the Decentralized Web. Available

     

       106
       106
       +
                 as

     

       107
       107
       +
                 <link xlink:href="options.html#opt-services.photoprism.enable">services.photoprism</link>.

     

       108
       108
       +
               </para>

     

       109
       109
       +
             </listitem>

     

       102
       110
        
           </itemizedlist>

     

       103
       111
        
         </section>

     

       104
       112
        
         <section xml:id="sec-release-23.05-incompatibilities">

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

···

       34
       34
        
       

     

       35
       35
        
       - [ulogd](https://www.netfilter.org/projects/ulogd/index.html), a userspace logging daemon for netfilter/iptables related logging. Available as [services.ulogd](options.html#opt-services.ulogd.enable).

     

       36
       36
        
       

     

       37
       37
       +
       - [photoprism](https://photoprism.app/), a AI-Powered Photos App for the Decentralized Web. Available as [services.photoprism](options.html#opt-services.photoprism.enable).

     

       38
       38
       +
       

     

       37
       39
        
       ## Backward Incompatibilities {#sec-release-23.05-incompatibilities}

     

       38
       40
        
       

     

       39
       41
        
       <!-- To avoid merge conflicts, consider adding your item at an arbitrary place in the list instead. -->

nixos/modules/module-list.nix

···

       1165
       1165
        
         ./services/web-apps/peertube.nix

     

       1166
       1166
        
         ./services/web-apps/pgpkeyserver-lite.nix

     

       1167
       1167
        
         ./services/web-apps/phylactery.nix

     

       1168
       1168
       +
         ./services/web-apps/photoprism.nix

     

       1168
       1169
        
         ./services/web-apps/pict-rs.nix

     

       1169
       1170
        
         ./services/web-apps/plantuml-server.nix

     

       1170
       1171
        
         ./services/web-apps/plausible.nix

+155

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

···

       1
       1
       +
       { config, pkgs, lib, ... }:

     

       2
       2
       +
       let

     

       3
       3
       +
         cfg = config.services.photoprism;

     

       4
       4
       +
       

     

       5
       5
       +
         env = {

     

       6
       6
       +
           PHOTOPRISM_ORIGINALS_PATH = cfg.originalsPath;

     

       7
       7
       +
           PHOTOPRISM_STORAGE_PATH = cfg.storagePath;

     

       8
       8
       +
           PHOTOPRISM_IMPORT_PATH = cfg.importPath;

     

       9
       9
       +
           PHOTOPRISM_HTTP_HOST = cfg.address;

     

       10
       10
       +
           PHOTOPRISM_HTTP_PORT = toString cfg.port;

     

       11
       11
       +
         } // (

     

       12
       12
       +
           lib.mapAttrs (_: toString) cfg.settings

     

       13
       13
       +
         );

     

       14
       14
       +
       

     

       15
       15
       +
         manage =

     

       16
       16
       +
           let

     

       17
       17
       +
             setupEnv = lib.concatStringsSep "\n" (lib.mapAttrsToList (name: val: "export ${name}=${lib.escapeShellArg val}") env);

     

       18
       18
       +
           in

     

       19
       19
       +
           pkgs.writeShellScript "manage" ''

     

       20
       20
       +
             ${setupEnv}

     

       21
       21
       +
             exec ${cfg.package}/bin/photoprism "$@"

     

       22
       22
       +
           '';

     

       23
       23
       +
       in

     

       24
       24
       +
       {

     

       25
       25
       +
         meta.maintainers = with lib.maintainers; [ stunkymonkey ];

     

       26
       26
       +
       

     

       27
       27
       +
         options.services.photoprism = {

     

       28
       28
       +
       

     

       29
       29
       +
           enable = lib.mkEnableOption (lib.mdDoc "Photoprism web server");

     

       30
       30
       +
       

     

       31
       31
       +
           passwordFile = lib.mkOption {

     

       32
       32
       +
             type = lib.types.nullOr lib.types.path;

     

       33
       33
       +
             default = null;

     

       34
       34
       +
             description = lib.mdDoc ''

     

       35
       35
       +
               Admin password file.

     

       36
       36
       +
             '';

     

       37
       37
       +
           };

     

       38
       38
       +
       

     

       39
       39
       +
           address = lib.mkOption {

     

       40
       40
       +
             type = lib.types.str;

     

       41
       41
       +
             default = "localhost";

     

       42
       42
       +
             description = lib.mdDoc ''

     

       43
       43
       +
               Web interface address.

     

       44
       44
       +
             '';

     

       45
       45
       +
           };

     

       46
       46
       +
       

     

       47
       47
       +
           port = lib.mkOption {

     

       48
       48
       +
             type = lib.types.port;

     

       49
       49
       +
             default = 2342;

     

       50
       50
       +
             description = lib.mdDoc ''

     

       51
       51
       +
               Web interface port.

     

       52
       52
       +
             '';

     

       53
       53
       +
           };

     

       54
       54
       +
       

     

       55
       55
       +
           originalsPath = lib.mkOption {

     

       56
       56
       +
             type = lib.types.path;

     

       57
       57
       +
             default = null;

     

       58
       58
       +
             example = "/data/photos";

     

       59
       59
       +
             description = lib.mdDoc ''

     

       60
       60
       +
               Storage path of your original media files (photos and videos).

     

       61
       61
       +
             '';

     

       62
       62
       +
           };

     

       63
       63
       +
       

     

       64
       64
       +
           importPath = lib.mkOption {

     

       65
       65
       +
             type = lib.types.str;

     

       66
       66
       +
             default = "import";

     

       67
       67
       +
             description = lib.mdDoc ''

     

       68
       68
       +
               Relative or absolute to the `originalsPath` from where the files should be imported.

     

       69
       69
       +
             '';

     

       70
       70
       +
           };

     

       71
       71
       +
       

     

       72
       72
       +
           storagePath = lib.mkOption {

     

       73
       73
       +
             type = lib.types.path;

     

       74
       74
       +
             default = "/var/lib/photoprism";

     

       75
       75
       +
             description = lib.mdDoc ''

     

       76
       76
       +
               Location for sidecar, cache, and database files.

     

       77
       77
       +
             '';

     

       78
       78
       +
           };

     

       79
       79
       +
       

     

       80
       80
       +
           package = lib.mkPackageOptionMD pkgs "photoprism" { };

     

       81
       81
       +
       

     

       82
       82
       +
           settings = lib.mkOption {

     

       83
       83
       +
             type = lib.types.attrsOf lib.types.str;

     

       84
       84
       +
             default = { };

     

       85
       85
       +
             description = lib.mdDoc ''

     

       86
       86
       +
               See [the getting-started guide](https://docs.photoprism.app/getting-started/config-options/) for available options.

     

       87
       87
       +
             '';

     

       88
       88
       +
             example = {

     

       89
       89
       +
               PHOTOPRISM_DEFAULT_LOCALE = "de";

     

       90
       90
       +
               PHOTOPRISM_ADMIN_USER = "root";

     

       91
       91
       +
             };

     

       92
       92
       +
           };

     

       93
       93
       +
         };

     

       94
       94
       +
       

     

       95
       95
       +
         config = lib.mkIf cfg.enable {

     

       96
       96
       +
           systemd.services.photoprism = {

     

       97
       97
       +
             description = "Photoprism server";

     

       98
       98
       +
       

     

       99
       99
       +
             serviceConfig = {

     

       100
       100
       +
               Restart = "on-failure";

     

       101
       101
       +
               User = "photoprism";

     

       102
       102
       +
               Group = "photoprism";

     

       103
       103
       +
               DynamicUser = true;

     

       104
       104
       +
               StateDirectory = "photoprism";

     

       105
       105
       +
               WorkingDirectory = "/var/lib/photoprism";

     

       106
       106
       +
               RuntimeDirectory = "photoprism";

     

       107
       107
       +
       

     

       108
       108
       +
               LoadCredential = lib.optionalString (cfg.passwordFile != null)

     

       109
       109
       +
                 "PHOTOPRISM_ADMIN_PASSWORD:${cfg.passwordFile}";

     

       110
       110
       +
       

     

       111
       111
       +
               CapabilityBoundingSet = "";

     

       112
       112
       +
               LockPersonality = true;

     

       113
       113
       +
               PrivateDevices = true;

     

       114
       114
       +
               PrivateUsers = true;

     

       115
       115
       +
               ProtectClock = true;

     

       116
       116
       +
               ProtectControlGroups = true;

     

       117
       117
       +
               ProtectHome = true;

     

       118
       118
       +
               ProtectHostname = true;

     

       119
       119
       +
               ProtectKernelLogs = true;

     

       120
       120
       +
               ProtectKernelModules = true;

     

       121
       121
       +
               ProtectKernelTunables = true;

     

       122
       122
       +
               RestrictAddressFamilies = [ "AF_UNIX" "AF_INET" "AF_INET6" ];

     

       123
       123
       +
               RestrictNamespaces = true;

     

       124
       124
       +
               RestrictRealtime = true;

     

       125
       125
       +
               SystemCallArchitectures = "native";

     

       126
       126
       +
               SystemCallFilter = [ "@system-service" "~@privileged @setuid @keyring" ];

     

       127
       127
       +
               UMask = "0066";

     

       128
       128
       +
             } // lib.optionalAttrs (cfg.port < 1024) {

     

       129
       129
       +
               AmbientCapabilities = [ "CAP_NET_BIND_SERVICE" ];

     

       130
       130
       +
               CapabilityBoundingSet = [ "CAP_NET_BIND_SERVICE" ];

     

       131
       131
       +
             };

     

       132
       132
       +
       

     

       133
       133
       +
             wantedBy = [ "multi-user.target" ];

     

       134
       134
       +
             environment = env;

     

       135
       135
       +
       

     

       136
       136
       +
             # reminder: easier password configuration will come in https://github.com/photoprism/photoprism/pull/2302

     

       137
       137
       +
             preStart = ''

     

       138
       138
       +
               ln -sf ${manage} photoprism-manage

     

       139
       139
       +
       

     

       140
       140
       +
               ${lib.optionalString (cfg.passwordFile != null) ''

     

       141
       141
       +
                 export PHOTOPRISM_ADMIN_PASSWORD=$(cat "$CREDENTIALS_DIRECTORY/PHOTOPRISM_ADMIN_PASSWORD")

     

       142
       142
       +
               ''}

     

       143
       143
       +
               exec ${cfg.package}/bin/photoprism migrations run -f

     

       144
       144
       +
             '';

     

       145
       145
       +
       

     

       146
       146
       +
             script = ''

     

       147
       147
       +
               ${lib.optionalString (cfg.passwordFile != null) ''

     

       148
       148
       +
                 export PHOTOPRISM_ADMIN_PASSWORD=$(cat "$CREDENTIALS_DIRECTORY/PHOTOPRISM_ADMIN_PASSWORD")

     

       149
       149
       +
               ''}

     

       150
       150
       +
               exec ${cfg.package}/bin/photoprism start

     

       151
       151
       +
             '';

     

       152
       152
       +
           };

     

       153
       153
       +
         };

     

       154
       154
       +
       }

     

       155
       155
       +