You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
fastgallery/README.md

64 lines
2.2 KiB
Markdown

# fastgallery - Static photo gallery generator
4 years ago
[![Build Status](https://travis-ci.com/tonimelisma/fastgallery.svg?branch=master)](https://travis-ci.com/tonimelisma/fastgallery)
4 years ago
Creates a static gallery of your photo and video library.
4 years ago
- Super fast (written in Go and C, concurrent, uses fastest image/video libraries, 4-8 times faster than others)
- Both photo and video support
- Deals with any file formats (ncluding HEIC, HEVC)
4 years ago
- Only updates changed files, runs incrementally
4 years ago
- Uses relative paths (safe for using in subdirectory or S3)
*Please note that fastgallery is still pre-alpha, I am actively working on it*
## Install
### MacOS
For dependencies, use Homebrew to install:
`brew install vips ffmpeg`
### Ubuntu Linux
4 years ago
If you want HEIF support, be sure to first add my PPA with updated libvips42 packages:
`sudo add-apt-repository ppa:tonimelisma/ppa`
4 years ago
Then, for dependencies, install libvips42 for images and optionally ffmpeg (if you need video support):
`apt-get install libvips42 ffmpeg`
4 years ago
## Usage
`VIPS_WARNING=0 fastgallery -o /var/www/html ~/Dropbox/Pictures`
4 years ago
## Backlog
4 years ago
Before 0.1 Alpha release, still to do:
4 years ago
- Finalize web frontend so it looks sleek
- Optimize image conversion from three steps into one
4 years ago
- Add triangle overlay on video thumbnails to indicate video
4 years ago
4 years ago
Before 0.1 Beta release:
4 years ago
- Use all of thumb/full/symlink in detecting changes required
- Patch bimg library so it doesn't log to console without VIPS_WARNING (https://github.com/h2non/bimg/issues/355)
- Clean function and variable names
4 years ago
- Refactor functions into internal packages
- Create unit tests (blargh)
4 years ago
- Check if half-finished thumbnail/fullsize images/videos create corrupt files if program is interrupted
Before 0.1 final release:
- Packaging for Ubuntu in my PPA
- Packaging for Homebrew / MacOS
4 years ago
4 years ago
Other stuff on the roadmap:
4 years ago
- Finger swiping for web frontend
- Arrow key navigation for web frontend
4 years ago
- Allow copying instead of symlinking originals
- Lots of options / config file to tweak defaults
4 years ago
- Add logging to file, better bimg and ffmpeg error handling, flag to panic on warnings
4 years ago
- Add 'force_divisible_by=2' to ffmpeg encoding (when feature is available in next ffmpeg release)
4 years ago
- Go through the rest of the minor annoyances (TODOs in code)