Also available on Github: https://github.com/Seednode/roulette
Go to file
Seednode 2a6c6b48d4 Reverted changes that entirely broke debug, keeping change to printf strings 2023-01-24 19:06:27 -06:00
cmd Reverted changes that entirely broke debug, keeping change to printf strings 2023-01-24 19:06:27 -06:00
licenses Updated copyright year 2023-01-18 11:19:29 -06:00
vendor Updated transitive dependencies 2023-01-05 20:44:01 -06:00
.gitignore Initial commit 2022-09-08 10:12:06 -05:00
LICENSE Updated copyright year 2023-01-18 11:19:29 -06:00
README.md Sped up indexing when caching is enabled but filters are applied, added RWMutex to Index struct 2023-01-21 10:27:35 -06:00
build.sh Added more build platform targets, maybe I'll even test some of them 2022-11-11 17:44:05 -06:00
go.mod Build against 1.20rc3 because we live on the edge 2023-01-19 12:46:50 -06:00
go.sum Updated transitive dependencies 2023-01-05 20:44:01 -06:00
main.go Initial commit 2022-09-08 10:12:06 -05:00

README.md

About

Sometimes, you just need a way to randomly display images from your filesystem.

Simply point this tool at one or more directories, and then open the specified port (default 8080) in your browser.

A new image will be selected if you open / directly, or if you click on any displayed image.

Browser history is preserved, so you can always go back to any previously displayed image.

Supported file types and extensions are bmp, gif, jp[e]g, png, and webp.

Feature requests, code criticism, bug reports, general chit-chat, and unrelated angst accepted at roulette@seedno.de.

Static binary builds available here.

I only test the linux/amd64, linux/arm64, and windows/amd64 builds, the rest are all best-effort™.

x86_64 and ARM Docker images of latest version: oci.seedno.de/seednode/roulette:latest.

Dockerfile available here.

Filtering

You can provide a comma-delimited string of alphanumeric patterns to match via the include= query parameter, assuming the -f|--filter flag is enabled.

Only filenames matching one or more of the patterns will be served.

You can also provide a comma-delimited string of alphanumeric patterns to exclude, via the exclude= query parameter.

Filenames matching any of these patterns will not be served.

You can also combine these two parameters, with exclusions taking priority over inclusions.

Both filtering parameters ignore the file extension and full path; they only compare against the bare filename.

Sorting

You can specify a sorting pattern via the sort= query parameter, assuming the -s|--sort flag is enabled.

A value of sort=asc means files will be served in ascending order (lowest-numbered to highest).

If a file exists with a numbered suffix one higher than the currently displayed file, it will be served next.

A value of sort=desc means files will be served in descending order (highest-numbered to lowest).

If a file exists with a numbered suffix one lower than the currently displayed file, it will be served next.

In either case, if no sequential file is found, a new random one will be chosen.

For sort=asc, the lowest-numbered file matching a given name will be served first.

For sort=desc, the highest-numbered file will be served instead.

If any other (or no) value is provided, the selected file will be random.

Note: These patterns require sequentially-numbered files matching the following pattern: filename###.extension.

Refresh

If a positive-value refresh=<integer><unit> query parameter is provided, the page will reload after that interval.

This can be used to generate a sort of slideshow of images.

Supported units are ns, us/µs, ms, s, m, and h.

Caching

If the -c|--cache flag is passed, the indices of all specified paths will be cached on start.

This will slightly increase the delay before the application begins responding to requests, but should significantly speed up subsequent requests.

If any include=/exclude= filters are specified in a given request, the cache will be bypassed for that specific request.

The cache can be regenerated at any time by accessing the /_/clear_cache endpoint.

Debug

If the -d|--debug flag is passed, an additional endpoint, /_/stats, is registered.

When accessed, this endpoint returns a JSON document listing every file served, along with the number of times it has been served, its filesize, and timestamps of when it was served.

Usage output

Usage:
  roulette <path> [path]... [flags]
  roulette [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  version     Print version

Flags:
  -c, --cache         only scan directories once, at startup (or when filters are applied)
  -d, --debug         store list of files served and number of times they were served
  -f, --filter        enable filtering via query parameters
  -h, --help          help for roulette
  -p, --port uint16   port to listen on (default 8080)
  -r, --recursive     recurse into subdirectories
  -s, --sort          enable sorting via query parameters
  -v, --verbose       log accessed files to stdout

Use "roulette [command] --help" for more information about a command.