View source for PhotoPrism

==What is PhotoPrism ==
[https://www.photoprism.app/ PhotoPrism] is an AI-Powered Photos App for the Decentralized Web. It makes use of the latest technologies to tag and find pictures automatically without getting in your way. You can run it at home, on a private server, or in the cloud.

'''Functionality:'''
* Browse all your photos and videos without worrying about RAW conversion, duplicates or video formats
* Easily find specific pictures using powerful search filters
* Includes four high-resolution world maps to bring back the memories of your favorite trips
* Play Live Photos by hovering over them in albums and search results
* Recognizes the faces of your family and friends
* Automatic classification of pictures based on their content and location


== Setup PhotoPrism ==

To install PhotoPrism add to your <code>configuration.nix</code>:

<syntaxhighlight lang="nix">
  # Photoprism
  services.photoprism = {
    enable = true;
    port = 2342;
    originalsPath = "/var/lib/private/photoprism/originals";
    address = "0.0.0.0";
    settings = {
      PHOTOPRISM_ADMIN_USER = "admin";
      PHOTOPRISM_ADMIN_PASSWORD = "...";
      PHOTOPRISM_DEFAULT_LOCALE = "en";
      PHOTOPRISM_DATABASE_DRIVER = "mysql";
      PHOTOPRISM_DATABASE_NAME = "photoprism";
      PHOTOPRISM_DATABASE_SERVER = "/run/mysqld/mysqld.sock";
      PHOTOPRISM_DATABASE_USER = "photoprism";
      PHOTOPRISM_SITE_URL = "http://sub.domain.tld:2342";
      PHOTOPRISM_SITE_TITLE = "My PhotoPrism";
    };
  };
</syntaxhighlight>
 
'''Notes:'''
* PhotoPrism can be run on <code>sqlite3</code> but performance will be horrible. That's why <code>MySQL resp. MariaDB</code> should be used.
* The <code>originalsPath</code> must be set and in required to be inside the <code>/var/lib/private/photoprism</code> directory. Otherwise <code>SystemD</code> will complain. Further below you'll find instruction on howto to effectively store Photoprism and the <code>Originals</code> in another location.
* Instead of providing the admin password as settings, you could also use a password file using <code>services.photoprism.passwordFile</code>
* The address should be <code>0.0.0.0</code> to listen to everything.
* You can set a lot more photoprism settings. The complete list of options (except the ones for sponsors) can be found [https://docs.photoprism.app/getting-started/config-options/ here].
* Because we use the socket for the database, no database user password is required to specify.
* Make sure there are no unexpected files or folders in <code>/</code>. Otherwise Photoprism will complain and not start.

== Setup MariaDB / MySQL ==

To setup MariaDB / MySQL with PhotoPrism, you can use a code snippet like the following in your <code>configuration.nix</code>:

<syntaxhighlight lang="nix">
  # MySQL
  services.mysql = {
    enable = true;
    dataDir = "/data/mysql";
    package = pkgs.mariadb;
    ensureDatabases = [ "photoprism" ];
    ensureUsers = [ {
      name = "photoprism";
      ensurePermissions = {
        "photoprism.*" = "ALL PRIVILEGES";
      };
    } ];
  };
</syntaxhighlight>

'''Notes:'''
* By default MySQL is used. If you want to use MariaDB instead, use the <code>services.mysql.package = pkgs.mariadb</code> directive.
* By default the data is stored in <code>/var/lib/mysql</code>. If you want to alter the location, use the <code>services.mysql.dataDir</code> directive.
* The <code>ensureDatabases</code> directive ensures that the specified databases exist. Removing such a created database from the list, will not delete it. This means that databases created once through this option or otherwise have to be removed manually. This will ensure, you don't accidentally delete all your PhotoPrism data.
* Make sure that the database user for your PhotoPrism database matches with the one specified in the PhotoPrism settings.

== Setup nginx reverse proxy ==

As Photoprism runs on its own port, you do want to setup a reverse proxy. That way you can omit the port and also use secure connections when accessing it.

<syntaxhighlight lang="nix">
  # NGINX
  services.nginx = {
    enable = true;
    recommendedTlsSettings = true;
    recommendedOptimisation = true;
    recommendedGzipSettings = true;
    recommendedProxySettings = true;
    clientMaxBodySize = "500m";
    virtualHosts = {
      "sub.domain.tld" = {
        forceSSL = true;
        enableACME = true;
        http2 = true;
        locations."/" = {
          proxyPass = "http://127.0.0.1:2342";
          proxyWebsockets = true;
          extraConfig = ''
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header Host $host;
            proxy_buffering off;
            proxy_http_version 1.1;
          '';
        };
      };
    };
  };
</syntaxhighlight>

'''Notes:'''
* The <code>clientMaxBodySize</code> is the maximum size of a client request body. If this size is exceeded, Nginx returns a 413 Request entity too large HTTP error. This setting is particularly important for uploads especially video files.
* With the <code>proxyPass</code> directive nginx will access PhotoPrism. This way, you can also use SSL certificates (freely issued by Let's Encrypt through the acme protocol).

== Storing user data in specific location ==

NixOS allows you to seperate specific user data from other data that gets accumulated over time. Graham Christensen has written an excellent [https://grahamc.com/blog/erase-your-darlings/ blog post] on how to achieve that with ZFS. This is also possible with other CoW filesystems that have snapshot functionality. Such a setup requires you to specifically ''opt-in'' into keeping data.

On of the problem is that PhotoPrism stores it's actual data by default in <code>/var/lib/private/PhotoPrism</code>. SystemD is picky about the <code>/var/lib/private</code> folder. It won't allow symlinks there, but you can actually bind mount folders.

Specify the bind mounts in your <code>/etc/nixos/hard-wareconfiguration.nix</code> like this:

<syntaxhighlight lang="nix">
  fileSystems."/var/lib/private/photoprism" =
    { device = "/data/photoprism";
      options = [ "bind" ];
    };
</syntaxhighlight>

If you want to have the <code>originals</code> folder somewhere else, you can just add it also as seperate bind mount:

<syntaxhighlight lang="nix">
  fileSystems."/var/lib/private/photoprism" =
    { device = "/data/photoprism";
      options = [ "bind" ];
    };

  fileSystems."/var/lib/private/photoprism/originals" =
    { device = "/data/originals";
      options = [ "bind" ];
    };
</syntaxhighlight>



[[Category:Guide]]