Skip to content

Indexing Originals

If you're using PhotoPrism for the first time, make sure your photo and video collection is properly configured as originals folder. See installation instructions in Getting Started for details. When starting with an empty folder, you need to add or upload files first.

  1. Go to Library using the main navigation

  2. Select a sub-folder or keep the default to index all files

  3. Select Complete Rescan to re-index all originals, including already indexed and unchanged files

  4. Press Start to start indexing

Screenshot

You can use WebDAV-compatible apps, including Microsoft's Windows Explorer and Apple's Finder, to add files to your originals folders from a remote computer or mobile device.

NSFW

An NSFW detector can be enabled to automatically mark images with potentially objectionable content as private. Note that this feature is only partially reliable.

Ignoring Files and Folders

Hidden files and folders that start with a . or @ are automatically ignored. Other names to be ignored can be added to a .ppignore file in the originals or import folder it should affect. You can put it either in the main folder or in a subfolder to limit the scope.

Example:

# ignore a directory by its name
foo
# ignore all files
*.*
# ignore all files with gif extension
*.gif
# ignore videos which name start with MVI
MVI_*.MOV
# or
MVI_*.*

Names in the same directory and in all subdirectories are ignored. You can use * as a wildcard.

Files and folders that have already been indexed cannot be retroactively removed from the index using a .ppignore file. Adding their name won't remove them from PhotoPrism.

If you are a new user and files or folders have already been indexed, it is generally easiest to reset the database and start with a new index by running photoprism reset in a terminal.

When should "Complete Rescan" be selected?

If selected, all files in the originals folder will be re-indexed, including already indexed and unchanged files. This may be necessary after upgrading, especially to new major versions.

Automatic Indexing

The Indexer is triggered automatically 15 Minutes after the originals folder has been edited via WebDAV. 15 Minutes is the default value, it can be changed using the respective config option.