Getting Started
Step-by-step installation instructions for our self-hosted community edition can be found in Getting Started. All you need is a Web browser and Docker to run the server. It is available for Mac, Linux, and Windows.
Need help? Common issues can be quickly diagnosed and solved using the troubleshooting checklists we provide at docs.photoprism.app/getting-started/troubleshooting. You can also find helpful background information on Known Issues and learn what workarounds are available.
User Guide
Visit docs.photoprism.app/user-guide to learn how to sync, organize, and share your pictures. Our User Guide also covers many advanced topics, such as migrating from Google Photos and thumbnail quality settings.
A preliminary German version of the User Guide is published at docs-de.photoprism.app. We appreciate help with improving the translation and keeping it up to date.
Knowledge Base
Browse the Knowledge Base for detailed information on specific product features, services, and related resources:
- Compliance FAQ for professional users and organizations
- Getting Support and Reporting Bugs
- Metadata Compatibility
- Supported File Formats
- and more
Developer Guide
Our Developer Guide contains all the information you need to get started as a developer. It guides you from setting up your development environment and creating pull requests to running tests and adding translations. Multiple subsections provide details on specific features and links to external resources for further information.
Want to learn more about our development practices? Our approach relies heavily on agile methodologies with a high degree of automation and continuous integration. Many of the best practices we use and have proven to be effective are described in Quality and Best Practices.
GitHub Repository
The source code, including automated tests and a readme file that gives a short and concise overview of the project, can be found on GitHub at https://github.com/photoprism/photoprism.
API Documentation
GoDoc automatically generates an API reference for developers based on our public source code.
View REST API docs chevron_right
Database Schema
Information about the index database schema is provided as an entity-relationship diagram, Mermaid.js markup, and MariaDB-compatible SQL:
The entity models as part of our public source code also serve as a form of documentation that can be well used by many developers. Feel free to contact us with your specific requirements if you need additional technical documentation.
Terms & Privacy
Privacy Policy
What information we collect, how we use it, and under what circumstances we share it is explained in our Privacy Policy. Read our GDPR Compliance Statement to learn more about the rights you have as a resident of the European Economic Area ("EEA"), our ongoing commitment to user privacy, and the General Data Protection Regulation ("GDPR").
Terms of Service
Visit to learn how we work, what you can expect from us, and what we expect from you.
Trademark and Brand Guidelines
Our Trademark and Brand Guidelines, which may be updated from time to time, describe how our brand assets may be used. It is important to us that any permitted use of our brand assets is fair and meets the highest standards.
Community Standards
By using our infrastructure, including the forums and chats we provide, you agree to our Code of Conduct. It explains the "dos and don’ts" when interacting with other community members.