slideshow-api/README.md

48 lines
1.9 KiB
Markdown
Raw Normal View History

2023-11-28 15:53:13 +01:00
# slideshow-api
2023-11-28 15:52:53 +01:00
a simple web server serving (scaled) images and color palettes for [slideshow](https://git.velvettear.de/velvettear/slideshow).
## requirements
- [ImageMagick](https://imagemagick.org/) (optional; for scaling)
## endpoints
- `/`: request the name of a random image
- `/image/<name-of-an-image.jpeg>[?resolution=1920x1080]`: request the named image (in the specified resolution)
- `/palette/<name-of-an-image.jpeg>`: request the color palette of the named image
2023-11-28 15:52:53 +01:00
## 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_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 imagemagick's `convert` command is not in your `$PATH` the images will **not** be scaled.
2023-11-28 15:52:53 +01:00
**available log levels:**
- `debug`
- `info`
- `warning`
- `error`
- `fatal`
## color palette
**available algorithms:**
- `wsm`
- `wu`
for more information regarding the color palette see [color-thief](https://github.com/kennykarnama/color-thief).