# thumbsup [![NPM](http://img.shields.io/npm/v/thumbsup.svg?style=flat)](https://npmjs.org/package/thumbsup) [![License](http://img.shields.io/npm/l/thumbsup.svg?style=flat)](https://github.com/thumbsup/thumbsup) [![Travis CI](https://travis-ci.org/thumbsup/thumbsup.svg?branch=master)](https://travis-ci.org/thumbsup/thumbsup) [![Dependencies](http://img.shields.io/david/thumbsup/thumbsup.svg?style=flat)](https://david-dm.org/thumbsup/thumbsup) [![Dev dependencies](https://david-dm.org/thumbsup/thumbsup/dev-status.svg?style=flat)](https://david-dm.org/thumbsup/thumbsup?type=dev) [![Standard - JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](http://standardjs.com/) [![Twitter](https://img.shields.io/badge/share-Twitter-1CA8F5.svg)](https://twitter.com/intent/tweet?text=Need%20static%20photo%20and%20video%20galleries?%20Check%20out%20Thumbsup%20on%20Github&url=https://github.com/thumbsup/thumbsup&hashtags=selfhosted,static,gallery) [![LinkedIn](https://img.shields.io/badge/share-LinkedIn-0077BC.svg)](https://www.linkedin.com/shareArticle?mini=true&url=https://github.com/thumbsup/thumbsup&title=Static%20gallery%20generator&summary=Thumbsup%20is%20a%20command-line%20friendly%20static%20gallery%20generator%20for%20all%20your%20photos%20and%20videos&source=Github) [![Facebook](https://img.shields.io/badge/share-Facebook-3F4C9D.svg)](https://www.facebook.com/sharer.php?u=https://github.com/thumbsup/thumbsup) ![banner](docs/banner.jpg) Turn any folder with photos & videos into a web gallery. - thumbnails & multiple resolutions for fast previews - mobile friendly website with customisable themes - only rebuilds changed files: it's fast! - uses relative paths so you can deploy the pages anywhere - works great with Amazon S3 for static hosting ## Quick start Simply point `thumbsup` to a folder with photos & videos. All nested folders become separate albums. ```bash npm install -g thumbsup thumbsup --input ./photos --output ./gallery ``` ![Screen recording](docs/demo.gif) There are many command line arguments to customise the output. See the website for the full documentation: https://thumbsup.github.io. ## Requirements Thumbsup requires the following dependencies: - [Node.js](http://nodejs.org/): `brew install Node` - [exiftool](http://www.sno.phy.queensu.ca/~phil/exiftool/): `brew install exiftool` - [GraphicsMagick](http://www.graphicsmagick.org/): `brew install graphicsmagick` - [FFmpeg](http://www.ffmpeg.org/): `brew install ffmpeg` You can run thumbsup as a Docker container ([thumbsupgallery/thumbsup](https://hub.docker.com/r/thumbsupgallery/thumbsup/)) which pre-packages all the dependencies above. ## Sample gallery See a sample gallery online at https://thumbsup.github.io/demos/themes/mosaic/ ![sample gallery](docs/screenshot.png) ## Command line arguments This reflects the CLI for the latest code on `master`. For the latest published version please refer to the [docs on the website](https://thumbsup.github.io). ``` Usages: thumbsup [required] [options] thumbsup --config config.json Required: --input Path to the folder with all photos/videos [string] [required] --output Output path for the static website [string] [required] Output options: --thumb-size Pixel size of the square thumbnails [number] [default: 120] --large-size Pixel height of the fullscreen photos [number] [default: 1000] --photo-quality Quality of the resized/converted photos [number] [default: 90] --download-photos Target of the photo download links [choices: "large", "copy", "symlink", "link"] [default: "large"] --download-videos Target of the video download links [choices: "large", "copy", "symlink", "link"] [default: "large"] --download-link-prefix Path or URL prefix for linked downloads [string] --cleanup Remove any output file that's no longer needed [boolean] [default: false] --concurrency Number of parallel parsing/processing operations [number] [default: 4] --gm-args Custom image processing arguments for GraphicsMagick [array] Album options: --albums-from How files are grouped into albums [array] [default: ["%path"]] --sort-albums-by How to sort albums [choices: "title", "start-date", "end-date"] [default: "start-date"] --sort-albums-direction Album sorting direction [choices: "asc", "desc"] [default: "asc"] --sort-media-by How to sort photos and videos [choices: "filename", "date"] [default: "date"] --sort-media-direction Media sorting direction [choices: "asc", "desc"] [default: "asc"] Website options: --index Filename of the home page [default: "index.html"] --albums-output-folder Output subfolder for HTML albums (default: website root) [default: "."] --theme Name of the gallery theme to apply [choices: "classic", "cards", "mosaic"] [default: "classic"] --title Website title [default: "Photo album"] --footer Text or HTML footer [default: null] --css Path to a custom provided CSS/LESS file for styling [string] --google-analytics Code for Google Analytics tracking [string] Deprecated: --original-photos Copy and allow download of full-size photos [boolean] [default: false] --original-videos Copy and allow download of full-size videos [boolean] [default: false] --albums-date-format How albums are named in mode [moment.js pattern] [default: "YYYY-MM"] Options: --version Show version number [boolean] --help Show help [boolean] --config JSON config file (one key per argument) [string] --log Print a detailed text log [choices: null, "info", "debug", "trace"] [default: null] --usage-stats Enable anonymous usage statistics [boolean] [default: true] --dry-run Update the index, but don't create the media files / website [boolean] [default: false] The optional JSON config should contain a single object with one key per argument, not including the leading "--". For example: { "sort-albums-by": "start-date" } ``` ## Contributing We welcome all [issues](https://github.com/thumbsup/thumbsup/issues) and [pull requests](https://github.com/thumbsup/thumbsup/pulls)! If you are facing any issues or getting crashes, please try the following options to help troubleshoot: ```bash thumbsup [options] | tee # [16:04:56] media/thumbs/photo-1446822622709-e1c7ad6e82d52.jpg [started] # [16:04:57] media/thumbs/photo-1446822622709-e1c7ad6e82d52.jpg [completed] DEBUG="*" thumbsup [options] | tee # [16:04:56] media/thumbs/photo-1446822622709-e1c7ad6e82d52.jpg [started] # gm "identify" "-ping" "-format" "%[EXIF:Orientation]" [...] # gm "convert" "-quality" "90" "-resize" "x400>" "+profile" [...] # [16:04:57] media/thumbs/photo-1446822622709-e1c7ad6e82d52.jpg [completed] ``` If you want to contribute some code, please check out the [contributing guidelines](.github/CONTRIBUTING.md) for an overview of the design and a run-through of the different automated/manual tests.