Run native setup

This is not the recommended way to setup xplex (even as a developer environment), but if you’re feeling adventurous—to build and deploy it without containerization, then here’s how to do it.

Prerequisites

1. Install Dependencies

   Depending on the package manager the host system uses, the package names & the commands to install them will vary; please use the appropriate section below:

   APT

   If you’re on a Debian-based system, using APT as package manager (e.g. Ubuntu, OpenMediaVault, Linux Mint etc.) then run:

   # update installed packages
   sudo apt update
   sudo apt upgrade
   # install build dependencies
   sudo apt install -y build-essential git nodejs npm

   DNF

   If you’re on a Fedora-based system, using DNF as package manager (e.g. RHEL, CentOS, Alma, Rocky, Amazon Linux etc.) then run:

   # update installed packages
   sudo dnf update
   # install build dependencies
   sudo dnf install -y gcc gcc-c++ git make nodejs nodejs-npm perl wget

   Others

   If you’ve chosen to use a system that uses some different & obscure package manager, then you already know what you’re doing and don’t need hand holding to prepare for the build.

   Just make sure to update installed packages and then install the build dependencies.

   Here’s a generic (and likely non-exhaustive) list of dependencies you may need:

   • gcc & g++
   • git & wget
   • make & autoconf
   • perl & perl-modules
   • nodejs & nodejs-npm

   Good luck!

   Just in Case

   If you end up installing additional packages for a successful build, please let us know.

2. Download Code

   Git

   If you have Git installed, you can clone the repository:

   git clone https://github.com/debloper/xplex.git
   cd xplex
   git checkout v1.0.0

   Zip

   If you don’t have Git installed, you can download the code as a ZIP archive:

   # avoid using latest development code, as it may be unstable
   # make sure to download archive of the latest tagged version
   # from https://github.com/debloper/xplex/tags - for exmaple:
   wget https://github.com/debloper/xplex/archive/refs/tags/v1.0.0.zip
   unzip v1.0.0.zip
   cd xplex-1.0.0

   Tar

   If you don’t have Git installed, and instead of ZIP, you prefer TAR archives:

   # avoid using latest development code, as it may be unstable
   # make sure to download archive of the latest tagged version
   # from https://github.com/debloper/xplex/tags - for exmaple:
   wget https://github.com/debloper/xplex/archive/refs/tags/v1.0.0.tar.gz
   tar -xzf v1.0.0.tar.gz
   cd xplex-1.0.0

3. Manage Firewall Rules

   xplex uses port 80 for HTTP & port 1935 for RTMP. Please make sure the firewall on the host system is configured to allow traffic on these ports.

Setup Script

Inside the directory, there’s a setup.sh, which automates the tasks to get xplex up and running:

NOTE: audit the script before running it

sudo ./setup.sh
# or, you can configure and run each of its commands separately.

Time required to build nginx-rtmp

Depending on the available compute resources, the build may take a few minutes to complete. On a VM with 4 modern CPU cores and 4GB RAM, it takes about 2-3 minutes.

Open a browser & access your xplex^HQ dashboard at http://<hostname-or-IP>/. If you can see the dashboard, then xplex is up and running & ready for the post-installation setup. 🎉