Where to Find LedFx Troubleshooting Help and How to Report an Issue

Updated

LedFx's documentation site, docs.ledfx.app, includes a dedicated Troubleshooting section with two main pages: Network & Performance Troubleshooting and How to: Report an issue. If you're stuck, start with the network/performance page for common problems, then use the report guide if you need to file a bug. For faster, community-driven help, the LedFx Discord is the place to go — the docs point you there for project showcases and discussion.

What the Troubleshooting Section Covers

The docs list troubleshooting under a "Help / Misc" area, alongside the rest of the documentation. Two pages are available:

  • Network & Performance Troubleshooting — for issues related to connectivity and performance when running LedFx.
  • How to: Report an issue — a guide for submitting a problem so it can be addressed.

The site's navigation also includes broader reference material you may need while diagnosing a problem, such as Command Line Options, Audio Settings, Devices, Effects, and the REST API / WebSocket API references.

Where to Get Community Help

The documentation's "Demos" section directs users to the LedFx Discord, specifically the #projects and #show-and-tell channels, where community members share their setups. The docs also include a "Join the LedFx Community" section. For troubleshooting questions, the Discord is the practical first stop before filing a formal issue.

How to Report an Issue

The documentation provides a dedicated How to: Report an issue page. Use it when:

  • The problem isn't covered by the Network & Performance Troubleshooting page.
  • You've confirmed it's reproducible and want it tracked.

The report guide sits in the same Help/Misc area as the troubleshooting pages, so you can move directly from diagnosing to reporting.

Other Reference Pages That Help With Diagnosis

When narrowing down a problem, these documented areas are worth checking:

Area Why it helps
Command Line Options Verify how LedFx was started and with which flags
Audio Settings Rule out audio input configuration issues
Devices Confirm your LED devices are set up correctly
Effects Check effect configuration
REST API / WebSocket API Inspect or script against LedFx behavior
Configuration Review how settings are stored and applied

Quick Path Summary

  1. Check Network & Performance Troubleshooting in the docs.
  2. Review related pages (Audio Settings, Devices, Command Line Options) as needed.
  3. Ask in the LedFx Discord (#projects, #show-and-tell, community channels).
  4. If unresolved, follow How to: Report an issue.

The docs also note that the browser-based front end runs on port 8888 by default (http://localhost:8888 or http://127.0.0.1:8888), which is useful to confirm the interface itself is reachable before troubleshooting deeper.