Skip to content

Wallpaper Server Documentation

Wallpaper Server is a self-hosted Go application that turns your image folders into a filterable wallpaper API and a browser gallery. Its defining feature is that a single request can return the image itself — ready to save or set as a wallpaper — instead of metadata you then have to parse and download separately.

Fetch a random wallpaper with one request
curl "http://localhost:8519/api/wallpapers/random/image" --output wallpaper.jpg
Get started Installation API reference ← Back to website

Direct image responses

Endpoints under /api/wallpapers/random/image and /api/wallpapers/{id}/image stream the actual image bytes, so one URL is enough for any automation tool.

Automatic classification

Every image is analysed for brightness, orientation, aspect ratio and dominant colour when it is scanned or uploaded.

Browser gallery

A built-in gallery at / lets you browse, filter, upload and delete wallpapers, with infinite scrolling and lazy loading.

Self-hosted

A single Go binary with no external database. Configure it with YAML and run it on your own machine, a home server or in Docker.

Wallpaper Server is distributed under the MIT License.