2020-06-23 11:44:14 +00:00
PhotoPrism: Browse Your Life in Pictures
2018-10-05 06:27:45 +00:00
========================================
2018-08-23 12:44:21 +00:00
2020-06-15 07:49:06 +00:00
[![License: AGPL ](https://img.shields.io/badge/license-AGPL-blue.svg )][license]
2018-12-19 04:39:12 +00:00
[![Code Quality ](https://goreportcard.com/badge/github.com/photoprism/photoprism )][goreport]
2020-08-13 15:46:54 +00:00
[![Build Status ](https://drone.photoprism.app/api/badges/photoprism/photoprism/status.svg?ref=refs/heads/develop )][ci]
2019-04-29 15:20:33 +00:00
[![GitHub contributors ](https://img.shields.io/github/contributors/photoprism/photoprism.svg )](https://github.com/photoprism/photoprism/graphs/contributors/)
2020-06-07 11:26:13 +00:00
[![Documentation ](https://img.shields.io/badge/read-the%20docs-4aa087.svg )][docs]
2019-01-09 05:03:03 +00:00
[![Community Chat ](https://img.shields.io/badge/chat-on%20gitter-4aa087.svg )][chat]
2019-07-04 16:41:17 +00:00
[![Twitter ](https://img.shields.io/badge/follow-@browseyourlife-00acee.svg )][twitter]
2018-02-27 18:46:50 +00:00
2020-09-20 13:10:59 +00:00
PhotoPrism® is a server-based application for browsing, organizing and sharing your personal photo collection.
2018-10-13 15:40:57 +00:00
It makes use of the latest technologies to automatically tag and find pictures without getting in your way.
2020-11-26 19:45:48 +00:00
Say goodbye to solutions that force you to upload your visual memories to the cloud!
2018-09-27 13:46:20 +00:00
2020-12-13 16:02:37 +00:00
![](https://dl.photoprism.org/assets/img/preview-moonlight.jpg)
2018-09-26 13:35:34 +00:00
2020-12-26 12:40:26 +00:00
To get a first impression, you're welcome to play with our public demo at [demo.photoprism.org ](https://demo.photoprism.org/ ).
2020-11-27 17:14:56 +00:00
## Key Features ##
2018-09-27 13:46:20 +00:00
2020-12-02 09:59:00 +00:00
* Our clearly structured [user interface ](https://demo.photoprism.org/ ) makes browsing and organizing your personal photo collection as easy as
2020-11-27 17:14:56 +00:00
it should be — whether it’ s on a phone, tablet, or desktop computer.
2020-11-27 18:30:45 +00:00
* Index everything without worrying about duplicates or [RAW to JPEG conversion ](https://docs.photoprism.org/developer-guide/library/converting/ ).
2020-11-27 17:23:46 +00:00
* Automatic [image classification ](https://docs.photoprism.org/developer-guide/metadata/classification/ )
2020-12-02 10:10:43 +00:00
based on Google TensorFlow. In addition, our indexer detects _colors_ , _chroma_ , _luminance_ , _quality_ , _panoramic projection_ ,
_location type_ , and many other properties.
2020-11-28 11:31:28 +00:00
* Includes four high-resolution [world maps ](https://demo.photoprism.org/places ) to see where you've been,
and for rediscovering long-forgotten shots.
2020-11-27 17:43:33 +00:00
* WebDAV clients, like Microsoft’ s Windows Explorer or Apple's Finder, may
2020-12-21 18:21:16 +00:00
[connect ](https://docs.photoprism.org/user-guide/sync/webdav/ ) directly to PhotoPrism so that you to can open,
2020-11-27 17:43:33 +00:00
edit, and delete files from your computer or phone as if they were local.
2020-11-27 17:14:56 +00:00
You may easily sync your pictures with [Nextcloud ](https://nextcloud.com/ ) as well.
2020-11-27 17:23:46 +00:00
* PhotoPrism feels [like a native app ](https://en.wikipedia.org/wiki/Progressive_web_application ) and,
of course, you can also add it to your home screen.
2020-11-27 17:14:56 +00:00
2020-11-26 19:45:48 +00:00
## Getting Started ##
2020-06-24 12:40:54 +00:00
2020-11-29 11:39:49 +00:00
Step-by-step installation instructions for our self-hosted [community edition ](https://photoprism.app/get ) can be found
2020-11-27 17:23:46 +00:00
on [docs.photoprism.org ](https://docs.photoprism.org/getting-started/ ) -
2020-06-23 18:20:24 +00:00
all you need is a Web browser and Docker to run the server. It is available for Mac, Linux and Windows.
2018-10-07 13:47:56 +00:00
2020-12-26 12:40:26 +00:00
We recommend hosting PhotoPrism on a server with **at least 2 cores** and **4 GB of memory** .
2020-12-28 20:20:05 +00:00
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.
2020-12-26 12:40:26 +00:00
2020-11-29 12:01:13 +00:00
## Roadmap ##
2020-11-26 19:45:48 +00:00
2020-11-29 12:19:59 +00:00
Our vision is to provide the most user-friendly solution for browsing, organizing and sharing your personal photo collection.
The [roadmap ](https://github.com/photoprism/photoprism/projects/5 ) shows what tasks are in progress,
2020-11-26 19:45:48 +00:00
what needs testing, and which feature requests are going to be implemented next.
Please give ideas you like a thumbs-up 👍 , so that we know what is most popular.
2020-11-29 12:56:00 +00:00
Ideas backed by one or more eligible [sponsors ](SPONSORS.md ) will be prioritized as well.
2020-11-26 19:45:48 +00:00
2020-06-23 12:22:05 +00:00
## Contributions ##
2018-10-05 14:31:57 +00:00
2018-10-13 15:38:02 +00:00
We welcome contributions of any kind. If you have a bug or an idea, read our
2020-06-07 11:14:20 +00:00
[guide ](https://docs.photoprism.org/developer-guide/ ) before opening an issue.
2018-11-22 19:02:24 +00:00
Issues labeled [help wanted ](https://github.com/photoprism/photoprism/labels/help%20wanted ) /
[easy ](https://github.com/photoprism/photoprism/issues?q=is%3Aissue+is%3Aopen+label%3Aeasy ) can be
2018-12-20 15:02:22 +00:00
good (first) contributions.
2020-06-23 18:20:24 +00:00
Follow us on [Twitter][twitter] to receive regular project updates and discuss development
related topics. Don't be afraid to ask stupid questions.
2018-10-05 14:31:57 +00:00
2020-06-23 17:47:19 +00:00
## Funding ##
2020-01-04 19:19:50 +00:00
2020-12-26 15:04:45 +00:00
This software is about freedom and privacy but not necessarily about free beer. We feel like it
2020-01-26 09:56:22 +00:00
would be a mistake to state there will be no costs, because clearly we have huge expenses, your server hardware
2020-12-05 05:04:32 +00:00
will have a price tag, and then maybe you'd like to have some extra features that need to be developed.
2020-01-04 19:19:50 +00:00
2020-11-30 22:22:33 +00:00
You're welcome to support us via [GitHub Sponsors ](https://github.com/sponsors/photoprism ),
2020-12-05 05:04:32 +00:00
especially if you have feature requests, or need help with using our software.
2020-12-26 15:04:45 +00:00
In addition, you can find us on [Patreon ](https://www.patreon.com/photoprism )
2020-12-26 12:40:26 +00:00
and [PayPal ](https://www.paypal.me/photoprism ).
2020-11-28 03:36:17 +00:00
2020-11-29 11:21:22 +00:00
Your continuous support helps...
2020-11-28 11:31:28 +00:00
2020-11-29 11:21:22 +00:00
* to pay for hosting, hardware and external services like satellite maps
* developing new features, and keeping them free for everyone 🌈
2018-10-05 17:21:31 +00:00
2020-06-15 12:40:46 +00:00
Also, please [leave a star ](https://github.com/photoprism/photoprism/stargazers ) on GitHub if you like this project.
It provides additional motivation to keep going.
2019-12-05 22:18:27 +00:00
2020-11-30 11:24:05 +00:00
Thank you very much! < 3
2020-11-29 12:01:13 +00:00
Ideas backed by one or more eligible [sponsors ](SPONSORS.md ) are marked with a golden [sponsor ](https://github.com/photoprism/photoprism/issues?q=is%3Aissue+is%3Aopen+label%3Asponsor ) label.
2020-01-09 02:55:14 +00:00
Let us know if we mistakenly label an idea as [unfunded ](https://github.com/photoprism/photoprism/issues?q=is%3Aissue+is%3Aopen+label%3Aunfunded ).
2019-01-09 05:38:56 +00:00
2020-12-01 14:53:33 +00:00
*Note that we've recently moved GitHub Sponsors from [sponsors/lastzero ](https://github.com/sponsors/lastzero ) to an
[organization account ](https://github.com/sponsors/photoprism ) so that donations can be shared more easily.
Tiers are more affordable now while benefits stay mostly the same.*
2020-06-23 11:44:14 +00:00
## Trademarks ##
2020-01-09 04:26:19 +00:00
2020-09-20 13:10:59 +00:00
PhotoPrism® is a registered trademark of Michael Mayer. You may use it as required to describe
2020-06-23 11:44:14 +00:00
our software, run your own server, for educational purposes, but not for offering commercial
goods, products, or services without prior written permission. In other words, please ask.
2020-01-09 04:26:19 +00:00
2020-01-13 23:31:16 +00:00
[wiki:classification]: https://github.com/photoprism/photoprism/wiki/Image-Classification
[wiki:xmp]: https://github.com/photoprism/photoprism/wiki/XMP
[wiki:geocoding]: https://github.com/photoprism/photoprism/wiki/Geocoding
[wiki:raw]: https://github.com/photoprism/photoprism/wiki/Converting-RAW-to-JPEG
2018-11-19 03:24:43 +00:00
[license]: https://github.com/photoprism/photoprism/blob/develop/LICENSE
2019-12-30 12:03:34 +00:00
[patreon]: https://www.patreon.com/photoprism
2020-12-26 12:40:26 +00:00
[paypal]: https://www.paypal.me/photoprism
2018-11-20 08:23:45 +00:00
[goreport]: https://goreportcard.com/report/github.com/photoprism/photoprism
2018-11-19 03:24:43 +00:00
[coverage]: https://codecov.io/gh/photoprism/photoprism
2020-08-13 15:46:54 +00:00
[ci]: https://drone.photoprism.app/photoprism/photoprism
2020-06-07 11:14:20 +00:00
[docs]: https://docs.photoprism.org/
2018-12-20 18:35:52 +00:00
[issuehunt]: https://issuehunt.io/repos/119160553
2019-01-09 05:03:03 +00:00
[chat]: https://gitter.im/browseyourlife/community
2019-07-04 16:41:17 +00:00
[twitter]: https://twitter.com/browseyourlife
2019-12-30 12:03:34 +00:00
[unfunded issues]: https://github.com/photoprism/photoprism/issues?q=is%3Aissue+is%3Aopen+label%3Aunfunded
[sponsored issues]: https://github.com/photoprism/photoprism/issues?q=is%3Aissue+is%3Aopen+label%3Asponsor