README
¶
PhotoPrism: Browse Your Life in Pictures
PhotoPrism® is an AI-Powered Photos App for the Decentralized Web. It makes use of the latest technologies to tag and find pictures automatically without getting in your way. You can run it at home, on a private server, or in the cloud.
To get a first impression, you are welcome to play with our public demo. Please be careful not to upload any private, unlawful or offensive pictures.
Feature Overview
Our mission is to provide the most user- and privacy-friendly solution to keep your pictures organized and accessible. That's why PhotoPrism was built from the ground up to run wherever you need it, without compromising freedom, privacy, or functionality:
- Browse all your photos and videos without worrying about RAW conversion, duplicates or video formats
- Easily find specific pictures using powerful search filters
- Recognizes the faces of your family and friends
- Automatic classification of pictures based on their content and location
- Play Live Photos by hovering over them in albums and search results
- Since the User Interface is a Progressive Web App, 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
- Includes four high-resolution World Maps to bring back the memories of your favorite trips
- Metadata is extracted and merged from Exif, XMP, and other sources such as Google Photos
- Many more image properties like Colors, Chroma, and Quality can be searched as well
- Use PhotoSync to securely backup iOS and Android phones in the background
- WebDAV clients such as Microsoft's Windows Explorer and Apple's Finder can connect directly to PhotoPrism, allowing you to open, edit, and delete files from your computer as if they were local
Being completely self-funded and independent, we can promise you that we will never sell your data and that we will always be transparent about our software and services. Your data will never be shared with Google, Amazon, Microsoft or Apple unless you intentionally upload files to one of their services. 🔒
Getting Started
Step-by-step installation instructions for our self-hosted community edition can be found on docs.photoprism.app - all you need is a Web browser and Docker to run the server. It is available for Mac, Linux, and Windows.
The stable releases and development preview are available as a multi-arch image for 64-bit AMD, Intel, and ARM processors. That means, Raspberry Pi and Apple Silicon users enjoy the exact same functionality and can follow the same installation steps.
See our Getting Started FAQ for alternative installation methods, for example using the tar.gz packages we provide.
Support Our Mission 💎
PhotoPrism is 100% self-funded and independent. Your continued support helps us provide more features to the public, release regular updates, and remain independent!
Our members enjoy additional features, including access to interactive world maps, and can join our private chat room to connect with our team. We currently have the following membership options:
- You can sign up directly on our website and pay with credit card or SEPA through Stripe, so you don't need to link an external account and can easily upgrade or downgrade at any time
- Alternatively, Patreon also supports PayPal, additional currencies, and lets you choose between monthly and annual billing for all tiers
If you currently support us through GitHub Sponsors, you can also register on our website and use the Activate GitHub Sponsors Membership button to link your account. For details on this and how to link your Patreon account, see our Activation Guide.
You are welcome to contact us for change requests, membership questions, and business partnerships.
View Membership FAQ › Sign Up ›
Why Your Support Matters
- Your continued support helps us provide regular updates and remain independent, so we can fulfill our mission and protect your privacy
- Sustained funding is key to quickly releasing new features requested by you and other community members
- Being self-funded and independent, we can personally promise you that we will never sell your data and that we will always be transparent about our software and services
Please also leave a star on GitHub if you like this project. It provides additional motivation to keep going.
A big thank you to all current and past sponsors, whose generous support has been and continues to be essential to the success of the project!
View Sponsors › View Credits ›
Getting Support
Visit docs.photoprism.app/user-guide to learn how to sync, organize, and share your pictures. If you need help installing our software at home, you are welcome to post your question in GitHub Discussions or ask in our Community Chat. Common problems can be quickly diagnosed and solved using our Troubleshooting Checklists. Eligible members are also welcome to email us for technical support and advice.
Upcoming Features and Enhancements
Our Project Roadmap shows what tasks are in progress and what features will be implemented next. You are invited to give ideas you like a thumbs-up, so we know what's most popular.
Be aware that 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 though, as we can't give exact release dates for new features. Our team receives many more requests than can be implemented, so we want to emphasize that we are in no way obligated to implement the features, enhancements, or other changes you request. We do, however, appreciate your feedback and carefully consider all requests.
Because sustained funding is key to quickly releasing new features, we encourage you to support our mission by signing up as a sponsor or purchasing a commercial license. Ultimately, that's what's best for the product and the community.
GitHub Issues ⚠️
We kindly ask you not to report bugs via GitHub Issues unless you are certain to have found a fully reproducible and previously unreported issue that must be fixed directly in the app. Thank you for your careful consideration!
- When reporting a problem, always include the software versions you are using and other information about your environment such as browser, browser plugins, operating system, storage type, memory size, and processor
- Note that all issue subscribers receive an email notification from GitHub whenever a new comment is added, so these should only be used for sharing important information and not for discussions, questions or expressing personal opinions
- Contact us or a community member if you need help, it could be a local configuration problem, or a misunderstanding in how the software works
- This gives our team the opportunity to improve the docs and provide best-in-class support to you, instead of handling unclear/duplicate bug reports or triggering a flood of notifications by responding to comments
Connect with the Community
Follow us on Twitter and join the Community Chat to get regular updates, connect with other users, and discuss your ideas. Our Code of Conduct explains the "dos and don’ts" when interacting with other community members.
Feel free to contact us at hello@photoprism.app with anything that is on your mind. We appreciate your feedback! Due to the high volume of emails we receive, our team may be unable to get back to you immediately. We do our best to respond within five business days or less.
Every Contribution Makes a Difference
We welcome contributions of any kind, including blog posts, tutorials, translations, testing, writing documentation, and pull requests. Our Developer Guide contains all the information necessary for you to get started.
PhotoPrism® is a registered trademark. By using the software and services we provide, you agree to our Terms of Service, Privacy Policy, and Code of Conduct. Docs are available under the CC BY-NC-SA 4.0 License; additional terms may apply.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
internal
|
|
|
acl
Package acl provides access control lists for authorization checks.
|
Package acl provides access control lists for authorization checks. |
|
api
Package api provides REST-API authentication and request handlers.
|
Package api provides REST-API authentication and request handlers. |
|
auto
Package auto provides workers for background indexing and import operations.
|
Package auto provides workers for background indexing and import operations. |
|
classify
Package classify encapsulates image classification using TensorFlow.
|
Package classify encapsulates image classification using TensorFlow. |
|
commands
Package commands provides the CLI commands of PhotoPrism.
|
Package commands provides the CLI commands of PhotoPrism. |
|
config
Package config provides global options, command-line flags, and user settings.
|
Package config provides global options, command-line flags, and user settings. |
|
crop
Package crop provides image crop data structures and helpers.
|
Package crop provides image crop data structures and helpers. |
|
customize
Package customize provides user settings to customize the app.
|
Package customize provides user settings to customize the app. |
|
entity
Package entity provides entity models based on the GORM library.
|
Package entity provides entity models based on the GORM library. |
|
entity/legacy
Package legacy provides legacy entity models to be used in migrations.
|
Package legacy provides legacy entity models to be used in migrations. |
|
event
Package event provides a publish-subscribe event hub and a global logger.
|
Package event provides a publish-subscribe event hub and a global logger. |
|
face
Package face provides face recognition.
|
Package face provides face recognition. |
|
ffmpeg
Package ffmpeg provides FFmpeg video transcoding related types and functions.
|
Package ffmpeg provides FFmpeg video transcoding related types and functions. |
|
form
Package form contains tagged structs for input value validation.
|
Package form contains tagged structs for input value validation. |
|
frame
Package frame provides helper functions to embed images into frames.
|
Package frame provides helper functions to embed images into frames. |
|
get
Package get provides a registry for common services.
|
Package get provides a registry for common services. |
|
hub
Package hub provides privacy-preserving reverse geocoding and other backend services.
|
Package hub provides privacy-preserving reverse geocoding and other backend services. |
|
hub/places
Package places provides global location information to enrich metadata with location details.
|
Package places provides global location information to enrich metadata with location details. |
|
maps
Package maps provides a location lookup abstraction including a normalized list of countries.
|
Package maps provides a location lookup abstraction including a normalized list of countries. |
|
meta
Package meta provides XMP and Exif metadata parsing and normalization.
|
Package meta provides XMP and Exif metadata parsing and normalization. |
|
migrate
Package migrate provides database schema migrations.
|
Package migrate provides database schema migrations. |
|
mutex
Package mutex provides concurrency control for index workers and database operations.
|
Package mutex provides concurrency control for index workers and database operations. |
|
nsfw
Package nsfw provides detection of images that are "not safe for work" based on various categories.
|
Package nsfw provides detection of images that are "not safe for work" based on various categories. |
|
photoprism
Package photoprism provides the core functionality of PhotoPrism®.
|
Package photoprism provides the core functionality of PhotoPrism®. |
|
pwa
Package pwa provides data structures and tools for working with progressive web applications.
|
Package pwa provides data structures and tools for working with progressive web applications. |
|
query
Package query provides frequently used database queries for use in commands and API.
|
Package query provides frequently used database queries for use in commands and API. |
|
remote
Package remote provides detection of remote services for file sharing and synchronization.
|
Package remote provides detection of remote services for file sharing and synchronization. |
|
remote/webdav
Package webdav provides WebDAV file sharing and synchronization.
|
Package webdav provides WebDAV file sharing and synchronization. |
|
search
Package search provides search queries to find photos, albums, labels, and subjects.
|
Package search provides search queries to find photos, albums, labels, and subjects. |
|
server
Package server provides REST and Web server routing, request handling and logging.
|
Package server provides REST and Web server routing, request handling and logging. |
|
server/limiter
Package limiter provides an IP request rate limiter with Gin middleware.
|
Package limiter provides an IP request rate limiter with Gin middleware. |
|
server/wellknown
Package wellknown provides data types and abstractions for service discovery endpoints.
|
Package wellknown provides data types and abstractions for service discovery endpoints. |
|
session
Package session provides session storage and management.
|
Package session provides session storage and management. |
|
thumb
Package thumb provides JPEG resampling and thumbnail generation.
|
Package thumb provides JPEG resampling and thumbnail generation. |
|
ttl
Package ttl provides cache expiration defaults and helper functions.
|
Package ttl provides cache expiration defaults and helper functions. |
|
viewer
Package viewer provides photo viewer data structures and utility functions.
|
Package viewer provides photo viewer data structures and utility functions. |
|
workers
Package workers provides index, sync, and metadata optimization background workers.
|
Package workers provides index, sync, and metadata optimization background workers. |
|
pkg
|
|
|
authn
Package authn helps integrate and abstract authentication providers.
|
Package authn helps integrate and abstract authentication providers. |
|
capture
Package capture provides profiling functions for testing and debugging.
|
Package capture provides profiling functions for testing and debugging. |
|
checksum
Package checksum provides functions and abstractions to generate data checksums.
|
Package checksum provides functions and abstractions to generate data checksums. |
|
clean
Package clean provides validation, sanitation, and normalization of input values.
|
Package clean provides validation, sanitation, and normalization of input values. |
|
clusters
Package clusters provides abstract definitions of clusterers as well as their implementations.
|
Package clusters provides abstract definitions of clusterers as well as their implementations. |
|
colors
Package colors provides types and functions for color classification.
|
Package colors provides types and functions for color classification. |
|
dummy
Package dummy provides dummy implementations for common interfaces.
|
Package dummy provides dummy implementations for common interfaces. |
|
env
Package env provides runtime environment information.
|
Package env provides runtime environment information. |
|
fastwalk
Package fastwalk provides a faster version of filepath.Walk for file system scanning tools.
|
Package fastwalk provides a faster version of filepath.Walk for file system scanning tools. |
|
fs
Package fs provides filesystem related constants and functions.
|
Package fs provides filesystem related constants and functions. |
|
geo
Package geo provides earth geometry functions and constants.
|
Package geo provides earth geometry functions and constants. |
|
header
Package header provides abstractions and naming constants for HTTP request and response headers.
|
Package header provides abstractions and naming constants for HTTP request and response headers. |
|
i18n
Package i18n provides translatable notification and error messages.
|
Package i18n provides translatable notification and error messages. |
|
level
Package level provides constants and abstractions for log levels and severities.
|
Package level provides constants and abstractions for log levels and severities. |
|
list
Package list provides a string slice abstraction.
|
Package list provides a string slice abstraction. |
|
media
Package media provides general content types and maps them to file formats.
|
Package media provides general content types and maps them to file formats. |
|
pluscode
Package pluscode provides an abstraction for Google's Open Location Code package.
|
Package pluscode provides an abstraction for Google's Open Location Code package. |
|
projection
Package projection provides visual projection types and methods.
|
Package projection provides visual projection types and methods. |
|
react
Package react facilitates the processing of user feedback expressed by an emoji.
|
Package react facilitates the processing of user feedback expressed by an emoji. |
|
report
Package report provides rendering of report results, for example as Markdown.
|
Package report provides rendering of report results, for example as Markdown. |
|
rnd
Package rnd provides random token generation and validation.
|
Package rnd provides random token generation and validation. |
|
s2
Package s2 provides a geolocation abstraction based on Google's S2 library.
|
Package s2 provides a geolocation abstraction based on Google's S2 library. |
|
sortby
Package sortby provides sort order constants and helper functions.
|
Package sortby provides sort order constants and helper functions. |
|
txt
Package txt provides text and linguistics related functionality.
|
Package txt provides text and linguistics related functionality. |
|
unix
Package unix provides constants and functions for Unix timestamps.
|
Package unix provides constants and functions for Unix timestamps. |
|
video
Package video provides video file related types and abstractions.
|
Package video provides video file related types and abstractions. |