Skip to main content

โœ… Feature Toggles

LibrePhotos feature togglesโ€‹

In some cases you might want to enable or disable certain LibrePhotos features to preserve hardware resources or make use of some more advanced features. You can do that by referring to the following table.

Feature toggles are implemented as environment variables you would have to configure before starting up backend.

FeatureDescriptionStatusEnvironment variable
Embedded mediaExtract embedded media from "live photos"๐ŸŸขFEATURE_PROCESS_EMBEDDED_MEDIA=true
VideoImport video files during a scan๐ŸŸขFEATURE_VIDEO=true
Face detectionFind faces in your photos๐ŸŸขFEATURE_FACE_DETECTION=true
Face clusteringGroup the faces that were found into people you can label๐ŸŸขFEATURE_FACE_CLUSTER=true
Image captioningDescribe photos with an automatically generated caption๐ŸŸขFEATURE_IMAGE_CAPTIONING=true
Reverse geocodingTurn GPS coordinates into place names๐ŸŸขFEATURE_REVERSE_GEOCODING=true
Scene classificationTag photos by what is in them (beach, kitchen, sunset, ...)๐ŸŸขFEATURE_SCENE_CLASSIFICATION=true

All of these default to on. See Advanced docker-compose usage for what turning each one off actually stops, and for the matching .env keys of the bundled Compose setup.

Embedded media

The Embedded media switch is checked only the first time a file is imported. Enabling it on a library that has already been scanned extracts nothing for the photos that are already there, not even with Rescan All Photos, which skips extraction for files it has already imported. Only files added afterwards are affected. Turning it off never removes clips that were already extracted; those stay on disk under protected_media/embedded_media/.

Legendโ€‹

๐ŸŸขImplemented
๐Ÿ”ดPlanned, not implemented
๐ŸŸกIn progress
โšชNot planned