fastgallery/README.md

48 lines
1.8 KiB
Markdown
Raw Normal View History

2020-09-20 15:38:22 +00:00
# gogallery - Static photo gallery generator
2020-09-28 21:30:14 +00:00
Creates a static gallery of your photo and video library.
- Super fast (100% Go, 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)
2020-10-10 13:47:25 +00:00
- Only updates changed files, runs incrementally
- Uses relative paths (safe for subdirectories or S3)
2020-09-28 21:30:14 +00:00
N.B. deletes all unused media files in gallery directory
## Install
2020-10-10 17:58:50 +00:00
For dependencies, on Ubuntu, install libvips42 and ffmpeg (if you need video support)
2020-09-28 21:32:07 +00:00
`apt-get install libvips42 ffmpeg`
2020-09-28 21:30:14 +00:00
2020-10-10 17:58:50 +00:00
Image and video format support will depend on the support compiled in these libraries. For HEIC+HEVC support check out my PPA for a recompiled libvips42 for Ubuntu (to be published...)
## Usage
2020-09-28 21:32:07 +00:00
`VIPS_WARNING=0 gogallery -o /var/www/html ~/Dropbox/Pictures`
2020-09-28 21:30:14 +00:00
## Backlog
2020-10-10 13:44:20 +00:00
Before 0.1 Alpha release, still to do:
2020-10-10 21:46:04 +00:00
- Convert thumbnail and full-size pictures
- Add triangle overlay on video thumbnails to indicate video
2020-09-28 21:30:14 +00:00
- Clean up half-finished thumbnail/fullsize/symlink if program is halted midway
- Use all of thumb/full/symlink in detecting changes required
2020-10-10 13:44:20 +00:00
Before 0.1 Beta release:
- Clean function names
- Refactor functions into internal packages
- Create unit tests (blargh)
2020-10-10 13:47:25 +00:00
- Packaging for Ubuntu
- Set up Ubuntu repository (Github? PPA?)
2020-10-11 21:20:22 +00:00
- Finger swiping for web frontend
- Arrow key navigation for web frontend
2020-10-10 13:44:20 +00:00
2020-09-28 21:30:14 +00:00
Other stuff on the roadmap:
- Allow copying instead of symlinking originals
- Lots of options / config file to tweak defaults
2020-10-10 13:47:25 +00:00
- Patch bimg library so it doesn't log to console without VIPS_WARNING (https://github.com/h2non/bimg/issues/355)
2020-09-28 21:30:14 +00:00
- Add logging to file, better bimg and ffmpeg error handling, when to panic
- Add 'force_divisible_by=2' to ffmpeg encoding (when feature is available in next ffmpeg release)
- Go through the rest of the minor annoyances (TODOs in code)