cf7/shellery
1
0
Fork 0
Code Issues 12 Pull requests Projects Releases Packages 1 Wiki Activity Actions
shellery/README.md

2.4 KiB
Raw Blame History

Shellery

Simple SSG to create dynamic gallery one-pagers in your shell! Shell+Gallery

Issue Tracker and Requests

Features

Available:

  • Simple use, single dependency (exiftool)
  • Removes EXIF/GPS metadata from published images by default
  • no Javascript
  • Lightbox of image with anchor
  • Order of images via filename
  • Container available
  • Simple to modify (Pictures and Templates)

Ideas:

  • check file formats
  • conf file for options
  • anonymize file names
  • sections via file names

Not planned:

Requirements

  • bash and GNU coreutils
  • exiftool - apt install libimage-exiftool-perl (Debian/Ubuntu) or brew install exiftool (macOS)

Docker/Podman users need nothing on the host, exiftool is baked into the image.

Building with --keep-exif / STRIP_EXIF=0 does not require exiftool.

Usage

Docker / Podman

mkdir -p images output

podman run -v $(pwd)/images:/app/images -v $(pwd)/output:/app/output git.uphillsecurity.com/cf7/shellery:latest

Local

  • Clone
  • Put images into ./images/
  • ./build.sh
  • Check ./output/

Modify files accordingly.

Docker Build

Build and run:

docker build -t localhost/shellery .
docker run -v $(pwd)/images:/app/images -v $(pwd)/output:/app/output localhost/shellery

The generated gallery will be in ./output/index.html

Metadata removal

EXIF, GPS, IPTC and XMP metadata is stripped from every image by default. Only the copies in ./output/ are processed, your originals in ./images/ are never modified.

To publish images with their metadata intact:

./build.sh --keep-exif
# or
STRIP_EXIF=0 ./build.sh

# container
podman run -e STRIP_EXIF=0 -v $(pwd)/images:/app/images -v $(pwd)/output:/app/output git.uphillsecurity.com/cf7/shellery:latest

Notes

Security

For security concerns or reports, please contact via hello a t uphillsecurity d o t com gpg.

License

Apache License

Version 2.0, January 2004

http://www.apache.org/licenses/

  • ✅ Commercial use
  • ✅ Modification
  • ✅ Distribution
  • ✅ Patent use
  • ✅ Private use
  • ✅ Limitations
  • ❌Trademark use
  • ❌Liability
  • ❌Warranty