How to Get Support for Onyx: Community, GitHub, and Enterprise Channels

Onyx provides three official support channels—Discord for community help, GitHub Issues for bug tracking, and direct email for private or urgent inquiries—all centralized in the codebase through constants and configuration files.

The onyx-dot-app/onyx repository bakes support pathways directly into both its backend services and React frontend, ensuring users can always find help whether they are browsing the repository or interacting with the deployed application. This guide explains how to access each support tier using the actual source code implementation as reference.

Community Support via Discord

The Discord community serves as the primary venue for quick technical assistance, feature discussions, and troubleshooting advice.

The canonical Discord URL is stored as a constant in the backend configuration layer to ensure consistency across all services.

In backend/onyx/configs/constants.py, the ONYX_DISCORD_URL constant defines the official invite link:

# backend/onyx/configs/constants.py

ONYX_DISCORD_URL = "https://discord.gg/4NA5SbzrWb"

This single source of truth can be imported by any FastAPI endpoint that needs to expose the URL to the frontend or external integrations.

Surfacing Discord in the UI

The React frontend consumes this constant through web/src/providers/ToastProvider.tsx to display contextual help toasts when errors occur.

The component renders a message that automatically directs users to the Discord server:

// web/src/providers/ToastProvider.tsx (excerpt)
import { ONYX_DISCORD_URL } from "@/config";

export const ToastProvider = ({ children }) => {
  const showSupportToast = () => {
    toast.error(
      <span>
        Need help? Join our community at{" "}
        <a href={ONYX_DISCORD_URL} target="_blank" rel="noopener noreferrer">
          Discord
        </a>{" "}
        for support!
      </span>
    );
  };

  return <>{children}</>;
};

When an uncaught error reaches the global error boundary, this toast fires immediately, giving users an in-app path to community support without requiring them to search external documentation.

Reporting Issues on GitHub

For reproducible bugs, feature requests, and structured progress tracking, GitHub Issues is the official platform.

According to the repository's README.md and CONTRIBUTING.md, users should file issues directly in the onyx-dot-app/onyx repository. The README.md (line 10) contains the entry point for the issue tracker, while CONTRIBUTING.md (line 23) provides templates and guidelines for writing effective bug reports.

Creating Issues Programmatically

If you need to automate issue creation from monitoring systems or CLI workflows, you can use the GitHub REST API. Replace <TOKEN> with a personal access token that has repo scope:

curl -X POST \
  -H "Authorization: token <TOKEN>" \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/repos/onyx-dot-app/onyx/issues \
  -d '{"title":"[Bug] Connector failure","body":"Describe the problem here…"}'

This endpoint matches the repository structure referenced in the official documentation, ensuring your automated reports appear in the same tracker used by manual filers.

Enterprise and Private Support Channels

For urgent matters, security disclosures, or licensing inquiries that cannot be discussed publicly, email contact is available.

The README.md (line 65) lists direct contact information for the core maintainers. Additionally, deployment scripts such as deployment/docker_compose/install.sh embed fallback email contacts for on-call engineers, providing a safety net during installation failures when community channels may not respond quickly enough.

Accessing Support Resources Programmatically

You can expose the support infrastructure through your own API endpoints by importing the constant from the configuration layer.

Here is a complete FastAPI endpoint that returns the Discord URL as JSON, leveraging the same constant used by the frontend toast system:

from fastapi import APIRouter
from onyx.configs.constants import ONYX_DISCORD_URL

router = APIRouter()

@router.get("/api/support")
def get_support_url():
    return {
        "discord_url": ONYX_DISCORD_URL,
        "github_issues": "https://github.com/onyx-dot-app/onyx/issues",
        "documentation": "https://github.com/onyx-dot-app/onyx/tree/main/docs"
    }

This approach centralizes your support configuration, ensuring that any changes to the Discord URL in backend/onyx/configs/constants.py automatically propagate to both your API consumers and the React UI via web/src/providers/ToastProvider.tsx.

Documentation and Troubleshooting

Before escalating to live support, consult the self-service documentation hosted under /docs/ in the repository.

Files such as docs/METRICS.md provide detailed troubleshooting steps for performance issues and connector configurations. These documents are searchable and linked from the main repository landing page, allowing users to resolve common problems without waiting for community responses.

Summary

• Discord is the fastest path for general help, with the URL centralized in backend/onyx/configs/constants.py and surfaced automatically in the UI via web/src/providers/ToastProvider.tsx.
• GitHub Issues is the canonical location for bug reports and feature requests, referenced in README.md and CONTRIBUTING.md.
• Email provides a private channel for security and licensing concerns, listed in README.md and deployment scripts.
• Documentation in the /docs/ directory offers self-service troubleshooting that can resolve issues without external contact.

Frequently Asked Questions

How do I report a bug in Onyx?

File a GitHub Issue in the onyx-dot-app/onyx repository. The CONTRIBUTING.md file provides templates for structuring your report, and the README.md links directly to the issue tracker. For reproducible bugs, include logs and environment details to expedite resolution.

What is the Onyx Discord server link?

The official Discord invite URL is stored as ONYX_DISCORD_URL in backend/onyx/configs/constants.py (line 9). The current link is https://discord.gg/4NA5SbzrWb, though you should verify the constant in the latest source code as it serves as the single source of truth for both backend services and the React frontend.

How do I get enterprise support for Onyx?

For enterprise, licensing, or urgent security matters, use the email contact listed in README.md (line 65). Deployment scripts like deployment/docker_compose/install.sh also contain fallback contacts for installation-time emergencies requiring immediate maintainer attention.

Where can I find Onyx troubleshooting documentation?

Check the /docs/ directory in the repository, specifically docs/METRICS.md and related files. These markdown documents cover performance tuning, connector debugging, and deployment troubleshooting. The repository renders these files on its GitHub landing page, making them accessible without cloning the project.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}