User Manual

Complete guide for using LegacyStream audio streaming server

Introduction

LegacyStream is a high-performance audio streaming server designed for Windows, offering full compatibility with IceCast and SHOUTcast protocols. This user manual provides comprehensive guidance for installing, configuring, and using LegacyStream effectively.

Key Features

  • High Performance: Optimized for up to 100 million concurrent listeners
  • Protocol Support: Full IceCast and SHOUTcast compatibility
  • Multi-Codec: MP3, AAC, OGG, FLAC, and more
  • SSL/TLS Security: Let's Encrypt integration
  • Modern GUI: Qt-based user interface
  • Web Interface: Real-time monitoring and control

Installation

System Requirements

  • OS: Windows 7 or later (x64)
  • CPU: 1 GHz or faster
  • RAM: 2 GB minimum (4 GB recommended)
  • Storage: 100 MB available space
  • Network: Stable internet connection

Installation Steps

  1. Download the latest release from the download section
  2. Run the installer as administrator
  3. Follow the installation wizard
  4. Launch LegacyStream from the Start Menu
Note: For development builds, see the Developer Guide for source compilation instructions.

Configuration

Initial Setup

Upon first launch, LegacyStream will guide you through the initial configuration:

  1. Set server name and description
  2. Configure admin username and password
  3. Set default port (usually 8000)
  4. Choose SSL certificate options
  5. Configure mount points

Configuration Files

LegacyStream uses INI format configuration files:

  • config.ini: Main server configuration
  • mounts.ini: Mount point definitions
  • ssl.ini: SSL certificate settings

Key Settings

[Server]
Name=My LegacyStream Server
Description=High-quality audio streaming
AdminUser=admin
AdminPassword=secure_password
Port=8000

[SSL]
Enabled=true
CertificatePath=certs/server.crt
PrivateKeyPath=certs/server.key
AutoRenew=true

GUI Interface

Main Window

The LegacyStream GUI provides an intuitive interface for server management:

  • Server Status: Real-time server status and statistics
  • Stream Management: Create, start, stop, and configure streams
  • Configuration Panel: Modify server settings
  • Log Viewer: View server logs in real-time
  • System Tray: Minimize to system tray with notifications

Theme Support

LegacyStream supports multiple themes:

  • Light Theme: Traditional light interface
  • Dark Theme: Modern dark interface (default)
  • High Contrast: Accessibility-friendly theme

Accessibility Features

  • Screen reader compatibility
  • Keyboard navigation support
  • High contrast mode
  • Font size adjustment

Web Interface

Accessing the Web Interface

The web interface is available at http://localhost:8000 (or your configured port).

Features

  • Real-time Statistics: Live listener counts and performance metrics
  • Stream Management: Web-based stream control
  • Mount Point Display: Visual representation of active streams
  • Mobile Responsive: Optimized for mobile devices
  • HTML5 Audio Player: Embedded stream player

Administration

Access admin features at http://localhost:8000/admin:

  • Server configuration
  • Mount point management
  • SSL certificate management
  • User management

Streaming

Creating Streams

  1. Open the Stream Manager in the GUI
  2. Click "Add New Stream"
  3. Configure stream settings:
    • Mount point (e.g., /live)
    • Audio codec (MP3, AAC, etc.)
    • Bitrate and quality settings
    • Metadata configuration
  4. Click "Create Stream"

Stream Sources

LegacyStream supports various stream sources:

  • File Playback: Stream audio files
  • Live Input: Real-time audio capture
  • External Sources: IceCast/SHOUTcast relays
  • Playlists: Scheduled content

Stream URLs

Once configured, streams are available at:

  • HTTP: http://your-server:8000/mount-point
  • HTTPS: https://your-server:8000/mount-point
  • Direct: http://your-server:8000/mount-point.mp3

Security

SSL/TLS Configuration

LegacyStream supports multiple SSL certificate options:

  • Manual Certificates: Upload your own certificates
  • Let's Encrypt: Automatic certificate generation
  • Cloudflare: Integration with Cloudflare SSL

Access Control

  • Admin Authentication: Secure admin interface
  • Source Authentication: Protect stream sources
  • IP Filtering: Restrict access by IP address
  • Rate Limiting: Prevent abuse

Security Best Practices

  • Use strong admin passwords
  • Enable SSL/TLS encryption
  • Regular certificate renewal
  • Monitor access logs
  • Keep software updated

Monitoring

Real-time Statistics

Monitor your server performance through:

  • GUI Dashboard: Real-time metrics in the main window
  • Web Interface: Detailed statistics at /admin/stats
  • JSON API: Programmatic access to statistics
  • Log Files: Detailed server logs

Key Metrics

  • Listener Count: Current and peak listeners
  • Bandwidth Usage: Data transfer rates
  • Server Performance: CPU, memory, and disk usage
  • Stream Quality: Audio quality metrics
  • Error Rates: Connection and processing errors

Alerts and Notifications

Configure alerts for:

  • High listener counts
  • Server performance issues
  • Certificate expiration
  • Stream interruptions

Troubleshooting

Common Issues

Server Won't Start

  • Check if port is already in use
  • Verify configuration file syntax
  • Check Windows Firewall settings
  • Review error logs

Streams Not Working

  • Verify audio codec support
  • Check mount point configuration
  • Test network connectivity
  • Review stream source settings

SSL Certificate Issues

  • Check certificate file paths
  • Verify certificate validity
  • Test Let's Encrypt connectivity
  • Review certificate permissions

Getting Help

  • Documentation: Check the Troubleshooting Guide
  • Logs: Review server logs for detailed error information
  • Community: Visit the project forums
  • GitHub: Report issues on GitHub

Advanced Features

Performance Optimization

  • IOCP Optimization: Windows-specific performance tuning
  • Memory Management: Advanced memory pooling
  • Network Optimization: Efficient data transfer
  • Caching: Intelligent data caching

Advanced Audio Features

  • Audio Effects: Real-time audio processing
  • Format Conversion: On-the-fly codec conversion
  • Audio Analysis: Quality monitoring and analysis
  • Multi-stream Sync: Synchronized playback

Development Tools

  • Code Quality Tools: Linting and formatting
  • Debugging Tools: Advanced debugging features
  • Profiling Tools: Performance analysis
  • Development Scripts: Automation tools