https://thumbsup.github.io
\n![\"Banner\"](\"docs/banner.jpg\")
\n\n---\n\nTurn any folder with photos & videos into a web gallery.\n\n- thumbnails & multiple resolutions for fast previews\n- mobile friendly website with customisable themes\n- only rebuilds changed files: it's fast!\n- uses relative paths so you can deploy the pages anywhere\n- works great with Amazon S3 for static hosting\n\n## Quick start\n\nSimply point `thumbsup` to a folder with photos & videos. All nested folders become separate albums.\n\n```bash\nnpm install -g thumbsup\nthumbsup --input ./photos --output ./gallery\n```\n\n\n\nThere are many command line arguments to customise the output.\nSee the website for the full documentation: https://thumbsup.github.io.\n\n## Sample gallery\n\nSee a sample gallery online at https://thumbsup.github.io/demos/themes/mosaic/\n\n\n\n## Requirements\n\nThumbsup requires the following dependencies:\n- [Node.js](http://nodejs.org/): `brew install node`\n- [exiftool](http://www.sno.phy.queensu.ca/~phil/exiftool/): `brew install exiftool`\n- [GraphicsMagick](http://www.graphicsmagick.org/): `brew install graphicsmagick`\n\nAnd optionally:\n- [FFmpeg](http://www.ffmpeg.org/) to process videos: `brew install ffmpeg`\n- [Gifsicle](http://www.lcdf.org/gifsicle/) to process animated GIFs: `brew install gifsicle`\n- [dcraw](https://www.cybercom.net/~dcoffin/dcraw/) to process RAW photos: `brew install dcraw`\n- [ImageMagick](https://imagemagick.org/) for HEIC support (needs to be compiled with `--with-heic`)\n\nYou can run thumbsup as a Docker container ([thumbsupgallery/thumbsup](https://hub.docker.com/r/thumbsupgallery/thumbsup/)) which pre-packages all the dependencies above. Read the [thumbsup on Docker](https://thumbsup.github.io/docs/2-installation/docker/) documentation for more detail.\n\n```bash\ndocker run -v `pwd`:/work thumbsupgallery/thumbsup [...]\n```\n\n## Command line arguments\n\nThis reflects the CLI for the latest code on `master`.\nFor the latest published version please refer to the [docs on the website](https://thumbsup.github.io).\n\n\n```\n\n\nUsages:\n thumbsup [required] [options]\n thumbsup --config config.json\n\n\nRequired:\n --input Path to the folder with all photos/videos [string] [required]\n --output Output path for the static website [string] [required]\n\nInput options:\n --scan-mode How files are indexed [choices: \"full\", \"partial\", \"incremental\"] [default: \"full\"]\n --include-photos Include photos in the gallery [boolean] [default: true]\n --include-videos Include videos in the gallery [boolean] [default: true]\n --include-raw-photos Include raw photos in the gallery [boolean] [default: false]\n --include Glob pattern of files to include [array]\n --exclude Glob pattern of files to exclude [array]\n\nOutput options:\n --thumb-size Pixel size of the square thumbnails [number] [default: 120]\n --small-size Pixel height of the small photos [number] [default: 300]\n --large-size Pixel height of the fullscreen photos [number] [default: 1000]\n --photo-quality Quality of the resized/converted photos [number] [default: 90]\n --video-quality Quality of the converted video (percent) [number] [default: 75]\n --video-bitrate Bitrate of the converted videos (e.g. 120k) [string] [default: null]\n --video-format Video output format [choices: \"mp4\", \"webm\"] [default: \"mp4\"]\n --video-hwaccel Use hardware acceleration (requires bitrate) [choices: \"none\", \"vaapi\"] [default: \"none\"]\n --video-stills Where the video still frame is taken [choices: \"seek\", \"middle\"] [default: \"seek\"]\n --video-stills-seek Number of seconds where the still frame is taken [number] [default: 1]\n --photo-preview How lightbox photos are generated [choices: \"resize\", \"copy\", \"symlink\", \"link\"] [default: \"resize\"]\n --video-preview How lightbox videos are generated [choices: \"resize\", \"copy\", \"symlink\", \"link\"] [default: \"resize\"]\n --photo-download How downloadable photos are generated [choices: \"resize\", \"copy\", \"symlink\", \"link\"] [default: \"resize\"]\n --video-download How downloadable videos are generated [choices: \"resize\", \"copy\", \"symlink\", \"link\"] [default: \"resize\"]\n --link-prefix Path or URL prefix for \"linked\" photos and videos [string]\n --cleanup Remove any output file that's no longer needed [boolean] [default: false]\n --concurrency Number of parallel parsing/processing operations [number] [default: 2]\n --output-structure File and folder structure for output media [choices: \"folders\", \"suffix\"] [default: \"folders\"]\n --gm-args Custom image processing arguments for GraphicsMagick [array]\n --watermark Path to a transparent PNG to be overlaid on all images [string]\n --watermark-position Position of the watermark [choices: \"Repeat\", \"Center\", \"NorthWest\", \"North\", \"NorthEast\", \"West\", \"East\", \"SouthWest\", \"South\", \"SouthEast\"]\n\nAlbum options:\n --albums-from How files are grouped into albums [array] [default: [\"%path\"]]\n --sort-albums-by How to sort albums [choices: \"title\", \"start-date\", \"end-date\"] [default: \"start-date\"]\n --sort-albums-direction Album sorting direction [choices: \"asc\", \"desc\"] [default: \"asc\"]\n --sort-media-by How to sort photos and videos [choices: \"filename\", \"date\"] [default: \"date\"]\n --sort-media-direction Media sorting direction [choices: \"asc\", \"desc\"] [default: \"asc\"]\n --home-album-name Name of the top-level album [string] [default: \"Home\"]\n --album-page-size Max number of files displayed on a page [number] [default: null]\n --album-zip-files Create a ZIP file per album [boolean] [default: false]\n --include-keywords Keywords to include in %keywords [array]\n --exclude-keywords Keywords to exclude from %keywords [array]\n --include-people Names to include in %people [array]\n --exclude-people Names to exclude from %people [array]\n --album-previews How previews are selected [choices: \"first\", \"spread\", \"random\"] [default: \"first\"]\n\nWebsite options:\n --index Filename of the home page [string] [default: \"index.html\"]\n --albums-output-folder Output subfolder for HTML albums (default: website root) [string] [default: \".\"]\n --theme Name of a built-in gallery theme [choices: \"classic\", \"cards\", \"mosaic\", \"flow\"] [default: \"classic\"]\n --theme-path Path to a custom theme [string]\n --theme-style Path to a custom LESS/CSS file for additional styles [string]\n --theme-settings Path to a JSON file with theme settings [string]\n --title Website title [string] [default: \"Photo album\"]\n --footer Text or HTML footer [string] [default: null]\n --google-analytics Code for Google Analytics tracking [string]\n --embed-exif Embed the exif metadata for each image into the gallery page [boolean] [default: false]\n --locale Locale for regional settings like dates [string] [default: \"en\"]\n --seo-location Location where the site will be hosted. If provided, sitemap.xml and robots.txt will be created. [string] [default: null]\n\nMisc options:\n --config JSON config file (one key per argument) [string]\n --database-file Path to the database file [string]\n --log-file Path to the log file [string]\n --log Print a detailed text log [choices: \"default\", \"info\", \"debug\", \"trace\"] [default: \"default\"]\n --dry-run Update the index, but don't create the media files / website [boolean] [default: false]\n\nDeprecated:\n --original-photos Copy and allow download of full-size photos [boolean]\n --original-videos Copy and allow download of full-size videos [boolean]\n --albums-date-format How albums are named in