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 now come as a single multi-arch image for AMD64, ARM64, and ARMv7. That means you don't need to pull from different Docker repositories anymore. We recommend updating your existing docker-compose.yml config based on our examples.

Downloadable installation packages are planned for a later release. Developers can build PhotoPrism from source by following the instructions in our Developer Guide.

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.

Please give ideas you like a thumbs-up, so that we know what is most popular. Ideas backed by silver and gold sponsors will be prioritized as well.

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 fast, 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 will be 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.

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 may be played with every browser.

The backend is compatible with MariaDB 10.5+, MySQL 8, and SQLite 3.

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