121 lines
7.4 KiB
Markdown
121 lines
7.4 KiB
Markdown
PhotoPrism: Browse Your Life in Pictures
|
|
========================================
|
|
|
|
[![License: AGPL](https://img.shields.io/badge/license-AGPL-blue.svg)][license]
|
|
[![Code Quality](https://goreportcard.com/badge/github.com/photoprism/photoprism)][goreport]
|
|
[![Build Status](https://drone.photoprism.app/api/badges/photoprism/photoprism/status.svg?ref=refs/heads/develop)][ci]
|
|
[![GitHub contributors](https://img.shields.io/github/contributors/photoprism/photoprism.svg)](https://github.com/photoprism/photoprism/graphs/contributors/)
|
|
[![Documentation](https://img.shields.io/badge/read-the%20docs-4aa087.svg)][docs]
|
|
[![Community Chat](https://img.shields.io/badge/chat-on%20gitter-4aa087.svg)][chat]
|
|
[![Twitter](https://img.shields.io/badge/follow-@browseyourlife-00acee.svg)][twitter]
|
|
|
|
PhotoPrism® is a server-based application for browsing, organizing and sharing your personal photo collection.
|
|
It makes use of the latest technologies to automatically tag and find pictures without getting in your way.
|
|
Say goodbye to solutions that force you to upload your visual memories to the cloud.
|
|
|
|
![](https://dl.photoprism.org/assets/img/preview.jpg)
|
|
|
|
## What to expect... ##
|
|
|
|
* clearly structured Web interface for browsing, organizing and sharing your personal photo collection
|
|
* 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/)
|
|
based on Google TensorFlow
|
|
|
|
## Try our demo ##
|
|
|
|
You're welcome to play with the demo at [demo.photoprism.org](https://demo.photoprism.org).
|
|
|
|
## Getting started ##
|
|
|
|
Step-by-step installation instructions can be found on [docs.photoprism.org](https://docs.photoprism.org/getting-started/) -
|
|
all you need is a Web browser and Docker to run the server. It is available for Mac, Linux and Windows.
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
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).
|
|
|
|
## Contributions ##
|
|
|
|
We welcome contributions of any kind. If you have a bug or an idea, read our
|
|
[guide](https://docs.photoprism.org/developer-guide/) before opening an issue.
|
|
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
|
|
good (first) contributions.
|
|
|
|
Follow us on [Twitter][twitter] to receive regular project updates and discuss development
|
|
related topics. Don't be afraid to ask stupid questions.
|
|
|
|
## Funding ##
|
|
|
|
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
|
|
will have a price tag and then maybe you'd like to have some extra features that need to be developed.
|
|
|
|
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.
|
|
An earlier version of this document contained a rough number, but at the end of the day it doesn't matter.
|
|
|
|
Most established OSS companies make the bulk of their revenue with enterprise customers, that's why private users
|
|
and single developers typically get everything for free. Obviously that doesn't work if you have only private users
|
|
that refuse to share their data on top of it.
|
|
|
|
Looking forward, specific solutions for funding development and maintenance could be to...
|
|
|
|
- sell a tested & supported version in the app store while our contributors and other developers can
|
|
continue to use Docker or build from source
|
|
- 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
|
|
- offer a geodata, public events, and maps subscription since OpenStreetMap doesn't want us to use their development
|
|
API for production, which is perfectly fine
|
|
|
|
## Donations ##
|
|
|
|
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.
|
|
In addition, you can find us on [Patreon](https://www.patreon.com/photoprism) and [PayPal](https://www.paypal.me/browseyourlife).
|
|
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
|
|
have to charge for a geodata subscription and/or additional features later.
|
|
|
|
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.
|
|
|
|
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).
|
|
|
|
Thank you very much! <3
|
|
|
|
## Trademarks ##
|
|
|
|
PhotoPrism® is a registered trademark of Michael Mayer. You may use it as required to describe
|
|
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.
|
|
|
|
[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
|
|
[license]: https://github.com/photoprism/photoprism/blob/develop/LICENSE
|
|
[patreon]: https://www.patreon.com/photoprism
|
|
[paypal]: https://www.paypal.me/browseyourlife
|
|
[goreport]: https://goreportcard.com/report/github.com/photoprism/photoprism
|
|
[coverage]: https://codecov.io/gh/photoprism/photoprism
|
|
[ci]: https://drone.photoprism.app/photoprism/photoprism
|
|
[docs]: https://docs.photoprism.org/
|
|
[issuehunt]: https://issuehunt.io/repos/119160553
|
|
[chat]: https://gitter.im/browseyourlife/community
|
|
[twitter]: https://twitter.com/browseyourlife
|
|
[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
|