Skip to content

A self-hosted open source photo management service. This is the repository of the backend.

License

Notifications You must be signed in to change notification settings

LibrePhotos/librephotos

Repository files navigation

Discord Website Read the docs GitHub contributors License: MIT Translation status

LibrePhotos

Image Mockup designed by rawpixel.com / Freepik

A self-hosted, open-source photo management service with automatic face recognition, object detection, and semantic search β€” powered by modern machine learning.

Installation

Step-by-step installation instructions are available in our documentation.

System Requirements

Resource Minimum Recommended
RAM 4 GB 8 GB+
Storage 10 GB (plus your photo library) SSD recommended
CPU 2 cores 4+ cores
OS Any Docker-compatible OS Linux

Note: Machine learning features (face recognition, scene classification, image captioning) are memory-intensive. 8 GB+ RAM is strongly recommended for smooth operation.

Features

  • Support for all types of photos including raw photos
  • Support for videos
  • Timeline view
  • Scans pictures on the file system
  • Multiuser support
  • Generate albums based on events like "Thursday in Berlin"
  • Face recognition / Face classification
  • Reverse geocoding
  • Object / Scene detection
  • Semantic image search
  • Search by metadata

Tech Stack

Backend

Frontend

Machine Learning

Infrastructure

API Documentation

After starting LibrePhotos, interactive API docs are available at:

  • Swagger UI: http://localhost:3000/api/swagger
  • ReDoc: http://localhost:3000/api/redoc

How to help out

  • ⭐ Star this repository if you like this project!
  • πŸš€ Developing: Get started in less than 30 minutes by following this guide. Also see our CONTRIBUTING.md for detailed development setup, code quality standards, and PR guidelines.
  • πŸ—’οΈ Documentation: Improving the documentation is as simple as submitting a pull request here
  • πŸ§ͺ Testing: If you want to help find bugs, use the dev tag and update it regularly. If you find a bug, open an issue.
  • πŸ§‘β€πŸ€β€πŸ§‘ Outreach: Talk about this project with other people and help them to get started too!
  • 🌐 Translations: Make LibrePhotos accessible to more people with weblate.
  • πŸ’Έ Donate to the developers of LibrePhotos

Related Projects

Repository Description
librephotos-frontend React/TypeScript web frontend
librephotos-docker Docker Compose deployment configurations
librephotos.docs Documentation website source
librephotos-mobile Mobile application

License

This project is licensed under the MIT License.

About

A self-hosted open source photo management service. This is the repository of the backend.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors 65

Languages