pleb

module
v0.1.13 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 16, 2020 License: MIT

README

pleb

Docker Cloud Build Status GitHub tag (latest SemVer)

Pleb is a very simple local-network oriented video streaming site. All you have to do is throw an MP4 or other compatible video file into a specified directory, and it will show up in a list of streamable videos in the browser interface. That's it. No fancy client. No fancy database. Nothing. Just stick a file in a directory and watch it in your browser.

Screenshot

It even looks nice on phones, although your mileage may vary in Chrome due to WebKit, and by extension Blink, being a buggy flaming garbage fire, especially when it comes to flexbox. This particular screenshot was taken in Brave, so it seems to be working for now at least.

Phone Screenshot

Dependencies

ffmpeg and ffprobe
Used for generating thumbnails. If these aren't found, thumbnails won't work, but everything should still function fine.

Installation

To install for simple command-line usage, use

go get -u -v github.com/DeedleFake/pleb/cmd/pleb

For Docker, a container is provided as deedlefake/pleb:

docker run -it --rm -v "/srv/videos:/videos:ro" -p 8080:8080 deedlefake/pleb

Usage

To use, simply point pleb at a directory that has videos in it:

pleb -videos /srv/videos

By default, pleb serves to port 8080, so open http://localhost:8080 in your browser.

Video titles are pulled directly from the filenames by simply stripping the extension, so name the file something that's descriptive. Times, which can be used for sorting, are simply the modification time of the video file.

Directories

Path Synopsis
cmd
pleb
The pleb command runs the pleb server.
The pleb command runs the pleb server.
internal
cmd/embed
The embed command embeds a directory structure into Go code.
The embed command embeds a directory structure into Go code.
vidutil
Package vidutil contains utility functions for dealing with video files.
Package vidutil contains utility functions for dealing with video files.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL