Interactive User Guide

Learn how to navigate and utilize the OneSignal platform.

Viewing & Managing Livestreams

The main Dashboard displays all broadcast channels you have access to, along with real-time live status indicators and quick actions:

  • Navigate to the Dashboard
    Click Dashboard in the left navigation bar to view all available streams and groups.
  • Create a New Stream
    Click Create New in the top-right header, enter a Stream Name (e.g., Studio 1 HD), and click Create Stream. The platform automatically generates a unique stream key and configures RTMP & SRT ingest endpoints.
  • Configure Source Setup & Per-Stream YouTube Channel
    Open a stream card and select the Source Setup tab to view your RTMP Push URL, SRT Listener URL, or Remote M3U8 Pull settings. You can also set the stream's dedicated YouTube Channel / Live URL directly in Source Setup and click Save Source Config.
  • Edit or Delete a Stream
    From the stream's detail page header, click Edit to rename the stream or assign it to a group, or click Delete to open the confirmation dialog and permanently remove the stream.
Snipping Tool, Social Sharing & Huawei VOD

The Snipping workspace allows you to extract frame-accurate clips from a live stream or 24-hour DVR timeline, process them via Huawei Cloud VOD, and publish directly to social platforms.

  • Open Snipping
    From any stream's details page, click the orange Snipping button in the header bar.
  • Set Mark In & Mark Out Points
    Scrub the continuous 24-hour DVR timeline or use keyboard shortcuts:
    1. Press "I" to set the Mark In (Start) timestamp.
    2. Press "O" to set the Mark Out (End) timestamp.
    Use the frame-nudge buttons or Left/Right arrow keys for sub-second precision.
  • Choose Snipping & Huawei VOD Engine Mode
    Select Instant Stream Copy for rapid extraction, Huawei Cloud VOD Transcode to upload to Huawei OBS and trigger cloud VOD transcoding automatically, or Frame-Accurate Re-Encode.
  • Download or Share to Social Media
    Once your clip status shows Ready, click the Download button for the MP4 file or click Share to open the compact Social Publish modal (supporting YouTube, X/Twitter, Facebook, TikTok, or direct link sharing).
Pro Tip: Keyboard Shortcuts
Use Spacebar to play/pause. Use SHIFT + Arrow Keys to jump 1 second forward or backward on the DVR timeline.
Ad Manager, Campaigns & 24-Hour Scheduler

The integrated Ad Manager enables midstream commercial insertion (Fullscreen Video Spots, L-Bar Squeezebacks, and Lower-Third Overlays), automated Station Ident detection, and proof-of-play reporting.

  • Create Campaigns & Target Specific Streams
    Open Ad Manager → Campaigns and click Create Campaign. Set the campaign dates, client name, notification emails, and select whether the campaign targets All Active Channels (Simulcast) or specific broadcast streams.
  • Upload Commercial Material & Huawei VOD Processing
    Click Upload Material directly on any campaign card (or inside the Manage Campaign dialog) to open the Upload Commercial Material modal pre-selected for that campaign. Video commercials are normalized for broadcast and automatically registered with Huawei Cloud VOD when configured.
  • Browse the Ads Library
    Use the Ads Library button in the top action bar or left Quick Actions menu to preview, inspect, or delete uploaded commercial assets.
  • Schedule Spots on the 24-Hour Grid
    In the 24-Hour Scheduler tab, click any hourly segment (e.g., :00, :10, :15, :20, :30, :40, :45, :50) to assign a commercial across single or multiple days and hours. Note: Paused or disabled campaigns cannot be scheduled.
  • Configure Stream URL Dropdown, YouTube URL & Per-Stream Idents
    Click Settings in Ad Manager to select a stream from the Direct Stream URL dropdown (which automatically loads and saves that stream's YouTube Channel / Live URL) and upload a per-stream Station Ident reference clip for automatic dHash break detection.
Huawei Cloud, OBS & VOD Configuration

The Administration portal is organized into dedicated tabs (Service Control, Users, Proxies, System Health, Stream Visibility, Menu Permissions, Global Settings, Huawei Cloud & OBS, Maintenance, Documentation, and Audit Trail).

  • Configure Huawei Access Keys & Live URLs
    Navigate to Administration → Huawei Cloud & OBS and enter your Huawei Access Key ID (AK), Secret Access Key (SK), Huawei Live Ingest URL, and Huawei Live Output / Playback URL.
  • Configure Recordings Bucket & Huawei VOD Project ID
    Specify your Recordings OBS Bucket Name, OBS Region, OBS Endpoint URL, and Huawei VOD Project ID. When a VOD Project ID is configured, snipping exports and uploaded commercial videos are automatically processed via Huawei Cloud VOD.
  • Save & Apply Instantly
    Click Save Huawei & OBS Settings. Credentials are persisted to both the database and /opt/onesignal/backend/.env without requiring a server reboot.
User Management, Search & Advertisement Admin Role

Manage user accounts, role levels, and per-stream permissions from Administration → Users.

  • Search & Filter Users
    Use the instant search bar on the Users tab to filter accounts by username, full name, email, or role, or use the role dropdown to filter by Administrators, Advertisement Admins, or Standard Users.
  • Assign User Roles (Admin, Advertisement Admin, User)
    When creating or editing a user, select one of three access levels:
    • Administrator (admin): Full access to all streams, Ad Manager, and Administration tabs.
    • Advertisement Admin (ad_admin): Dedicated access to manage Ad Campaigns, Commercial Library, 24-Hour Scheduling, and Proof-of-Play reports.
    • Standard User (user): Access to assigned livestreams and the Snipping tool.
  • Per-Stream Access Control
    Click Access on any user row to check or uncheck the specific broadcast streams that user is permitted to view and snip.
Proxy Administration & Rotation

The Administration → Proxies tab manages outbound HTTP/SOCKS proxies used when pulling external streams or YouTube feeds.

  • Sync from Webshare API
    Enter your Webshare API Key and click Sync Webshare Proxies to automatically fetch and populate verified proxy endpoints into /opt/onesignal/backend/proxies.json.
  • Add Custom Proxies & Rotate Active Pool
    Add individual proxy URLs (http://user:pass@ip:port) manually, remove unhealthy proxies, or click Rotate Active Proxy to cycle the primary outbound proxy immediately.
Stream Branding & Watermarks

Dynamically overlay transparent PNG station bugs/logos onto any live broadcast channel.

  • Open Branding Studio
    From a stream's detail page, click Brand Stream to upload a transparent PNG logo, position it on the live preview canvas, adjust scale/opacity, and toggle live branding on or off.
Platform Architecture & Guided Installer

OneSignal combines Nginx-RTMP, MediaMTX SRT, a unified FFmpeg compositor/transcoder, Flask/SQLAlchemy, MySQL, Redis, and Huawei Cloud OBS/VOD:

  • Ingest & Transcoding Pipeline
    Encoders push RTMP (:1935/live/<key>) or SRT (UDP :5000 via MediaMTX). scripts/transcoder_manager.py manages per-stream FFmpeg pipelines, burns in watermarks or midstream commercials (Fullscreen, L-Bar Squeezeback, Lower-Third), and outputs HLS segments to /opt/onesignal/hls_branded/.
  • Huawei Cloud OBS & VOD Services
    obs_service.py and vod_service.py handle offloading recordings, clips, and commercial MP4s to Huawei OBS and triggering asynchronous Huawei Cloud VOD transcoding jobs using AK/SK request signing.
  • Guided Server Installer Package
    Run ./deploy/build_package.sh to build deploy/onesignal-installer-package.tar.gz, or deploy on a fresh Ubuntu/Debian server with sudo ./install.sh --domain live.yourdomain.com. Full technical documentation is also available in the Standalone Developer Guide and Admin Support Guide.