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]
2021-05-15 08:48:37 +00:00
[![Twitter ](https://img.shields.io/badge/follow-@photoprism_app-00acee.svg )][twitter]
2018-02-27 18:46:50 +00:00
2021-01-25 06:43:10 +00:00
PhotoPrism® is a privately hosted app for browsing, organizing, and sharing your photo collection.
It makes use of the latest technologies to tag and find pictures automatically without getting in your way.
2021-08-20 06:25:57 +00:00
Say goodbye to uploading your visual memories to the cloud!
2018-09-27 13:46:20 +00:00
2021-01-06 11:58:06 +00:00
![](https://dl.photoprism.org/assets/img/preview.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
2021-01-25 07:06:17 +00:00
* Our intuitive [user interface ](https://demo.photoprism.org/ ) makes browsing and organizing your 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/ ).
2021-09-25 16:14:06 +00:00
* Privacy-preserving face detection and recognition.
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.
2021-01-07 17:37:05 +00:00
You may easily sync your pictures with [PhotoSync ](https://www.photosync-app.com/ ) as well.
2021-01-25 07:06:17 +00:00
* Because PhotoPrism is built as a [progressive web app ](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps ),
2021-01-25 08:14:05 +00:00
it provides a native app-like experience, and you may install it on your home screen.
2021-01-07 17:37:05 +00:00
There's also a [community-maintained native app in development ](https://github.com/photoprism/photoprism-mobile ).
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/ ) -
2021-10-01 03:12:36 +00:00
all you need is a Web browser and [Docker ](https://docs.docker.com/get-docker/ ) to run the server.
It is available for Mac, Linux, and Windows.
2018-10-07 13:47:56 +00:00
2021-10-01 03:12:36 +00:00
## New Release 🌈 ##
2021-09-25 16:19:16 +00:00
2021-10-01 03:12:36 +00:00
Our [latest release ](https://docs.photoprism.org/release-notes/ ) not only includes
**facial recognition**, it also comes as a
**single [multi-arch image ](https://hub.docker.com/r/photoprism/photoprism ) for AMD64, ARM64, and ARMv7**.
That means you don't need to pull from different Docker repositories anymore.
We recommend updating your existing `docker-compose.yml` config based on
[our examples ](https://dl.photoprism.org/docker/ ).
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
2021-01-25 06:43:10 +00:00
Our vision is to provide the most user-friendly solution for browsing, organizing, and sharing your photo collection.
2020-11-29 12:19:59 +00:00
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.
2021-01-25 06:43:10 +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-11-30 22:22:33 +00:00
You're welcome to support us via [GitHub Sponsors ](https://github.com/sponsors/photoprism ),
2021-02-23 09:22:20 +00:00
especially if you have feature requests< sup > 1< / sup > or need help with using our software.
2021-02-21 10:47:58 +00:00
In addition, you can find us on [Patreon ](https://www.patreon.com/photoprism ) and
2021-05-20 11:21:12 +00:00
[PayPal ](https://www.paypal.me/photoprism ). We've also set up [crypto wallets ](SPONSORS.md ).
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
2021-10-01 03:12:36 +00:00
* pay for operating expenses 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
2021-10-01 03:12:36 +00:00
Thank you very much! ❤️
2020-11-30 11:24:05 +00:00
2021-02-23 13:57:09 +00:00
< sup > 1</ sup > Ideas backed by one or more [eligible sponsors ](SPONSORS.md ) are marked with a [golden label ](https://github.com/photoprism/photoprism/issues?q=is%3Aissue+is%3Aopen+label%3Asponsor ).
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-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
2021-01-25 07:06:17 +00:00
our software, run your server, for educational purposes, but not for offering commercial
2020-06-23 11:44:14 +00:00
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
2021-05-15 08:52:16 +00:00
[twitter]: https://twitter.com/photoprism_app
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