photoprism/README.md
2018-10-08 21:25:14 +02:00

4.9 KiB

PhotoPrism: Browse your life in pictures

GPL License Donate Code Quality GitHub issues Build Status Documentation

We love taking photos and they belong to our most valuable (and storage consuming) assets. Privacy concerns - and the wish to properly archive them for the next generation - brought us to the conclusion that existing cloud solutions are not the right tool to keep them organized. At the same time, traditional desktop software like Adobe Lightroom lacks many features and can only be used on a single computer. That's why we started working on an easy-to-use application that can be hosted at home or on a private server.

More screenshots: https://photoprism.org/#screenshots

Features

We focus on what really matters for photographers:

  • Clearly structured Web interface for browsing, organizing and sharing your personal photo collection.
  • Import everything without worrying about duplicates or RAW to JPEG conversion.
  • Reverse geocoding and automated tagging based on Google TensorFlow.
  • No monthly costs. No proprietary formats. No privacy concerns.

Note: This is not a photo editor. All images are stored in the file system, so you can continue using your favorite tools like Photoshop or Lightroom. No upload or download needed, if you run it at home. Easy, isn't it?

Installation

This is the official way to test our development snapshot. We just started working on the UI and features are neither complete or stable. Feedback early in development helps saving a lot of time. We're a small team and need to move fast.

Before you start, make sure you got Docker installed on your system. It is available for Mac, Linux and Windows. Developers can skip this and move on to the Developer Guide in our Wiki.

Step 1: Download docker-compose.yml (right click and Save Link As...) to a directory of your choice.

By default, a folder named Photos in your home directory will be used to store all images. You don't need to create it.

PhotoPrism will also create the following sub-directories in your photo path: Import, Export and Originals. Copy existing photos to Import, not directly to Originals as they need to be renamed and indexed in order to remove duplicates. Files that can not be imported - like videos - will stay in the Import directory, nothing gets lost.

If you prefer to use different directory names, you can change them in docker-compose.yml. See inline comments for instructions.

Step 2: Start PhotoPrism using docker-compose in the same directory:

docker-compose up -d

The Web frontend is now available at http://localhost:2342/. The port can be changed in docker-compose.yml if needed. Remember to run docker-compose restart every time you change the config.

Step 3: Open a terminal to import photos:

docker-compose exec photoprism bash
photoprism import

You should now be able to see your photos. The full documentation is available at https://docs.photoprism.org/en/latest/.

Contribute

If you have a bug or an idea, read the contributing guidelines before opening an issue. Issues labeled help wanted or good first issue can be good first contributions.

The best way to get in touch is to write an email to hello@photoprism.org or join our Telegram group. We'd love to hear from you!

Donations

Please leave a star if you like this project, it provides enough motivation to keep going. If you still want to donate, you can do so via PayPal.

Sponsoring

Support this project by becoming a sponsor. Your logo will show up here with a link to your website and we can help you getting started with any of the technologies we use, either on-site or remote.