Installation

Docker

Install Docker from here, if you have not already.

Docker is essential for running the fluxstream server and client in a single command with the CLI, fluxstream cli wraps docker-compose commands, hiding away complexity.

Fluxstream CLI Installation

Linux / macOS

curl -fsSL https://raw.githubusercontent.com/scythe504/fluxstream/main/scripts/install.sh | bash

Windows

irm https://raw.githubusercontent.com/scythe504/fluxstream/main/scripts/install.ps1 | iex

Verify Install

To check if the CLI application has been successfully installed run:

Terminal

fluxstream -h

It will print something like this in the terminal

fluxstream --help

v0.2.2

███████╗██╗     ██╗   ██╗██╗  ██╗███████╗████████╗██████╗ ███████╗ █████╗ ███╗   ███╗
██╔════╝██║     ██║   ██║╚██╗██╔╝██╔════╝╚══██╔══╝██╔══██╗██╔════╝██╔══██╗████╗ ████║
███████╗██║     ██║   ██║ ╚███╔╝ ███████╗   ██║   ██████╔╝█████╗  ███████║██╔████╔██║
██╔═══╝╝██║     ██║   ██║ ██╔██╗ ╚════██║   ██║   ██╔══██╗██╔══╝  ██╔══██║██║╚██╔╝██║
██║     ███████╗╚██████╔╝██╔╝ ██╗███████║   ██║   ██║  ██║███████╗██║  ██║██║ ╚═╝ ██║
╚═╝     ╚══════╝ ╚═════╝ ╚═╝  ╚═╝╚══════╝   ╚═╝   ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═╝     ╚═╝

Usage:
  fluxstream [command]

Available Commands:
  help        Help about any command
  setup       Sets up required configs and docker engine (if not installed)
  start       Start the Fluxstream server
  status      Shows the status of the server whether running or not
  stop        Stops the Fluxstream server
  where       Prints the url for the web app

Flags:
  -h, --help      help for fluxstream
  -v, --version   version for fluxstream

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

Manual Installation

Manual installation requires Go (Golang), Node.js, and FFmpeg to be installed and available on your system path.

Prerequisites

Before compiling, install the runtimes from their official websites:

1. Backend (Server) Setup

Clone the API server repository, copy the environment file, and run the backend service:

Compile Backend

git clone https://github.com/scythe504/fluxstream.git
cd fluxstream
cp .env.example .env
go run cmd/api/main.go

The API service runs locally on http://localhost:8080.

2. Frontend (Client) Setup

Clone the web client repository, install the packages, and run the build scripts:

Compile Frontend

git clone https://github.com/scythe504/fluxstream-web.git
cd fluxstream-web
cp .env.example .env
npm install
npm run build
npm run start

The web interface is available at http://localhost:3000.

License

Fluxstream is open-source software licensed under the GNU Affero General Public License v3.0 (AGPLv3).
See LICENSE for details.