automatic installation - panuozzo77/StreamingCommunity GitHub Wiki

Automatic Installation

This guide walks you through the automatic installation process for StreamingCommunity, which handles all dependencies and setup steps for you. This is the recommended method for most users who want a simple installation experience.

Supported Operating Systems

The automatic installation script is available for the following operating systems:

OS Support Status
Windows 10/11
Windows 7
Debian Linux
Arch Linux
CentOS Stream 9
FreeBSD
macOS
Termux

Prerequisites

Before running the automatic installation, ensure you have:

  1. Administrator/sudo privileges on your system
  2. Internet connection to download dependencies
  3. Git installed to clone the repository (if you haven't already downloaded it)

Installation Steps

Step 1: Get the StreamingCommunity Repository

If you haven't already downloaded the repository, clone it using Git:

git clone https://github.com/Arrowar/StreamingCommunity.git
cd StreamingCommunity

Alternatively, you can download the ZIP file and extract it.

Step 2: Run the Automatic Installer

On Windows:

Open Command Prompt or PowerShell as Administrator and run:

.\Installer\win_install.bat

On Linux/macOS/BSD:

Open Terminal and run:

sudo chmod +x Installer/unix_install.sh && ./Installer/unix_install.sh

Step 3: Wait for Installation to Complete

The installer will:

  1. Check for and install required system dependencies
  2. Set up a Python virtual environment
  3. Install required Python packages
  4. Configure FFmpeg and other binaries
  5. Set up the necessary file structure

This process may take several minutes depending on your internet connection and system performance.

Running StreamingCommunity After Installation

On Windows:

# Option 1: Direct execution
python .\test_run.py

# Option 2: Using the virtual environment
source .venv/bin/activate && python test_run.py && deactivate

On Linux/macOS/BSD:

# Make the script executable if needed
chmod +x test_run.py

# Run the script
./test_run.py

What the Installer Does

The automatic installer performs the following tasks:

  1. System Check: Identifies your operating system and architecture
  2. Dependency Installation: Installs required system packages
    • Windows: Uses built-in tools
    • Debian/Ubuntu: Uses apt-get
    • Arch Linux: Uses pacman
    • CentOS: Uses dnf
    • macOS: Uses Homebrew (installs it if not present)
  3. Python Environment: Creates a virtual environment for isolated dependencies
  4. Package Installation: Installs all required Python packages
  5. Binary Setup: Downloads and configures FFmpeg and related tools
  6. Configuration: Sets up default configuration files

Troubleshooting

Common Issues

  1. Permission Denied

    • Ensure you're running the installer with administrator/sudo privileges
    • Check file permissions with ls -la Installer/ and fix with chmod +x Installer/unix_install.sh
  2. Missing Dependencies

    • If the installer fails to install a dependency, try installing it manually
    • On Linux, you might need to update your package lists: sudo apt update (Debian/Ubuntu)
  3. Virtual Environment Issues

    • If the virtual environment creation fails, try creating it manually:
      python -m venv .venv
  4. Network Issues

    • Ensure you have a stable internet connection
    • If behind a proxy, configure your system's proxy settings

Getting Help

If you encounter issues not covered here:

Next Steps

⚠️ **GitHub.com Fallback** ⚠️