githubEdit

Help Centre

The Help Centre provides resources and documentation to help users get started and troubleshoot common issues.

Overview

Access the Help Centre by clicking the Help link in the navigation or user dropdown menu.

The Help Centre includes:

  • Getting started guides

  • Feature explanations

  • Troubleshooting tips

  • Contact and support information


Topics

Getting Started

New user guides covering:

Topic
Description

What is Streamarr?

Introduction to Streamarr and its features

What is Plex?

Overview of Plex media server

Quick Start

Getting up and running quickly

Download Plex

Links to Plex apps for all platforms

Download Streamarr

PWA installation instructions

Become a Member

How to sign up and join the server

Watching Content

Guides for streaming content:

Topic
Description

Devices

Supported devices and apps

Watch on TV

Setting up on smart TVs and streaming devices

Download Offline

Downloading content for offline viewing

Requesting

How to request new content

Reporting Issues

How to report playback or content issues

Legal documentation:

  • Terms of Use — Usage terms and conditions

  • Privacy Policy — Data handling and privacy information


Features

Quick links to frequently accessed help articles.

Contact Support

Information on how to reach administrators for additional help:

  • Support email (if configured)

  • Support URL (if configured)

  • GitHub links for bug reports

Server Status

If your administrator has configured a status page (e.g., Uptime Kuma), a link to check service status is displayed in the Help Centre. This allows users to check whether services are experiencing issues without needing to sign in.

See Uptime Kuma in Settings for configuration.


Configuration

Administrators can customize support resources:

Support URL

Configure a custom support page URL:

  1. Navigate to Settings → General

  2. Set the Support URL field

  3. Save settings

This URL is displayed in the Help Centre and used for support links throughout the app.

Support Email

Configure a support email address:

  1. Navigate to Settings → General

  2. Set the Support Email field

  3. Save settings

This email is displayed when users need to contact support.


Access

The Help Centre is accessible to all unauthenticated users.


Integration with Onboarding

The Help Centre complements the onboarding system:

  • New users are directed to relevant help topics during tutorials

  • Tutorial steps can link to specific help articles

  • Welcome slides can reference the Help Centre for more information

See Onboarding for tutorial configuration.

Last updated

Was this helpful?