photoprism/README.md

PhotoPrism: Browse Your Life in Pictures

PhotoPrism® is an AI-powered app for browsing, organizing & sharing your photo collection. It makes use of the latest technologies to tag and find pictures automatically without getting in your way. You can run it at home, on a private server, or in the cloud.

To get a first impression, you are welcome to play with our public demo at demo.photoprism.app (also available in Deutsch, Français, and 汉语).

Feature Overview

• Browse all your photos and videos without worrying about RAW conversion, duplicates or video formats
• Easily find specific pictures using powerful search filters
• Privacy-friendly: No data is ever sent to Google, Amazon, Facebook, or Apple unless you explicitly upload files to one of their services 🔐
• Recognizes the faces of your family and friends
• Automatic classification of pictures based on their content and location
• Play Live Photos by hovering over them in albums and search results
• Since the User Interface is a Progressive Web App, it provides a native app-like experience, and you can conveniently install it on the home screen of all major operating systems and mobile devices
• Includes four high-resolution World Maps to bring back the memories of your favorite trips
• Metadata is extracted and merged from Exif, XMP, and other sources such as Google Photos
• Many more image properties like Colors, Chroma, and Quality can be searched as well
• Use PhotoSync to securely backup iOS and Android phones in the background
• WebDAV clients such as Microsoft's Windows Explorer and Apple's Finder can connect directly to PhotoPrism, allowing you to open, edit, and delete files from your computer as if they were local

Getting Started

Step-by-step installation instructions for our self-hosted community edition can be found on docs.photoprism.app - all you need is a Web browser and Docker to run the server. It is available for Mac, Linux, and Windows.

The stable version and development preview have been built into a single multi-arch image for 64-bit AMD, Intel, and ARM processors. That means, Raspberry Pi 3 / 4 owners 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.

Existing users are advised to update their docker-compose.yml config based on our examples available at dl.photoprism.app/docker.

Back us on Patreon or GitHub Sponsors 🎄

Your continued support helps us provide regular updates and services like world maps. Sponsors get access to additional features, receive direct technical support via email, and can join our private chat room on matrix.org.

We currently have the following sponsorship options:

• GitHub Sponsors is priced in USD and also offers one-time donations
• Patreon is priced in Euro and also offers yearly payments
• Stripe will be available in early 2022, so you can sign up directly in the app without having a Patreon or GitHub account
• You are welcome to contact us for other options

Also, please leave a star on GitHub if you like this project. It provides additional motivation to keep going.

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:

• you are welcome to join us on Reddit
• post your question in GitHub Discussions
• ask in our Community Chat

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! 💜

When reporting a problem, always include the software versions you are using and other information about your environment such as browser, browser plugins, operating system, storage type, memory size, and processor.

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 endorsed by silver, gold, and platinum sponsors receive a golden label and will be prioritized on the roadmap.

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.

Questions?

Follow us on Twitter or join our Community Chat to get regular updates, connect with other users, and discuss your ideas. Our Code of Conduct explains the "dos and don’ts."

Contributions

We welcome contributions of any kind, including blog posts, tutorials, testing, writing documentation, and pull requests.

The Developer Guide contains all information necessary to get you started.

PhotoPrism® Trademark

Our Trademark and Brand Guidelines, which may be updated from time to time, describe how our Brand Assets may be used. It is important to us that any permitted use of our Brand Assets is fair and meets the highest standards. To ensure this, we reserve the right to object to any use or misuse in any jurisdiction worldwide.

We Love Feedback

An important part of our journey is to explore new ways in product development and build better software through simplicity and consistent use of community feedback. You are always welcome to share your thoughts with us.