2020-06-23 13:44:14 +02:00
PhotoPrism: Browse Your Life in Pictures
2018-10-05 08:27:45 +02:00
========================================
2018-08-23 14:44:21 +02:00
2020-06-15 09:49:06 +02:00
[![License: AGPL ](https://img.shields.io/badge/license-AGPL-blue.svg )][license]
2018-12-19 05:39:12 +01:00
[![Code Quality ](https://goreportcard.com/badge/github.com/photoprism/photoprism )][goreport]
2020-08-13 17:46:54 +02:00
[![Build Status ](https://drone.photoprism.app/api/badges/photoprism/photoprism/status.svg?ref=refs/heads/develop )][ci]
2019-04-29 17:20:33 +02:00
[![GitHub contributors ](https://img.shields.io/github/contributors/photoprism/photoprism.svg )](https://github.com/photoprism/photoprism/graphs/contributors/)
2020-06-07 13:26:13 +02:00
[![Documentation ](https://img.shields.io/badge/read-the%20docs-4aa087.svg )][docs]
2019-01-09 06:03:03 +01:00
[![Community Chat ](https://img.shields.io/badge/chat-on%20gitter-4aa087.svg )][chat]
2019-07-04 18:41:17 +02:00
[![Twitter ](https://img.shields.io/badge/follow-@browseyourlife-00acee.svg )][twitter]
2018-02-27 19:46:50 +01:00
2020-09-20 15:10:59 +02:00
PhotoPrism® is a server-based application for browsing, organizing and sharing your personal photo collection.
2018-10-13 17:40:57 +02:00
It makes use of the latest technologies to automatically tag and find pictures without getting in your way.
2020-06-23 20:47:57 +02:00
Say goodbye to solutions that force you to upload your visual memories to the cloud.
2018-09-27 15:46:20 +02:00
2018-12-19 00:24:02 +01:00
![](https://dl.photoprism.org/assets/img/preview.jpg)
2018-09-26 15:35:34 +02:00
2020-06-23 20:37:26 +02:00
## What to expect... ##
2018-09-27 15:46:20 +02:00
2020-06-24 13:49:13 +02:00
* clearly structured Web interface for browsing, organizing and sharing your personal photo collection
2020-07-20 16:46:14 +02:00
* import everything without worrying about duplicates or [RAW to JPEG conversion ](https://docs.photoprism.org/developer-guide/library/converting/ )
* [geocoding ](https://docs.photoprism.org/developer-guide/metadata/geocoding/ ), [XMP support ](https://docs.photoprism.org/developer-guide/metadata/xmp/ ) and [automated tagging ](https://docs.photoprism.org/developer-guide/metadata/classification/ )
2020-01-14 00:31:16 +01:00
based on Google TensorFlow
2018-09-27 22:40:38 +02:00
2020-06-24 14:40:54 +02:00
## Try our demo ##
2018-10-07 15:47:56 +02:00
2020-06-24 14:40:54 +02:00
You're welcome to play with the demo at [demo.photoprism.org ](https://demo.photoprism.org ).
2018-12-16 16:32:24 +01:00
2020-11-22 17:51:22 +01:00
## Getting started ##
2020-06-24 14:40:54 +02:00
2020-06-23 20:22:01 +02:00
Step-by-step installation instructions can be found on [docs.photoprism.org ](https://docs.photoprism.org/getting-started/ ) -
2020-06-23 20:20:24 +02: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 15:47:56 +02:00
2020-11-22 17:51:22 +01:00
Next, you'll have to [index ](https://docs.photoprism.org/user-guide/library/import-vs-index/ )
your library. Please be patient, this will take a while depending on the size of your photo collection.
2019-12-16 12:59:03 +01:00
2020-06-23 20:20:24 +02:00
Already indexed photos can be browsed in [Photos ](https://docs.photoprism.org/user-guide/organize/browse/ )
while videos show up in [Videos ](https://docs.photoprism.org/user-guide/organize/video/ ).
Counts are continuously updated in the navigation.
2020-02-18 10:59:13 +01:00
2020-06-23 20:20:24 +02:00
If photos are missing, they might be in [review ](https://docs.photoprism.org/user-guide/organize/review/ ) due to low quality or missing metadata.
You can turn this and other features off in [Settings ](https://docs.photoprism.org/user-guide/settings/ui/ ), depending on
your specific use case.
2018-12-16 15:37:46 +01:00
2020-11-22 17:51:22 +01:00
Note that this is work in progress. We do our best to provide a complete, stable version.
Leave your email to get a [release notification ](https://goo.gl/forms/KBPVGl9PCsOKrAv33 ).
2020-06-23 14:22:05 +02:00
## Contributions ##
2018-10-05 16:31:57 +02:00
2018-10-13 17:38:02 +02:00
We welcome contributions of any kind. If you have a bug or an idea, read our
2020-06-07 13:14:20 +02:00
[guide ](https://docs.photoprism.org/developer-guide/ ) before opening an issue.
2018-11-22 20:02:24 +01: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 16:02:22 +01:00
good (first) contributions.
2020-06-23 20:20:24 +02: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 16:31:57 +02:00
2020-06-23 19:47:19 +02:00
## Funding ##
2020-01-04 20:19:50 +01:00
2020-01-26 10:56:22 +01:00
This project is about freedom and privacy but not necessarily about free beer. We feel like it
would be a mistake to state there will be no costs, because clearly we have huge expenses, your server hardware
2020-01-09 23:57:55 +01: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 20:19:50 +01:00
2020-01-26 11:07:52 +01:00
It's fair to say that users with basic needs will have no monthly costs. We were also way more effective
per dollar than commercial projects and learned a lot on top of it.
2020-01-09 23:57:55 +01:00
An earlier version of this document contained a rough number, but at the end of the day it doesn't matter.
2020-01-04 20:19:50 +01:00
2020-06-22 15:35:57 +02:00
Most established OSS companies make the bulk of their revenue with enterprise customers, that's why private users
2020-01-09 23:57:55 +01:00
and single developers typically get everything for free. Obviously that doesn't work if you have only private users
2020-06-22 15:49:19 +02:00
that refuse to share their data on top of it.
2020-01-09 13:23:31 +01:00
2020-01-09 23:57:55 +01:00
Looking forward, specific solutions for funding development and maintenance could be to...
2020-01-04 20:19:50 +01:00
2020-01-04 22:03:10 +01:00
- sell a tested & supported version in the app store while our contributors and other developers can
2020-01-04 20:19:50 +01:00
continue to use Docker or build from source
2020-06-22 15:35:57 +02:00
- provide additional features to users who support us financially, maybe with a different license similar to GitLab
- develop a one-click solution for private cloud hosting together with selected providers we trust
2020-10-19 12:02:04 +02:00
- offer a geodata, public events, and maps subscription since OpenStreetMap doesn't want us to use their development
2020-01-09 13:23:31 +01:00
API for production, which is perfectly fine
2020-01-04 20:19:50 +01:00
## Donations ##
2019-12-11 19:34:52 +01:00
2020-06-09 11:25:33 +02:00
You're welcome to support us via [GitHub Sponsors ](https://github.com/sponsors/lastzero ),
especially if you have feature requests or need help with using our software.
They will match every donation in the first year.
2020-11-15 05:08:55 +01:00
In addition, you can find us on [Patreon ](https://www.patreon.com/photoprism ) and [PayPal ](https://www.paypal.me/browseyourlife ).
2020-01-09 03:55:14 +01:00
Our [sponsors ](https://github.com/photoprism/photoprism/blob/develop/SPONSORS.md ) and
[contributors ](https://github.com/photoprism/photoprism/graphs/contributors/ ) will get for free whatever we might
2020-11-15 05:08:55 +01:00
have to charge for a geodata subscription and/or additional features later.
2018-10-05 19:21:31 +02:00
2020-06-15 14:40:46 +02: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 23:18:27 +01:00
2020-01-09 03:55:14 +01:00
Ideas backed by a sponsor are marked with a golden [sponsor ](https://github.com/photoprism/photoprism/issues?q=is%3Aissue+is%3Aopen+label%3Asponsor ) label.
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 06:38:56 +01:00
2020-01-04 20:29:08 +01:00
Thank you very much! < 3
2020-06-23 13:44:14 +02:00
## Trademarks ##
2020-01-09 05:26:19 +01:00
2020-09-20 15:10:59 +02:00
PhotoPrism® is a registered trademark of Michael Mayer. You may use it as required to describe
2020-06-23 13:44:14 +02: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 05:26:19 +01:00
2020-01-14 00:31:16 +01: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 04:24:43 +01:00
[license]: https://github.com/photoprism/photoprism/blob/develop/LICENSE
2019-12-30 13:03:34 +01:00
[patreon]: https://www.patreon.com/photoprism
2020-11-15 05:08:55 +01:00
[paypal]: https://www.paypal.me/browseyourlife
2018-11-20 09:23:45 +01:00
[goreport]: https://goreportcard.com/report/github.com/photoprism/photoprism
2018-11-19 04:24:43 +01:00
[coverage]: https://codecov.io/gh/photoprism/photoprism
2020-08-13 17:46:54 +02:00
[ci]: https://drone.photoprism.app/photoprism/photoprism
2020-06-07 13:14:20 +02:00
[docs]: https://docs.photoprism.org/
2018-12-20 19:35:52 +01:00
[issuehunt]: https://issuehunt.io/repos/119160553
2019-01-09 06:03:03 +01:00
[chat]: https://gitter.im/browseyourlife/community
2019-07-04 18:41:17 +02:00
[twitter]: https://twitter.com/browseyourlife
2019-12-30 13:03:34 +01: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