gabehf/random-image-server
1
0
Fork 0
mirror of https://github.com/gabehf/random-image-server.git synced 2026-03-12 16:50:25 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

update README

Browse source
This commit is contained in:
Gabe Farrell 2025-02-24 19:04:39 -05:00
parent 386d5d3c4b
commit cc2fb9e2fb
1 changed files with 17 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -1,7 +1,7 @@
# random-image-server # random-image-server
Serves a random image from a directory. Listens to file system events to automatically update available images. Serves a random image from a directory. Listens to file system events to automatically update available images.
NOTE: I threw together this program to serve random backgrounds to my homelab (homepage)[https://gethomepage.dev/]. I have not done any testing. Software provided as-is. NOTE: I threw together this program to serve random backgrounds to my homelab [homepage](https://gethomepage.dev/). I have not done any testing. Software provided as-is.
## Usage ## Usage
Simply run the program with no arguments. Simply run the program with no arguments.
@ -17,6 +17,22 @@ Docker run example:
docker run -p 8080:8080 --volume /path/to/images:/images:ro gabehf/random-image-server docker run -p 8080:8080 --volume /path/to/images:/images:ro gabehf/random-image-server
``` ```
Docker compose example:
```yaml
services:
random-image-server:
image: gabehf/random-image-server:latest
container_name: random-image-server
environment:
ALLOWED_EXTENSIONS: .png,.jpg # comma-separated; default: .png,.jpg,.jpeg,.webp
ports:
- 8888:8080
volumes:
- /path/to/my/images/:/images:ro
restart: unless-stopped
```
### From Source ### From Source
Clone the repository: Clone the repository:
``` ```