Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add troubleshooting guide #112

Merged
merged 1 commit into from
Sep 28, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Troubleshooting Guide

At first, determine the case: whether the Clairvoyance doesn't work at all, with particular website or stops working during its executing. After this, refer to appropriate section for guidance.

## The Clairvoyance doesn't work at all
- Installation: make sure that there were no errors during installation and that you are using correct version of dependencies.
- Internet: make sure that you have a stable connection and that the Clairvoyance has rights to access your target.
- Usage: refer to the [README](README.md) for usage instructions.

## The Clairvoyance doesn't work with particular website
- Scope: make sure that there is no general issue: try `clairvoyance https://rickandmortyapi.com/graphql -o schema.json` or known working target.
- URI: check endpoint URI validity (it might be a typo, an erroneous copy or other issue).
- Authorization issue: ensure usage of correct headers, cookies and other authorization pieces.
- WAF: ensure that the program imitates browser/web client at sufficient level, e.g. check that user agent matches modern browser/app-specific web client.

## The Clairvoyance worked, but stopped working
- Does the program work when you restart it? If the answer is yes, check "Rate Limits", if not, then check "Server-related issue"
- Rate Limits: server might rate limit requests from the same IP/user. Lower amount of threads or try to run the program in a slow mode
- Server-related issue: server might be temporary unavailable, check the endpoint manually using browser or other previously used tools. Alternatively, your IP/user might have been banned.