Photo management and sharing on a user's server. Lychee is a free, open-source, self-hosted photo management system designed for users who want to manage and share their photo libraries with a native application-like experience. It offers quick installation and essential features for secure photo storage, targeting individuals and small teams seeking control over their digital assets.

How It Works

The system operates as a server-based application, with Docker providing a streamlined deployment path. It employs a separate worker container for background processing, ensuring smooth operation. The architecture prioritizes ease of use and seamless photo management, with an optional Supporter Edition available for enhanced functionality.

Quick Start & Requirements

• Primary Install: Docker (recommended) or Docker minimal template.
• Prerequisites: PHP 8.4+, Composer, and npm are required for source installations. Docker requires Docker and Docker Compose. A MySQL database (MariaDB via Docker) is configured by default.
• Links:
  • Docker Minimal Quick Start: https://raw.githubusercontent.com/LycheeOrg/Lychee/master/docker-compose.minimal.yaml
  • Documentation: Available for detailed installation, configuration, and updates.
  • GitHub Releases: For pre-built binaries.

Highlighted Details

• Supporter Edition (SE): Offers advanced features beyond the core open-source offering.
• AI-Assisted Contributions: The project permits AI-assisted contributions, with specific guidelines provided.
• Rapid Deployment: Docker installation is highlighted as quick and easy.

Maintenance & Community

• Community Support: Available via Discord or Gitter.
• Contributions: A Contribution Guide is provided, alongside specific AI/Claude Guidelines and an AGENTS.md specification for AI-driven development.
• Sponsorship: Supported by Jetbrains through their Open Source Development program.

Licensing & Compatibility

• License: The open-source license is not explicitly stated in the provided README.
• Compatibility: No specific notes on commercial use or closed-source linking are present, making licensing status unclear for such scenarios.

Limitations & Caveats

• Upgrade Complexity: Version 7.0 introduced significant changes, necessitating careful adherence to an upgrade guide.
• Unclear Licensing: The absence of a defined open-source license is a critical adoption blocker.
• Feature Gating: Advanced features are exclusively available in the paid Supporter Edition.