Skip to content

Setup

We recommend running PhotoPrism with Docker Compose. All you need to have installed is a Web browser and Docker. It is available for Mac, Linux, and Windows.

When setup is complete, you can start indexing your pictures. Be patient, this may take a while depending on your server hardware and how many files you have.

Your photos and videos will successively become visible in search results and other parts of the user interface. The counts in the navigation are constantly updated, so you can follow the progress.

In case some of your pictures are still missing after indexing has been completed, they might be in Review due to low quality or incomplete metadata. You can turn this and other features off in Settings, depending on your specific use case.

Our stable version and development preview have been built into a single multi-arch Docker image for 64-bit AMD, Intel, and ARM processors. That means, Raspberry Pi 3 / 4, Apple M1, and other ARM64-based devices can pull from the same repository, enjoy the exact same functionality, and can follow the regular installation instructions after going through a short list of requirements.

Developers are invited to contribute by building and testing standalone packages for Linux distributions and other operating systems. New versions are released several times a month, so maintaining and testing the long list of dependencies in multiple environments would consume much of our resources. An unofficial port is available for FreeBSD / FreeNAS users. Advanced users can build and install PhotoPrism from the publicly available source code.

Roadmap

Our vision is to provide the most user- and privacy-friendly solution to keep your pictures organized and accessible. The roadmap shows what tasks are in progress, what needs testing, and which features are going to be implemented next.

We have a zero bug policy and do our best to help users when they need support or have other questions. This comes at a price, as we can't give exact deadlines for new features.

Having said that, funding really has the highest impact. So users can do their part and become a sponsor to get their favorite features as soon as possible.

System Requirements

We recommend hosting PhotoPrism on a server with at least 2 cores and 4 GB of memory. Also make sure it has at least 4 GB of swap configured, so that indexing doesn't cause restarts when there are memory usage spikes. Beyond these minimum requirements, the amount of RAM should match the number of cores.

Indexing large photo and video collections significantly benefits from local SSD storage, and plenty of memory for caching. Especially the conversion of RAW images and the transcoding of videos are very demanding.

RAW file conversion and TensorFlow are disabled on servers with less than 2 GB of physical memory. If you're running out of memory - or other system resources - while indexing, try reducing the number of workers to a reasonably small value in docker-compose.yml (depending on the performance of the server). As a measure of last resort, you may disable using TensorFlow for image classification and facial recognition.

Browsers

Our Web UI works with most modern browsers, and runs best on Chrome, Chromium, Safari, Firefox, and Edge. Opera and Samsung Internet have been reported to be compatible as well. Note that not all video formats can be played with every browser.

Databases

The backend is compatible with SQLite 3 and MariaDB 10.5.12+. Official support for MySQL is discontinued as Oracle seems to have stopped shipping new features and improvements. As a result, the testing effort required before each release is no longer feasible.

HTTPS

If you install PhotoPrism on a public server outside your home network, please always run it behind a secure HTTPS reverse proxy such as Traefik or Caddy. Your files and passwords will otherwise be transmitted in clear text and can be intercepted by anyone, including your provider, hackers, and governments. Backup tools and file sync apps like FolderSync may refuse to connect as well.

Getting Support

Before submitting a support request, please use our Troubleshooting Checklists to determine the cause of your problem. If this doesn't help, or you have other questions:

In addition, sponsors receive direct technical support via email.

We'll do our best to answer all your questions. In return, we ask you to back us on Patreon or GitHub Sponsors. Think of "free software" as in "free speech," not as in "free beer". Thank you! 💜

We kindly ask you not to report bugs via GitHub Issues unless you are certain to have found a new issue that must be fixed directly in the app. Contact us or a community member if you need help, it could be a local configuration problem, or a misunderstanding in how the software works.