2018-10-05 17:19:46 +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]
2018-10-31 02:05:51 +00:00
[![Build Status ](https://travis-ci.org/photoprism/photoprism.png?branch=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-05-21 08:03:56 +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-06-22 13:35:57 +00:00
Say goodbye to solutions that force you to upload your visual memories to the public cloud.
2018-09-27 13:46:20 +00:00
2018-12-18 23:24:02 +00:00
![](https://dl.photoprism.org/assets/img/preview.jpg)
2018-09-26 13:35:34 +00:00
2020-01-24 03:07:58 +00:00
More screenshots: https://github.com/photoprism/photoprism/wiki/Screenshots
2018-10-07 13:05:17 +00:00
2019-01-09 05:38:56 +00:00
## What to expect ##
2018-09-27 13:46:20 +00:00
2020-01-24 03:09:02 +00:00
* Clearly structured Web interface for browsing, organizing and sharing your personal photo collection
2020-01-15 13:45:49 +00:00
* Import everything without worrying about duplicates or [RAW to JPEG conversion][wiki:raw]
2020-01-31 16:29:55 +00:00
* [Geocoding][wiki:geocoding], [XMP support][wiki:xmp] and [automated tagging][wiki:classification]
2020-01-13 23:31:16 +00:00
based on Google TensorFlow
2018-09-27 20:40:38 +00:00
2019-01-09 05:38:56 +00:00
## For the early birds ##
2018-10-07 13:47:56 +00:00
2018-12-16 13:04:54 +00:00
You're welcome to play with our demo at [demo.photoprism.org ](https://demo.photoprism.org ).
Leave your email to get a [release notification ](https://goo.gl/forms/KBPVGl9PCsOKrAv33 ).
2018-12-16 15:32:24 +00:00
2020-06-07 11:14:20 +00:00
Step-by-step [installation instructions ](https://docs.photoprism.org/getting-started/ ) can be found
in our [User Guide ](https://docs.photoprism.org/ ).
Developers can skip this and move on to the [Developer Guide ](https://docs.photoprism.org/developer-guide/ ).
2018-10-07 13:47:56 +00:00
2018-10-13 17:54:29 +00:00
All you need is a Web browser and [Docker ](https://store.docker.com/search?type=edition&offering=community )
to run the server. It is available for Mac, Linux and Windows.
2019-12-16 11:59:03 +00:00
2020-02-18 09:59:13 +00:00
There is also a [pre-installed Raspberry Pi image here ](https://github.com/guysoft/PhotoPrismPi ).
2020-01-08 11:40:20 +00:00
Note that this is work in progress. We do our best to provide a complete, stable version.
2019-12-30 12:03:34 +00:00
If you have a question, don't hesitate to ask in our [help forum][help]
2018-11-22 20:20:55 +00:00
or [contact us via email ](mailto:hello@photoprism.org ).
2018-10-13 17:54:29 +00:00
2019-01-09 05:38:56 +00:00
## Why this has to be free software ##
2018-10-07 13:47:56 +00:00
2018-10-13 15:28:53 +00:00
The development of every commercial product is focused on monetization.
2019-12-30 12:03:34 +00:00
We've [built similar apps more than once ](https://github.com/photoprism/photoprism/wiki/Mediencenter )
and every single time the constraints of working
2018-10-13 15:28:53 +00:00
in a profit-oriented corporate environment were an impediment.
2018-12-16 14:13:52 +00:00
2019-12-30 12:03:34 +00:00
We are sure we can do better with only a fraction of the budget. Simplicity - the art of maximizing the
amount of work not done - can be very powerful.
2018-12-20 19:55:48 +00:00
Go itself is a [great example ](https://talks.golang.org/2015/simplicity-is-complicated.slide ).
2018-10-07 13:47:56 +00:00
2019-12-30 12:03:34 +00:00
Our long-term goal is to become an open platform for machine
learning [research ](https://github.com/photoprism/photoprism/wiki/Research ) based on real-world photo collections.
2020-01-09 22:57:55 +00:00
We're already in contact with data scientists who like our idea.
2018-12-16 14:37:46 +00:00
2019-01-09 05:38:56 +00:00
## How to contribute ##
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.
2019-12-30 19:10:45 +00:00
Please follow us on [Twitter][twitter] and join our [developers mailing list ](https://groups.google.com/a/photoprism.org/forum/#!forum/developers )
2018-11-23 10:44:23 +00:00
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-01-09 15:11:40 +00:00
## Free beer ##
2020-01-04 19:19:50 +00:00
2020-01-26 09:56:22 +00: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 22:57:55 +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-01-26 10:07:52 +00: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 22:57:55 +00: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 19:19:50 +00:00
2020-06-22 13:35:57 +00:00
Most established OSS companies make the bulk of their revenue with enterprise customers, that's why private users
2020-01-09 22:57:55 +00:00
and single developers typically get everything for free. Obviously that doesn't work if you have only private users
2020-06-22 13:49:19 +00:00
that refuse to share their data on top of it.
2020-01-09 12:23:31 +00:00
2020-01-09 22:57:55 +00:00
Looking forward, specific solutions for funding development and maintenance could be to...
2020-01-04 19:19:50 +00:00
2020-01-04 21:03:10 +00:00
- sell a tested & supported version in the app store while our contributors and other developers can
2020-01-04 19:19:50 +00:00
continue to use Docker or build from source
2020-06-22 13:35:57 +00: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-01-09 02:55:14 +00:00
- offer a geodata, public events and maps subscription since OpenStreetMap doesn't want us to use their development
2020-01-09 12:23:31 +00:00
API for production, which is perfectly fine
2020-01-04 19:19:50 +00:00
## Donations ##
2019-12-11 18:34:52 +00:00
2020-06-09 09:25:33 +00: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-01-09 02:55:14 +00:00
In addition, you can find us on [Patreon ](https://www.patreon.com/photoprism ) and [PayPal ](https://www.paypal.me/photoprism ).
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-06-22 13:35:57 +00:00
have to charge for a geodata subscription and/or additional features later (see [tiers ](https://github.com/sponsors/lastzero/dashboard/tiers )).
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-01-09 02:55:14 +00: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 05:38:56 +00:00
2020-01-04 19:29:08 +00:00
Thank you very much! < 3
2020-01-09 04:26:19 +00:00
## Disclaimer ##
2020-03-06 13:30:04 +00:00
We'd like to remind everyone that we are not full-time marketing specialists but developers who work a lot and
2020-05-21 15:44:28 +00:00
enjoy a bit of sarcasm from time to time. Please let us know when there is an issue with our "nuance and tone",
2020-01-09 04:26:19 +00:00
and we'll find a solution.
2020-06-22 13:35:57 +00:00
PhotoPrism™ is a registered trademark of Michael Mayer.
2020-05-23 07:49:26 +00:00
You may use it as required to describe our software, run your own server, for educational purposes,
2020-06-15 12:40:46 +00:00
but not for offering commercial goods, products, or services without prior written permission.
2020-05-24 10:59:07 +00:00
In other words, please ask.
2020-05-21 08:03:56 +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
2019-12-30 12:03:34 +00:00
[help]: https://groups.google.com/a/photoprism.org/forum/#!forum/help
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
2019-01-09 05:38:56 +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
[ci]: https://travis-ci.org/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