From efaa9ba20a063595083d4fd560279e26ef2515db Mon Sep 17 00:00:00 2001 From: Alan Grainger Date: Wed, 30 Oct 2024 11:20:51 +0100 Subject: [PATCH] Update docs --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 640b6d5..d2a92d4 100644 --- a/README.md +++ b/README.md @@ -52,3 +52,29 @@ docker-compose up -d Now whenever you share an image or gallery through Immich, it will automatically create the correct public path for you. + +## Configuration + +The gallery is created using [LightGallery](https://github.com/sachinchoolur/lightGallery). You can change various settings to change how your gallery displays by +updating the `lightGallery` section in `/views/gallery.ejs`: + +```javascript +lightGallery(document.getElementById('lightgallery'), { + plugins: [lgZoom, lgThumbnail, lgVideo, lgFullscreen], + speed: 500 +}) +``` + +For example to disable the download button for images, you would add `download: false`: + +```javascript +lightGallery(document.getElementById('lightgallery'), { + plugins: [lgZoom, lgThumbnail, lgVideo, lgFullscreen], + download: false, + speed: 500 +}) +``` + +You can find all of LightGallery's settings here: + +https://www.lightgalleryjs.com/docs/settings/