docs(common-issues): add troubleshooting guide#196
Open
Liremant wants to merge 6 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Greptile Overview
Greptile Summary
Added comprehensive troubleshooting documentation covering common operational issues with the Remnawave panel deployment.
Key Changes
- New File: Created
docs/common-issues.mdwith bilingual (Russian/English) troubleshooting guide - Coverage: Documents 6 major issue categories:
- 502 Bad Gateway errors on subscription pages
- Timeout errors (45000ms) during node operations
- Post-upgrade 502 errors
- Telegram OAuth domain validation failures
- ECONNREFUSED errors after node reinstallation
- PostgreSQL collation errors after major version upgrades
- Structure: Each section includes symptoms, root causes, and step-by-step solutions
- Reference Materials: Includes environment variable reference, diagnostic checklists, and external resource links
Documentation Quality
The guide follows best practices with clear symptom-cause-solution formatting, practical code examples, and actionable checklists for quick diagnosis.
Confidence Score: 5/5
- This PR is safe to merge with no risk - it only adds documentation
- This is a documentation-only change that adds a new troubleshooting guide. No code, configuration, or infrastructure changes are included. The content is well-structured, comprehensive, and provides valuable guidance for users experiencing common deployment issues.
- No files require special attention - this is purely additive documentation
Important Files Changed
File Analysis
| Filename | Score | Overview |
|---|---|---|
| docs/common-issues.md | 5/5 | New troubleshooting guide added with comprehensive coverage of common deployment and configuration issues |
Sequence Diagram
sequenceDiagram
participant User
participant Docs as common-issues.md
participant Panel as Remnawave Panel
participant Node as Remnawave Node
participant Sub as Subscription Page
participant Proxy as Reverse Proxy
User->>Panel: Access subscription page
Panel->>Proxy: Route request
alt 502 Bad Gateway
Proxy-->>User: 502 Error
User->>Docs: Check troubleshooting guide
Docs->>User: Verify DNS, proxy config, SUB_PUBLIC_DOMAIN
User->>Proxy: Fix configuration
User->>Sub: Restart services
end
User->>Panel: Manage node operations
Panel->>Node: API request (port check)
alt Timeout Error
Node-->>Panel: timeout of 45000ms exceeded
Panel-->>User: Error message
User->>Docs: Check timeout section
Docs->>User: Verify Node Port, network, environment vars
User->>Node: Fix configuration & restart
end
User->>Panel: Telegram OAuth login
alt Domain Invalid
Panel-->>User: "domain invalid"
User->>Docs: Check OAuth section
Docs->>User: Configure BotFather domain (not .xyz)
User->>Panel: Update settings
end
User->>Panel: After upgrade
alt PostgreSQL Collation Error
Panel-->>User: Collation error
User->>Docs: Check PostgreSQL section
Docs->>User: Use rescue CLI Fix Collation
User->>Panel: Run fix & restart
end
1 file reviewed, no comments
…ced with the current format (environment in docker-compose)
… guides/common-errors.md was modified, and a Russian file, common-errors-ru.md, was added.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.