royallthefourth / photosplatter

Photosplatter is a single binary that serves an HTML index of photos

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Photosplatter

Photosplatter serves an HTML index of photos from a directory.

Design Goals

Photosplatter is extremely simple to operate. Small, single-board servers can easily run it at acceptable performance. Provided a path and a port number, it will find photos in the directory and display them.

  • No config files
  • No databases
  • Automatic content directory rescans
  • Only one file to deploy

Building

To build Photosplatter, run build.sh. This will produce a single photosplatter executable with everything you need packed inside.

Basic Operation

Place photosplatter somewhere and run it:

./photosplatter --path ~/images --port 8080

See photosplatter.service for an optional systemd user unit. Systems running systemd may place this file into ~/.config/systemd/user, then systemctl --user enable --now photosplatter to run Photosplatter automatically as a normal user.

Practical Use

In my home, I have a tiny arm7 server running Syncthing. Whenever my phone connects to my home wifi, Syncthing sends all of new photos from my phone to my server. With the photos automatically uploaded to the server, I can use Photosplatter to browse them. It's much nicer than using a USB cable and keeps my files off of other peoples' servers.

About

Photosplatter is a single binary that serves an HTML index of photos

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:Go 92.5%Language:TypeScript 5.5%Language:Shell 1.4%Language:CSS 0.6%