2021-10-11 21:32:13 +00:00
PhotoPrism: Browse Your Life in Pictures
========================================
2018-08-23 12:44:21 +00:00
2020-06-15 07:49:06 +00:00
[][license]
2021-12-12 19:15:52 +00:00
2019-04-29 15:20:33 +00:00
[](https://github.com/photoprism/photoprism/graphs/contributors/)
2020-06-07 11:26:13 +00:00
[][docs]
2019-01-09 05:03:03 +00:00
[][chat]
2021-10-23 18:34:01 +00:00
[][ask]
2021-05-15 08:48:37 +00:00
[][twitter]
2018-02-27 18:46:50 +00:00
2021-10-20 06:54:23 +00:00
PhotoPrism® is an AI-powered app for browsing, organizing & sharing your photo collection.
It makes use of the latest technologies to tag and find pictures automatically without getting in your way.
2021-10-18 19:47:03 +00:00
You can run it at home, on a private server, or in the cloud.
2018-09-27 13:46:20 +00:00
2021-12-12 19:15:52 +00:00
2018-09-26 13:35:34 +00:00
2021-12-12 22:48:15 +00:00
To get a first impression, you're welcome to play with our public demo at [demo.photoprism.app ](https://demo.photoprism.app/ )
2021-12-12 22:48:59 +00:00
(also available in [Deutsch ](https://demo-de.photoprism.app/ ), [Français ](https://demo-fr.photoprism.app/ ), and [汉语 ](https://demo-zh.photoprism.app/ )).
2020-12-26 12:40:26 +00:00
2021-10-18 15:09:32 +00:00
## Feature Overview ##
2018-09-27 13:46:20 +00:00
2021-12-12 19:14:07 +00:00
* Browse [all your photos ](https://docs.photoprism.app/user-guide/organize/browse/ ) and [videos ](https://demo.photoprism.app/videos ) without worrying about [RAW conversion, duplicates or video formats ](https://docs.photoprism.app/user-guide/settings/library/ )
2021-12-12 17:26:16 +00:00
* Easily find specific pictures using [powerful search filters ](https://demo.photoprism.app/browse?view=cards&q=flower%20color%3Ared )
2021-10-31 12:25:36 +00:00
* Privacy-friendly: No data is ever sent to Google, Amazon, Facebook, or Apple unless you explicitly upload files to one of their services 🔐
2021-12-12 17:26:16 +00:00
* Recognizes [the faces of your family and friends ](https://demo.photoprism.app/people )
* [Automatic classification ](https://demo.photoprism.app/labels ) of pictures based on their content and location
* [Play Live Photos ](https://demo.photoprism.app/live ) by hovering over them in [albums ](https://demo.photoprism.app/albums ) and [search results ](https://demo.photoprism.app/browse?view=cards&q=type%3Alive )
* Since the [User Interface ](https://demo.photoprism.app/ ) is a [Progressive Web App ](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps ),
2021-10-14 16:54:47 +00:00
it provides a native app-like experience, and you can conveniently install it on the home screen of all major operating systems and mobile devices
2021-12-12 17:26:16 +00:00
* Includes four high-resolution [World Maps ](https://demo.photoprism.app/places ) to bring back the memories of your favorite trips
2021-10-14 18:27:56 +00:00
* Metadata is extracted and merged from Exif, XMP, and other sources such as Google Photos
2021-12-12 17:26:16 +00:00
* Many more image properties like [Colors ](https://demo.photoprism.app/browse?view=cards&q=color:red ), [Chroma ](https://demo.photoprism.app/browse?view=cards&q=mono%3Atrue ), and [Quality ](https://demo.photoprism.app/review ) can be searched as well
2021-12-12 22:33:21 +00:00
* Use [PhotoSync ](https://www.photosync-app.com/ ) to securely backup iOS and Android phones in the background
2021-12-12 19:14:07 +00:00
* WebDAV clients such as Microsoft's Windows Explorer and Apple's Finder [can connect directly ](https://docs.photoprism.app/user-guide/sync/webdav/ ) to PhotoPrism, allowing you to open, edit, and delete files from your computer as if they were local
2020-11-27 17:14:56 +00:00
2020-11-26 19:45:48 +00:00
## Getting Started ##
2021-12-10 14:45:45 +00:00
< img align = "right" width = "25%" src = "https://photoprism.app/user/pages/01.home/03._screenshots/iphone-maps-hybrid-540px.png" >
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
2021-12-12 19:14:07 +00:00
on [docs.photoprism.app ](https://docs.photoprism.app/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-12-12 19:14:07 +00:00
The [stable version ](https://docs.photoprism.app/release-notes/ ) and development
2021-12-10 21:38:47 +00:00
preview have been built into a single [multi-arch image ](https://hub.docker.com/r/photoprism/photoprism ) for 64-bit AMD, Intel,
2021-12-12 19:14:07 +00:00
and ARM processors. That means, [Raspberry Pi ](https://docs.photoprism.app/getting-started/raspberry-pi/ ) 3 / 4 owners can pull
2021-12-10 21:38:47 +00:00
from the same repository, enjoy the exact same functionality, and can follow the regular
2021-12-12 19:14:07 +00:00
[installation instructions ](https://docs.photoprism.app/getting-started/docker-compose/ )
after going through a short list of [requirements ](https://docs.photoprism.app/getting-started/raspberry-pi/ ).
2021-12-10 21:38:47 +00:00
Existing users are advised to update their `docker-compose.yml` config based on our examples
2021-12-12 19:19:55 +00:00
available at [dl.photoprism.app/docker ](https://dl.photoprism.app/docker/ ).
2020-12-26 12:40:26 +00:00
2021-12-20 11:35:06 +00:00
## Back us on [Patreon](https://www.patreon.com/photoprism) or [GitHub Sponsors](https://github.com/sponsors/photoprism) 🎄 ##
2020-01-04 19:19:50 +00:00
2021-12-20 12:42:05 +00:00
Your continued support helps us provide services like world maps and develop [new features ](https://github.com/photoprism/photoprism/projects/5 ).
2021-12-20 11:35:06 +00:00
Sponsors get access to [additional features ](https://github.com/photoprism/photoprism/issues?q=label%3Asponsor-feature ),
receive direct [technical support ](https://photoprism.app/contact ) via email, and can join our private chat room
on [matrix.org ](https://matrix.org/ ).
2021-12-13 02:45:52 +00:00
We currently have the following sponsorship options:
2021-10-08 12:54:24 +00:00
2021-12-20 11:35:06 +00:00
- [GitHub Sponsors ](https://github.com/sponsors/photoprism ) is priced in USD and also offers [one-time donations ](https://github.com/sponsors/photoprism?frequency=one-time )
- [Patreon ](https://www.patreon.com/photoprism ) is priced in Euro and also offers yearly payments
- Stripe will be available in early 2022, so you can sign up directly in the app without having a Patreon or GitHub account
- You're welcome to [contact us ](https://photoprism.app/contact ) for other options
2021-12-13 02:45:52 +00:00
Also, please [leave a star ](https://github.com/photoprism/photoprism/stargazers ) on GitHub if you like this project.
2020-06-15 12:40:46 +00:00
It provides additional motivation to keep going.
2019-12-05 22:18:27 +00:00
2021-12-13 02:45:52 +00:00
## Getting Support ##
2021-12-13 03:00:22 +00:00
Please read the [Troubleshooting Guide ](https://docs.photoprism.app/getting-started/troubleshooting/ )
2021-12-13 02:45:52 +00:00
before reporting problems. If this doesn't help, or you have other questions:
- you are welcome to ask in our [Community Chat ](https://gitter.im/browseyourlife/community )
- and post your question in [GitHub Discussions ](https://github.com/photoprism/photoprism/discussions )
In addition, [sponsors ](https://github.com/photoprism/photoprism/blob/develop/SPONSORS.md ) receive direct
[technical support ](https://photoprism.app/contact ) via email.
We'll do our best to answer all your questions. In return, we ask you to back us on [Patreon ](https://www.patreon.com/photoprism )
or [GitHub Sponsors ](https://github.com/sponsors/photoprism ).
Think of "free software" as in "free speech," not as in "free beer". Thank you! 💜
*When reporting a problem, always include the version you are using and information
about your environment such as browser, operating system, installed memory, and
processor type.*
2021-10-09 06:05:52 +00:00
2021-10-07 13:20:58 +00:00
## Roadmap ##
2021-10-18 15:55:13 +00:00
Our vision is to provide the most user- and privacy-friendly solution to keep your pictures organized and accessible.
2021-10-07 13:20:58 +00:00
The [roadmap ](https://github.com/photoprism/photoprism/projects/5 ) shows what tasks are in progress,
2021-10-14 15:27:54 +00:00
what needs testing, and which features are going to be implemented next.
2021-10-07 13:20:58 +00:00
Please give ideas you like a thumbs-up 👍 , so that we know what is most popular.
2021-10-21 10:24:51 +00:00
2021-12-16 17:47:15 +00:00
Ideas endorsed by [silver, gold, and platinum sponsors ](SPONSORS.md ) receive a [golden label ](https://github.com/photoprism/photoprism/issues?q=is%3Aissue+is%3Aopen+label%3Asponsor )
and will be prioritized on the [roadmap ](https://github.com/photoprism/photoprism/projects/5 ).
2021-11-02 13:45:37 +00:00
2021-12-18 16:55:27 +00:00
We have a zero bug policy and do our best to help users when they need support or have other questions.
This comes at a price, as we can't give exact deadlines for new features.
Having said that, funding really has the highest impact. So users can do their part and
[become a sponsor ](https://docs.photoprism.app/funding/ ) to get their favorite features as soon as possible.
2021-10-21 10:24:51 +00:00
## Questions?
Follow us on [Twitter ](https://twitter.com/photoprism_app ) or join our [Community Chat ](https://gitter.im/browseyourlife/community )
2021-10-21 11:31:41 +00:00
to get regular updates, connect with other users, and discuss your ideas. Don't be afraid to ask silly questions.
2021-10-21 10:24:51 +00:00
2021-10-07 13:20:58 +00:00
## Contributions ##
2021-10-21 10:24:51 +00:00
We welcome contributions of any kind, including bug reports, testing, writing documentation,
2021-11-27 17:53:21 +00:00
tutorials, blog posts, and pull requests.
2021-12-12 19:14:07 +00:00
The [Developer Guide ](https://docs.photoprism.app/developer-guide/ ) contains all information
2021-11-27 17:53:21 +00:00
necessary to get you started.
Issues labeled [help wanted ](https://github.com/photoprism/photoprism/labels/help%20wanted ) /
[easy ](https://github.com/photoprism/photoprism/labels/easy ) can be good (first) contributions.
Because we want to create the best possible product for our users,
2021-12-12 19:14:07 +00:00
we have a set of [guidelines ](https://docs.photoprism.app/developer-guide/pull-requests )
2021-11-27 17:53:21 +00:00
to ensure that all source code submissions are acceptable.
They include step-by-step instructions for submitting new features,
bug fixes, and documentation improvements.
**Reviewing, testing and finally merging pull requests requires significant resources
on our side. If it's not just a small fix, it can take several months.**
2021-10-07 13:20:58 +00:00
2021-12-20 15:45:53 +00:00
## Trademark Guidelines ##
2020-01-09 04:26:19 +00:00
2021-12-20 19:50:02 +00:00
PhotoPrism® is a registered trademark. It is important to us that any permitted use is fair and meets
the highest standards. Visit [photoprism.app/trademark ](https://photoprism.app/trademark ) to learn more.
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
2021-12-12 19:14:07 +00:00
[docs]: https://docs.photoprism.app/
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-10-23 18:34:01 +00:00
[ask]: https://github.com/photoprism/photoprism/discussions
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
