Getting help and reporting an issue

Start on the page where the failure appeared, then collect only the diagnostic material needed to reproduce it. A useful report identifies the SoAI version, platform, affected operation, final status, and relevant Core or plugin log lines without including secrets. The System information report on Hardware is the fastest way to package environment details, but it does not replace reproduction steps or focused logs.

Use diagnostics in the SoAI WebUI

1. In the SoAI WebUI, open Dashboard to check overall service, plugin, model, queue, storage, and hardware state.
2. Open the affected feature and read its operation status or recorded reason.
3. Select the bell at the right of the header, then select Tasks to inspect work that is still running or awaiting cancellation.
4. Open Logs from the Settings button at the right of the header, choose Core or the affected plugin, and reproduce the failure once.
5. Open Hardware and select Info in the page header to generate a System information report.
6. Open About from the Settings button when you need only the displayed SoAI version and platform.

Dashboard requires System status access (SYSTEM_STATUS_READ), and individual cards can require additional resource access. Hardware requires Hardware read access (HARDWARE_READ), while its System information report also requests system status, system health, and installed plugin data, so the report requires SYSTEM_STATUS_READ, HARDWARE_READ, and PLUGIN_READ. Logs requires Log access (LOG_ACCESS). About requires SYSTEM_STATUS_READ and HARDWARE_READ.

The default sidebar layout hides Settings, Logs, and About. Open them from the Settings button at the right of the header. To add eligible pages to the sidebar, open Settings, select Theme, then find Sidebar. At Visible pages, select Edit, enable the pages you want, then select Save. Changing sidebar visibility does not grant access to a page.

Create a system information report

1. Open Hardware from the side navigation and select Info in the page header.
2. Wait for System information to finish generating, then review the displayed plain-text report.
3. Enable Anonymize if the report will leave your trusted environment.
4. Select Copy to place the displayed version on the clipboard, or select Download to save it as a soai-system-info-<timestamp>.txt file.

The report is designed to be pasted into a GitHub issue or attached to another support report. It combines the current hardware, system information, system health, and installed plugin snapshots, including the operating system and architecture, uptime, memory and swap, CPU and GPU names and readings, network interfaces, disk mounts and usage, hardware capabilities, plugin versions and states, and SoAI health information. It does not open or submit an issue, upload the report, collect logs, or add reproduction steps for you.

Anonymize is off each time the modal opens. When enabled, it replaces common hostnames, email addresses, network addresses, URL credentials and sensitive query values, device and serial identifiers, UUIDs, user paths, mount paths, and parts of timestamps and uptime values. The displayed text changes immediately, and Copy or Download uses that anonymized version. It preserves most diagnostic specifications so the report remains useful, and it deliberately leaves SoAI installation paths unchanged. Unrecognized identifiers, proprietary plugin or device names, and other private strings can remain, so inspect the final displayed report and remove anything sensitive before sharing it. The toggle applies only to the System information report, not to logs, configuration excerpts, screenshots, or other attachments.

Build a reproducible report

• Describe what you selected or sent, what you expected, and what happened.
• Include the exact final status, HTTP status, task ID, trace ID, or reference ID shown by SoAI.
• State whether the problem affects Core, one plugin, one model, one browser, or every client.
• Attach the reviewed System information report. Add the relevant GPU driver and any model or provider details that the generated report does not contain.
• Attach only the log window and configuration fields needed to reproduce the failure.

Remove API keys, passwords, cookies, authorization headers, provider credentials, private prompts, personal data, proprietary file contents, and unrelated configuration values from every attachment. Replace each removed value with a label so the report remains understandable. Do not send a full configuration export unless an approved private support channel explicitly requires it.

Choose the right destination

Do not place an undisclosed vulnerability or live credential in a public issue. The public issue tracker is for non-sensitive product defects that other contributors can safely inspect.

Related documentation

• Monitoring and observability
• Hardware monitoring
• Tasks and notifications
• HTTP API reference