gallery/README.adoc
Přemysl Eric Janouch 9e22bd0e20
All checks were successful
Alpine 3.19 Success
Debian Bookworm Success
gallery: improve the README
2024-01-27 18:30:57 +01:00

1.2 KiB
Raw Blame History

gallery

This is gallery software designed to maintain a shadow structure of your filesystem, in which you can attach metadata to your media, and query your collections in various ways.

All media is content-addressed by its SHA-1 hash value, and at your option also perceptually hashed. Duplicate search is an essential feature.

The gallery is designed for simplicity, and easy interoperability. sqlite3, curl, jq, and the filesystem will take you a long way.

Prerequisites: Go, ImageMagick, xdg-utils

ImageMagick v7 is preferred, it doesnt shoot out of memory as often.

Getting it to work

# apt install build-essential git golang imagemagick xdg-utils
$ git clone https://git.janouch.name/p/gallery.git
$ cd gallery
$ make
$ ./gallery init G
$ ./gallery sync G ~/Pictures
$ ./gallery thumbnail G             # parallelized, with memory limits
$ ./gallery -threads 1 thumbnail G  # one thread only gets more memory
$ ./gallery dhash G
$ ./gallery web G :8080

The intended mode of use is running daily automated sync/thumbnail/dhash/tag batches in a cron job, or from a systemd timer.

The web command needs to see the public directory, and is friendly to reverse proxying.