photoprism/README.md

130 lines
7.7 KiB
Markdown
Raw Normal View History

PhotoPrism: Browse Your Life in Pictures
2018-10-05 06:27:45 +00:00
========================================
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]
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
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-11-26 19:45:48 +00:00
Say goodbye to solutions that force you to upload your visual memories to the 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)
2020-11-27 17:14:56 +00:00
## Key Features ##
2018-09-27 13:46:20 +00:00
2020-11-27 17:23:46 +00:00
* Our clearly structured [user interface](https://photoprism.pro/features) makes organizing and sharing your personal photo collection as easy as
2020-11-27 17:14:56 +00:00
it should be — whether its 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/).
2020-11-27 17:23:46 +00:00
* Automatic [image classification](https://docs.photoprism.org/developer-guide/metadata/classification/)
based on Google TensorFlow. In addition, our indexer detects _colors_, _chroma_, _luminance_, _projection_,
_location type_, _quality_, and many other properties.
* Includes four high-resolution [world maps](https://demo.photoprism.org/places) to see where you've been and for rediscovering
2020-11-27 17:14:56 +00:00
long-forgotten shots.
2020-11-27 17:43:33 +00:00
* WebDAV clients, like Microsofts Windows Explorer or Apple's Finder, may
[connect](https://docs.photoprism.org/user-guide/backup/webdav/) directly to PhotoPrism so that you to can open,
edit, and delete files from your computer or phone as if they were local.
2020-11-27 17:14:56 +00:00
You may easily sync your pictures with [Nextcloud](https://nextcloud.com/) as well.
2020-11-27 17:23:46 +00:00
* PhotoPrism feels [like a native app](https://en.wikipedia.org/wiki/Progressive_web_application) and,
of course, you can also add it to your home screen.
2020-11-27 17:14:56 +00:00
## Try PhotoPrism ##
You're welcome to play with our public demo at [demo.photoprism.org](https://demo.photoprism.org).
2018-12-16 15:32:24 +00:00
2020-11-26 19:45:48 +00:00
## Getting Started ##
2020-11-27 17:23:46 +00:00
Step-by-step installation instructions for our self-hosted [community edition](https://photoprism.pro/get) 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.
2020-11-27 17:14:56 +00:00
We do our best to provide a complete, stable version very soon. Check the
[roadmap](https://github.com/photoprism/photoprism/projects/5) for open issues.
2020-11-22 16:51:22 +00:00
Leave your email to get a [release notification](https://goo.gl/forms/KBPVGl9PCsOKrAv33).
2020-11-26 19:45:48 +00:00
## Feature Requests ##
Our [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.
Ideas backed by one or more [sponsors](SPONSORS.md) will be prioritized as well.
## 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
[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.
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
## 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
2020-11-27 09:08:12 +00:00
per dollar than investor-backed startups 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...
2020-11-27 09:08:12 +00:00
- provide additional benefits to our sponsors
- sell a tested & supported version in the app store while our contributors and other developers can
continue to use Docker or build from source
- 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 most 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.
In addition, you can find us on [Patreon](https://www.patreon.com/photoprism)
and [PayPal](https://www.paypal.me/browseyourlife).
Donations enable us to pay for infrastructure, develop new features, and keep them free for everyone.
2018-10-05 17:21:31 +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.
Ideas backed by one or more eligible [sponsors](https://docs.photoprism.org/funding/) 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
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
2018-11-19 03:24:43 +00:00
[license]: https://github.com/photoprism/photoprism/blob/develop/LICENSE
[patreon]: https://www.patreon.com/photoprism
2020-11-15 04:08:55 +00:00
[paypal]: https://www.paypal.me/browseyourlife
[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
2019-07-04 16:41:17 +00:00
[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