https://github.com/jaycollett/simpleslide
Simple docker container to load images from a directory and show them as a slideshow
https://github.com/jaycollett/simpleslide
container docker fullykiosk homeassistant slideshow-maker
Last synced: 16 days ago
JSON representation
Simple docker container to load images from a directory and show them as a slideshow
- Host: GitHub
- URL: https://github.com/jaycollett/simpleslide
- Owner: jaycollett
- License: mit
- Created: 2024-12-30T21:21:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-21T22:33:15.000Z (11 months ago)
- Last Synced: 2025-08-15T18:59:45.708Z (8 months ago)
- Topics: container, docker, fullykiosk, homeassistant, slideshow-maker
- Language: PHP
- Homepage:
- Size: 29.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SimpleSlide
[](https://img.shields.io/github/v/release/jaycollett/simpleslide?include_prereleases)
[](https://img.shields.io/github/last-commit/jaycollett/simpleslide)
[](https://img.shields.io/github/issues-raw/jaycollett/simpleslide)
[](https://img.shields.io/github/issues-pr/jaycollett/simpleslide)
[](https://img.shields.io/github/license/jaycollett/simpleslide)
A simple image slideshow Docker image.
This project was developed after I struggled to find a simple way to show some images through HTTP in a slide show. I was shocked that the solutions I already owned/hosted couldn't manage such a simple task, so I built my own because, well, why not?
The primary use case for this solution is to serve some locally stored family pictures as a slide show on my various Home Assistant tablets running Fully Kiosk software. The Fully Kiosk ScreenSaver solution really wants a simple HTTP URL for slideshow images or an undocumented JSON list of static images; I wanted to be able to re-use a storage folder I already had shared, have the images rotate (slide), be able to adjust how fast they progress, and lastly, I wanted the solution to update periodically to pick up new images I place on the share I map to the container.
The container is super easy to get running! The only required docker arguments are the port mapping (if you don't want to run it on the default port 80) and the volume mapping. The volume mapping is super critical: make sure your images are sitting in the root of the local path and that you don't alter the mapping to the /var/www/html/images path.
You can also control the "blackout" hours (when a black image is always shown) using environment variables:
- `BLACKOUT_ENABLED`: Set to `0`, `false`, or `off` to disable blackout mode entirely. (default: enabled)
- `BLACKOUT_START_HOUR`: The hour (0-23) when blackout mode starts (default: 22 for 10PM)
- `BLACKOUT_STOP_HOUR`: The hour (0-23) when blackout mode ends (default: 7 for 7AM)
**Docker CLI**
docker run -dit \
--name=simpleslide \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-e delayinsecs=60 \
-e BLACKOUT_ENABLED=1 \
-e BLACKOUT_START_HOUR=22 \
-e BLACKOUT_STOP_HOUR=7 \
-p 8181:80 \
-v /path/to/images:/var/www/html/images \
--restart unless-stopped \
ghcr.io/jaycollett/simpleslide:latest
Now you should be able to access your SimpleSlide image instance at: http://IPAddressOfHost:8181/
During the blackout window, only a black image will be served, making this ideal for screens that should not display images overnight or during certain hours. Set the environment variables to fit your needs!
To disable blackout mode entirely, set `BLACKOUT_ENABLED=0` (or `false`/`off`) in your Docker run command. In this case, images will always be served regardless of the time window.