velvettear/slideshow-api
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
slideshow-api/README.md

1.8 KiB
Raw Blame History

slideshow-api

a simple web server serving (scaled) images and color palettes for slideshow.

requirements

configuration

configuration is entirely done via environment variables.

variable default description
SLIDESHOW_ADDRESS "0.0.0.0" the listen address of the web server
SLIDESHOW_PORT 3000 the port of the web server
SLIDESHOW_DIRECTORY "$HOME" path to a directory containing images
SLIDESHOW_SCANINTERVAL 60 the interval for directory scans in seconds
SLIDESHOW_RESOLUTION the resolution to which images are scaled (i.e. 1920x1080)
SLIDESHOW_PALETTE_ALGORITHM "wsm" the algorithm used to generate the color palette
SLIDESHOW_PALETTE_COLORS 16 the amount of colors generated
SLIDESHOW_LOGLEVEL "info" the log level

note:
if SLIDESHOW_RESOLUTION is unset or imagemagick's convert command is not in your $PATH the images will served as they are (without any scaling).

available log levels:

  • debug
  • info
  • warning
  • error
  • fatal

color palette

available algorithms:

  • wsm
  • wu

for more information regarding the color palette see color-thief.