photoprism/README.md
2018-09-14 12:44:15 +02:00

3.1 KiB

PhotoPrism

Powered By MIT License Code Quality GitHub issues Build Status

PhotoPrism is a server-based application for automatically tagging, searching and organizing large amounts of JPEG and RAW files. It is functionally similar to popular cloud services such as Flickr or Google Photos. Originals are stored in the file system in a structured way for easy backup and reliable long-term accessibility.

Note: This software is still alpha and under active development. You're welcome to ask if you have any questions or would like to support the project.

Our goal is to provide the following features (tested as a proof-of-concept):

  • High-performance command line tool
  • Web frontend
  • No proprietary or binary data formats
  • Automatic RAW to JPEG conversion
  • Duplicate detection (JPEG and RAW can be used simultaneously)
  • Automated tagging using Google TensorFlow
  • Reverse geocoding based on latitude and longitude
  • Image search with powerful filters
  • Easy backup and export

Web Frontend

Open a terminal an type photoprism start to start the built-in server. It will listen on port 80 by default. The UI is based on Vuetify, a Material Design component framework for Vue.js 2.

Setup

Before you start, make sure you got Git and Docker installed on your system. Instead of using Docker, you can also setup your own runtime environment based on the existing Docker configuration (not recommended).

Step 1: Run Git to clone this project:

git clone git@github.com:photoprism/photoprism.git

Step 2: Start Docker containers:

cd photoprism
docker-compose up

Note: This docker-compose configuration is for testing and development purposes only.

Step 3: Open a terminal to run tests and commands:

docker-compose exec photoprism bash
make
make test
make install
go run cmd/photoprism/photoprism.go start

See Quick and easy guide for migrating to Go 1.11 modules for an introduction to Go Modules and Makefiles.

Concept