githubEdit

Need Help?

If you're having trouble with Streamarr, here's how to get support.


Before Asking for Help

  1. Check the Documentation — Many common questions are answered in these docs

  2. Search Existing Issues — Your problem may have been reported and solved

  3. Check the FAQ — See Frequently Asked Questions

  4. Gather Information — Collect logs and error messages before asking


Getting Help

GitHub Discussions

For questions, feature ideas, and general discussion:

GitHub Discussionsarrow-up-right

This is the best place for:

  • Usage questions

  • Configuration help

  • Feature requests

  • Showing off your setup

GitHub Issues

For bug reports only:

GitHub Issuesarrow-up-right

circle-exclamation

When reporting a bug:

  1. Search existing issues first

  2. Use the bug report template

  3. Include all requested information

  4. Provide reproduction steps


How Can I Share My Logs?

When asking for help, logs are essential for diagnosing issues.

Location

Logs are stored in your config directory:

Docker

To view logs directly:

To copy log files from the container:

Sharing Logs

triangle-exclamation

For sharing logs:

  1. Pastebin Services — Use Pastebinarrow-up-right, GitHub Gistarrow-up-right, or similar

  2. File Attachment — Attach as a file in GitHub Issues/Discussions

  3. Code Blocks — For short logs, use code blocks in your message


Information to Include

When asking for help, include:

Basic Information

  • Streamarr version (found in Settings → System)

  • Installation method (Docker, Docker Compose)

  • Operating system

  • Browser (for UI issues)

Problem Description

  • What you expected to happen

  • What actually happened

  • Steps to reproduce the issue

  • Any error messages

Logs

  • Relevant log entries (see above)

  • Browser console errors (for UI issues)

  • Network requests (for API issues)

Configuration

  • Relevant settings (without sensitive data)

  • Docker command or compose file

  • Reverse proxy configuration (if applicable)


Debug Mode

For more detailed logs, you can increase the log level:

Available log levels:

  • error — Errors only

  • warn — Warnings and errors

  • info — General information

  • debug — Detailed debugging information (default)


Common Solutions

Restart the Container

Many issues can be resolved with a restart:

Clear Cache

Clear application caches in Settings → Jobs & Cache.

Check Connectivity

Verify Streamarr can reach external services:

Verify Configuration

Check config/settings.json for obviously incorrect values. You can manually edit this file if needed (restart required).


Contributing

If you'd like to help improve Streamarr:

We welcome:

  • Bug fixes

  • New features

  • Documentation improvements

  • Translations

Last updated

Was this helpful?