diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 28 insertions, 1 deletions
@@ -1 +1,28 @@ -# tube
\ No newline at end of file +# tube [](https://godoc.org/github.com/wybiral/tube) + +This is a Golang project to build a self hosted "tube"-style video player for watching your own video collection over HTTP or hosting your own channel for others to watch. + +Some of the key features include: +- Easy to add videos (just move a file into the folder) +- No database (video info pulled from file metadata) +- No JavaScript (the player UI is entirely HTML) +- Easy to customize CSS and HTML template +- Automatically generates RSS feed +- Clean, simple, familiar UI + +Currently only supports MP4 video files so you may need to re-encode your media to MP4 using something like [ffmpeg](https://ffmpeg.org/). + +Since all of the video info comes from metadata it's also useful to have a metadata editor such as [EasyTAG](https://github.com/GNOME/easytag) (which supports attaching images as thumbnails too). + +By default the server is configured to run on 127.0.0.1:0 which will assign a random port every time you run it. This is to avoid conflicting with other applications and to ensure privacy. You can configure this to be any specific host:port by editing `config.json` before running the server. You can also change the RSS feed details and library path from `config.json`. + +# installation + +Currently there are no prebuilt packages or anything so you'll need Golang. + +1. [Install Golang](https://golang.org/doc/install) if you don't already have it +2. `go get github.com/wybiral/tube` +3. `cd $GOPATH/src/github.com/wybiral/tube` +4. `go run main.go` (this will output the URL for accessing from a browser) +5. Move videos to `$GOPATH/src/github.com/wybiral/tube/videos` +6. Open the URL from step 4 and enjoy! |