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 Silicon, 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. See FAQs for instructions and notes on alternative installation methods.

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, 3 GB of physical memory,1 and a 64-bit operating system. Beyond these minimum requirements, the amount of RAM should match the number of CPU cores.

If your server has less than 4 GB of swap space or a manual memory/swap limit is set, this can cause unexpected restarts, for example, when the indexer temporarily needs more memory to process large files. High-resolution panoramic images may require additional swap space and/or physical memory above the recommended minimum.

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. We take no responsibility for instability or performance problems if your device does not meet the requirements.

Browsers

Our Progressive Web App (PWA) works with most modern browsers, and runs best on Chrome, Chromium, Safari, Firefox, and Edge. You can conveniently install it on the home screen of all major operating systems and mobile devices.

Please note that not all video and audio formats can be played with every browser. For example, AAC - the default audio codec for MPEG-4 AVC / H.264 - is supported natively in Chrome, Safari, and Edge, while it is only optionally supported by the OS in Firefox and Opera.

Databases

The backend is compatible with SQLite 3 and MariaDB 10.5.12+. Official support for MySQL 8 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, 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

If you need help installing our software at home, you can join us on Reddit, ask in our Community Chat, or post your question in GitHub Discussions. Common problems can be quickly diagnosed and solved using our Troubleshooting Checklists.

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!

In exchange for their continued support, sponsors are also welcome to request direct technical support via email. Please bear with us if we are unable to get back to you immediately due to the high volume of emails and contact requests we receive.

We kindly ask you not to report bugs via GitHub Issues unless you are certain to have found a fully reproducible and previously unreported 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.


  1. RAW image conversion and TensorFlow are disabled on systems with 1 GB or less memory 

Back to top