photoprism/README.md

105 lines
6.8 KiB
Markdown
Raw Normal View History

2021-10-11 21:32:13 +00:00
PhotoPrism: Browse Your Life in Pictures
========================================
2018-08-23 12:44:21 +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]
[![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]
[![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-10-11 21:32:13 +00:00
PhotoPrism® is a privately hosted app for browsing, organizing, and sharing your photo collection.
It makes use of the latest technologies 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)
To get a first impression, you're welcome to play with our public demo at [demo.photoprism.org](https://demo.photoprism.org/).
2021-10-11 16:13:23 +00:00
## Features ##
2018-09-27 13:46:20 +00:00
2021-10-12 18:08:41 +00:00
* Browse all your photos and videos without worrying about duplicates, RAW images or video formats
2021-10-13 06:27:26 +00:00
* Powerful [search filters](https://demo.photoprism.org/browse?q=mono%3Atrue%20quality%3A3%20photo%3Atrue) make it easy to find the right pictures
2021-10-12 10:58:55 +00:00
* Since the [user interface](https://demo.photoprism.org/) is a [Progressive Web App](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps),
it provides a native app-like experience, and you can easily install it on the home screen of all major operating systems and mobile devices
2021-10-12 11:35:24 +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
* Play Live Photos™ by hovering over them in [albums](https://demo.photoprism.org/albums) and [search results](https://demo.photoprism.org/browse?view=cards&q=type%3Alive)
* Enjoy privacy-preserving [face detection and recognition](https://demo.photoprism.org/people) 💎
* AI-powered [image classification](https://demo.photoprism.org/labels)
2021-10-11 16:13:23 +00:00
based on Google TensorFlow
2021-10-12 12:06:15 +00:00
* Metadata is extracted and merged from Exif, XMP, and proprietary formats such as Google Photos JSON
2021-10-13 06:27:26 +00:00
* Image properties like colors, chroma, luminance, quality, and location are automatically detected when you update the index or import files
2021-10-13 06:43:30 +00:00
* Use [PhotoSync](https://www.photosync-app.com/) to securely backup iOS and Android phones in the background
* WebDAV clients such as Microsoft's Windows Explorer and Apple's Finder can [connect](https://docs.photoprism.org/user-guide/sync/webdav/) directly 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 ##
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.
2021-10-11 19:31:26 +00:00
Our [latest release](https://docs.photoprism.org/release-notes/) not only includes
2021-10-01 03:12:36 +00:00
**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/).
2021-10-08 09:53:59 +00:00
## Funding ##
2021-10-08 12:54:24 +00:00
This open-source project is made possible [thanks to our sponsors](SPONSORS.md).
If you enjoy using PhotoPrism, please consider backing us on [Patreon](https://www.patreon.com/photoprism)
2021-10-08 13:26:24 +00:00
or [GitHub Sponsors](https://github.com/sponsors/photoprism).
2021-10-08 12:54:24 +00:00
2021-10-08 13:13:31 +00:00
Your continued support helps us fund operating costs, provide services like satellite maps,
2021-10-08 16:46:39 +00:00
and develop new features. Requests endorsed by silver and gold sponsors [receive a golden label](https://github.com/photoprism/photoprism/issues?q=is%3Aissue+is%3Aopen+label%3Asponsor) and will be prioritized.
Let us know when we mistakenly label an idea as [unfunded](https://github.com/photoprism/photoprism/issues?q=is%3Aissue+is%3Aopen+label%3Aunfunded).
2021-10-08 12:54:24 +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.
2021-10-09 06:05:52 +00:00
Thank you very much! 💜
2021-10-07 13:20:58 +00:00
## Roadmap ##
2021-10-12 06:05:08 +00:00
Our vision is to provide the most user-friendly solution for browsing, organizing, and sharing your photo collection.
2021-10-07 13:20:58 +00:00
The [roadmap](https://github.com/photoprism/photoprism/projects/5) shows what tasks are in progress,
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.
## 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.
## Trademarks ##
PhotoPrism® is a registered trademark of Michael Mayer. You may use it as required to describe
our software, run your 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
2018-11-19 03:24:43 +00:00
[license]: https://github.com/photoprism/photoprism/blob/develop/LICENSE
[patreon]: https://www.patreon.com/photoprism
[paypal]: https://www.paypal.me/photoprism
[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://drone.photoprism.app/photoprism/photoprism
[docs]: https://docs.photoprism.org/
2018-12-20 18:35:52 +00:00
[issuehunt]: https://issuehunt.io/repos/119160553
[chat]: https://gitter.im/browseyourlife/community
2021-05-15 08:52:16 +00:00
[twitter]: https://twitter.com/photoprism_app
[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