automatic installation - panuozzo77/StreamingCommunity GitHub Wiki
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.
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 | ❌ |
Before running the automatic installation, ensure you have:
- Administrator/sudo privileges on your system
- Internet connection to download dependencies
- Git installed to clone the repository (if you haven't already downloaded it)
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.
Open Command Prompt or PowerShell as Administrator and run:
.\Installer\win_install.bat
Open Terminal and run:
sudo chmod +x Installer/unix_install.sh && ./Installer/unix_install.sh
The installer will:
- Check for and install required system dependencies
- Set up a Python virtual environment
- Install required Python packages
- Configure FFmpeg and other binaries
- Set up the necessary file structure
This process may take several minutes depending on your internet connection and system performance.
# Option 1: Direct execution
python .\test_run.py
# Option 2: Using the virtual environment
source .venv/bin/activate && python test_run.py && deactivate
# Make the script executable if needed
chmod +x test_run.py
# Run the script
./test_run.py
The automatic installer performs the following tasks:
- System Check: Identifies your operating system and architecture
-
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)
- Python Environment: Creates a virtual environment for isolated dependencies
- Package Installation: Installs all required Python packages
- Binary Setup: Downloads and configures FFmpeg and related tools
- Configuration: Sets up default configuration files
-
Permission Denied
- Ensure you're running the installer with administrator/sudo privileges
- Check file permissions with
ls -la Installer/
and fix withchmod +x Installer/unix_install.sh
-
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)
-
Virtual Environment Issues
- If the virtual environment creation fails, try creating it manually:
python -m venv .venv
- If the virtual environment creation fails, try creating it manually:
-
Network Issues
- Ensure you have a stable internet connection
- If behind a proxy, configure your system's proxy settings
If you encounter issues not covered here:
- Check the Common Issues section
- Visit the GitHub Issues page
- Join the Discord community for support
- Configure your settings
- Learn about command line arguments
- Try your first global search