From 9e22bd0e20bc3a3ca7671ae7ab1865be5aee1f16 Mon Sep 17 00:00:00 2001 From: Přemysl Eric Janouch Date: Sat, 27 Jan 2024 18:28:21 +0100 Subject: gallery: improve the README --- README.adoc | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.adoc b/README.adoc index 05696af..8728238 100644 --- a/README.adoc +++ b/README.adoc @@ -8,12 +8,32 @@ 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 doesn't shoot out of memory as often. -The gallery is designed for simplicity, and easy interoperability. -sqlite3, curl, jq, and the filesystem will take you a long way. +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 system timer. See _test.sh_ for usage hints. +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. + +Demo +---- +https://holedigging.club/gallery/ -- cgit v1.2.3-70-g09d2