Skip to content

Commit 0fcf0db

Browse files
committed
Add reporting issues guide
1 parent f1154eb commit 0fcf0db

2 files changed

Lines changed: 90 additions & 0 deletions

File tree

docs/guides/reporting-issues.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
sidebar_position: 6
3+
title: "Reporting Issues"
4+
---
5+
6+
# Reporting Issues
7+
8+
Found a bug or unexpected behavior? Here's how to file an effective report:
9+
10+
- **Yattee app issues:** [github.com/yattee/yattee/issues](https://github.com/yattee/yattee/issues)
11+
- **Yattee Server issues:** [github.com/yattee/yattee-server/issues](https://github.com/yattee/yattee-server/issues)
12+
13+
## Before Reporting
14+
15+
- **Search existing issues** — someone may have already reported the same problem.
16+
- **Try the latest version** — the bug may already be fixed.
17+
- **Check the [Troubleshooting](../server/troubleshooting.md) page** — common server problems and their solutions are documented there.
18+
19+
## Reporting Yattee App Issues
20+
21+
### Gathering Logs
22+
23+
The app has a built-in logging system that captures detailed information about what's happening under the hood.
24+
25+
1. Open **Settings → Advanced → Developer**.
26+
2. Enable **Enable Logging**.
27+
3. *(Optional)* Enable **Verbose MPV Logging** or **Verbose Remote Control Logging** if the issue is related to playback or remote control.
28+
4. **Reproduce the issue.**
29+
5. Go back to **Developer Settings → View Logs**.
30+
6. Export logs:
31+
- **iOS / macOS:** Tap **Export Logs** → use the Share Sheet to save or send the file.
32+
- **tvOS:** Tap **Export Logs** → scan the QR code or visit the displayed URL from another device.
33+
34+
### What to Include
35+
36+
- Description of the issue and steps to reproduce
37+
- Expected vs. actual behavior
38+
- Screenshots or screen recordings
39+
- Exported log file
40+
- App version and build number
41+
- Device model and OS version (iOS / macOS / tvOS)
42+
- Source type being used (Yattee Server, Invidious, Piped, local files, network shares)
43+
44+
## Reporting Yattee Server Issues
45+
46+
### Gathering Logs
47+
48+
View server logs using Docker:
49+
50+
```bash
51+
# Show all logs
52+
docker logs yattee-server
53+
54+
# Show the last 100 lines
55+
docker logs --tail 100 yattee-server
56+
57+
# Follow logs in real time
58+
docker logs -f yattee-server
59+
```
60+
61+
### Server Info
62+
63+
The `/info` endpoint returns version details and configuration:
64+
65+
```bash
66+
curl http://localhost:8085/info
67+
```
68+
69+
This includes yt-dlp, ffmpeg, and Python versions, enabled sites, and current config. Include this output in your report.
70+
71+
### What to Include
72+
73+
- Description of the issue and steps to reproduce
74+
- Server logs (relevant portion)
75+
- Output of the `/info` endpoint
76+
- Docker setup details (`docker-compose.yml`, relevant `.env` variables — **redact passwords and keys**)
77+
- Browser and OS (if the issue is in the admin panel)
78+
- Whether you're using a reverse proxy, and which one (nginx, Caddy, etc.)
79+
80+
## Tips for Good Bug Reports
81+
82+
- **One issue per report** — don't bundle multiple bugs into a single issue.
83+
- **Use a clear, descriptive title** — "Video won't play from Yattee Server source" is better than "it's broken".
84+
- **Include minimal reproduction steps** — the fewer steps needed to reproduce, the faster it gets fixed.
85+
- **Attach files** rather than pasting very long logs inline.

sidebars.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,11 @@ const sidebars: SidebarsConfig = {
8080
id: 'guides/public-instances',
8181
label: 'Public Instances for YouTube',
8282
},
83+
{
84+
type: 'doc',
85+
id: 'guides/reporting-issues',
86+
label: 'Reporting Issues',
87+
},
8388
],
8489
};
8590

0 commit comments

Comments
 (0)