Tube
- 0 ratings
Youtube-like (without censorship and features you don't need!) Video Sharing App written in Go which also supports automatic transcoding to MP4 H.265 AAC, multiple collections and RSS feed.
Deploy this app to Linode with a free $100 credit!
tube is a Youtube-like (without censorship and features you don't need!)
Video Sharing App written in Go which also supports automatic transcoding to
MP4 H.264 AAC, multiple collections and RSS feed.
/feed.xml)
./tubeOpen http://127.0.0.1:8000/ in your Browser!
```#!sh $ docker pull prologic/tube $ docker run -p 8000:8000 -v /path/to/data:/data
Open http://DOCKER_MACHINE_IP:8000/ in your Browser!
Where `DOCKER_MACHINE_IP` is the IP Address of your Docker Node.
### Building From Source
```#!sh
$ git clone https://git.mills.io/prologic/tube
$ cd tube
$ make build
$ ./tubeOpen http://127.0.0.1:8000/ in your Browser!
A Production Deployment can be found at https://tube.mills.io/ -- This is run and managed via a Docker Swarm cluster with a Docker-Compose / Stack very similiar to the one you can find in the repo: docker-compose.yml
Beyond this a "Production Deployment" is out-of-scope at this time for the documentation being provided here. Please don't hesitate to file an Issue however for ask for help or advice or contact the author directly!
tube can be configured to suit your particular needs and comes by default with
a sensbile set of defaults. There is also a default configuration at the
top-level config.json that you can use as a start point and
modify to suite your needs.
To Run tube with a provided configuration just pass the -c /path/to/config
option; for example:
```#!sh $ tube -c config.json
Everything in the configuration is optional as the builtin defaults are used
if you do not supply anything, omit some sections or values or the configuration
is invalid. Refer to the [default config.json](config.json) for the builtin
defaults (_this files matches the builtin defaults_).
Here are some documentation on key configuration items:
### Library Options and Upload / Video Paths(s)
```#!json
{
"library": [
{
"path": "videos",
"prefix": "",
"preserve_upload_filename": false
}
],
}path to the value of the path where you want to store videos
and where tube will watch for new video files to show up.prefix to add a directory component in the video URL.preserve_upload_filename parameter to true,
to to preserve the name of files that are uploaded to this location.When tube sees a video file in path it will read the metadata directly
from the video file. Next it will look for a .yml file with the same stem
(Same filename, different extension). Any tag extracted from the video file
can be overridden here.
``#!.yml
title: Something Funny
description: A short little funny video
prefix
The path will be visible on the upload page and clients can select a
destination for their uploads. BothLastly, `tube` will look for a `.jpg` file with the same stem,
to use as thumbnail image.
You can add more than one location for video files.
```#!json
{
"library": [
{
"path": "/path/to/cat/videos",
"prefix": "cats",
"preserve_upload_filename": true
},
{
"path": "relative/dog/directory/",
"prefix": "dogs"
},
],
}andpath` need to be unique.
```#!json { "server": { "host": "0.0.0.0", "port": 8000, "store_path": "tube.db", "upload_path": "uploads", "preserve_upload_filename": false, "max_upload_size": 104857600 } }
- Set `host` to the interface you wish to bind to. If you want to only bind
your local machine (_ie: localhost_) set this to `127.0.0.1`.
- Set `port` to any port you wish to bind the listening socket of the server
to. It doesn't matter what it is as long as there it doesn't collide with
a port already in use on your system.
- Set `store_path` to a directory where `tube` will store statistics on videos
viewed.
- Set `upload_path` to a directory that you wish to use as a temporary working
space for `tube` to store uploaded videos and process them. This can be a
tmpfs file system for example for faster I/O.
- Set `preserve_upload_filename` parameter to `true` and tube will try to
preserve the filename that was transmitted by the client. The default is
to give random filenames to uploaded files.
If you set it to `true` in the "server" node, it will be active for all
library locations.
- Set `max_upload_size` to the maximum number of bytes you wish to impose on
uploaded and imported videos. Upload(s)/Import(s) that exceed this size will
by denied by the server. This is a saftey measure so as to not DoS the
Tube server instance. Set it to a sensible value you see fit.
### Thumbnailer / Transcoder Timeouts
```#!json
{
"thumbnailer": {
"timeout": 60
},
"transcoder": {
"timeout": 300,
"sizes": null
}
}Set timeout to the no. of seconds to permit for thumbnail generation and
video transcoding. This value has to be large enough for thumbnail generation
and transcoding to take place depending on the max_upload_size permitted.
These values also depend on the underlying performance of the machine Tube
runs on. Use sensible values for your max_upload_size + system performance.
This is a safety measure to ensure background processed do not run away
and/or hog system resources. The thumbnailer and transcoder processes will
be killed if their execution time exceeds these values.
Set sizes to an map of size => suffix that you wish to support for
transcoding videos to lower quality on Upload/Import. This is especially
useful for serving up videos to users that have poor bandwidth or where
data charges are high for them. The following is a valid map:
```#!json { "transcoder": { "sizes": { "hd720": "720p", "hd480": "480p", "nhd": "360p", "film": "240p" } } }
Transcoding is currently done into am MP4 container with H.264 video codec and AAC audio codec.
HEVC / H.265 It is easy to add, but due to current browser and mobile device limitation we stick
with H.264 as default for now. If you want to add H.265 support, we are open for pull requests
that allow configuring the target codec e.g. via the `transcoder` section in `config.json`.
### Optionally Require Password for Uploading
You might be hosting a page where the public can view video, but you
don't want others to be able to upload and add content.
By specifying a password as an environment variable when running tube
you can require this password to be provided when you access `/upload`.
The username will always be `uploader`.
```#!sh
$ auth_password=upload123 tube -c config.json{
"feed": {
"external_url": "",
"title": "Feed Title",
"link": "http://your-url.example/about",
"description": "Feed Description",
"author": {
"name": "Author Name",
"email": "author@somewhere.example"
},
"copyright": "Copyright Text"
}
}
{ "copyright": { "content": "All Content herein Public Domain and User Contributed." } }
Thank you to all those that have contributed to this project, battle-tested it, used it in their own projects or products, fixed bugs, improved performance and even fix tiny typos in documentation! Thank you and keep contributing!
You can find an AUTHORS file where we keep a list of contributors to the project. If you contribute a PR please consider adding your name there. There is also Github's own Contributors statistics.
tube source code is available under the MIT License.
Previously based off of tube by davy wybiral .
App icon is licensed under the Apache license from Google Noto Emoji.
Please login to review this project.
No reviews for this project yet.
Comments (0)
Please login to join the discussion on this project.