@moartube/moartube-client

1.0.24 • Public • Published

logo

MoarTube-Client

A repository containing the client software for managing your MoarTube Node. The client software is a cross-platform terminal-based Node.js Express application that makes managing your node's videos and live streams as simple as reading this sentence.

How to Get Started

Welcome to the MoarTube Client setup guide! This document will guide you through the different setup methods to get your MoarTube Client up and running. Don't worry; MoarTube is so easy to set up and use, you'll be done in minutes. When ready, head over to MoarTube Node if you haven't yet.

Table of Contents

Features

  • Cross platform support for Windows/macOS/Linux
  • Video on demand (VoD) and HLS live streaming
  • Admin panel for managing videos and live streams
  • HLS (H.264, AAC), MP4 (H.264, AAC), WEBM (VP9, Opus), OGV (VP8, Opus) container formats
  • Transcode static MP4/WEBM video to HLS/MP4/WEBM/OGV
  • Transcode RTMP stream (such as from OBS) to HLS live stream
  • Video output resolutions: 2160p, 1440p, 1080p, 720p, 480p, 360p, 240p
  • No server-side encoding; client-side only
  • HTTPS/WSS capabilities
  • GPU acceleration for Nvidia and AMD (Windows only)
  • Different video player modes: streamer, theater, fullscreen
  • Dark mode option and browser appearance configuration recognition
  • Anonymous video comments section and live stream chat
  • Reports section for comments and videos
  • Comment monitoring overview with moderation functionality
  • Run your node in the cloud or on your home WiFi
  • Can run on a Raspberry Pi Zero 2 W
  • Publicize your node's content on MoarTube or run your node privately
  • Dual box compatible; broadcast an RTMP stream with software such as OBS from a primary system over a network (WAN or LAN) to a secondary system running the MoarTube Client, separating stream broadcasting from stream processing. This is achieved without any special plugins, such as NDI.
  • Cloudflare Turnstile; next-generation bot detection and human verification without the annoyance of captcha.
  • Cloudflare one-click integration; easily integrate your node into the Cloudflare Network, allowing for global media delivery capabilities of your videos and live streams that rivals major platforms, all from a single node. Features automated caching strategy configuration and automated cache management, and of course the best security from the world's leading CDN.

image

image

image

System Requirements

MoarTube Client performs the heavy computational processing that comes with video and live stream decoding/encoding. As such, the only limiting factor is the system that it's running on. Dual boxing is supported if a dedicated system running the client is preferred.

The software supports GPU acceleration (Windows only), but is disabled by default. To enable it, just switch it on in the settings. Nvidia and AMD GPUs currently supported.

Prerequisites

Observe the corresponding prerequisite for your installation method.

npm

If you're using npm to install the software, make sure that Node.js and npm are installed on your machine.

git

You can clone the repo, but make sure that Node.js and npm are installed on your machine.

Installation Methods

Choose any of the following installation methods.

You can install MoarTube Client globally:

npm i @moartube/moartube-client -g

And run from the command-line globally:

moartube-client

You can install MoarTube Client locally:

npm i @moartube/moartube-client

And run from the command-line locally:

node node_modules/@moartube/moartube-client/moartube-client.js
git clone https://github.com/MoarTube/MoarTube-Client

Open a terminal in the cloned directory and run:

npm install
node moartube-client.js

Next Steps

Open the MoarTube Client

Open a web browser at localhost:8080 to view the MoarTube Client user interface and log into your node.

Default Login Credentials

The default login credentials for your node are below. Be sure to change these upon logging in.

username: admin
password: admin

Get MoarTube Node

If you haven't already, it's time to get the MoarTube Node.

Package Sidebar

Install

npm i @moartube/moartube-client

Weekly Downloads

7

Version

1.0.24

License

Custom License - See LICENSE.md file

Unpacked Size

3.03 MB

Total Files

77

Last publish

Collaborators

  • cconley717