You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
41 lines
2.2 KiB
41 lines
2.2 KiB
# Asking for Support
|
|
|
|
Before seeking help, please make sure you have first tried these following:
|
|
|
|
- **Updating** Overseerr to the latest version.
|
|
- **Stopping and restarting** Overseerr.
|
|
- **Restarting** your machine.
|
|
- **Clearing** your browser cache.
|
|
- **Analyzing** your logs, you just might find the solution yourself!
|
|
- **Searching** the [documentation](../), [installation guide](../getting-started/installation.md), and [FAQs](./faq.md).
|
|
|
|
If you still have questions after troubleshooting on your own, feel free to ask on [Discord](https://discord.gg/PkCWJSeCk7)! (Please review our [Code of Conduct](https://github.com/sct/overseerr/blob/develop/CODE_OF_CONDUCT.md) before posting.)
|
|
|
|
Be sure to also include a link to your logs. (Please see [How can I share my logs?](asking-for-support.md#how-can-i-share-my-logs) below.)
|
|
|
|
## What should I include when asking for support?
|
|
|
|
When contacting support, please try to include as much information as possible. A vague statement like "it doesn't work" provides very little to go on, and makes it difficult for us to help you.
|
|
|
|
Try to answer the following questions:
|
|
|
|
- What were you trying to do, and how did you attempt it?
|
|
- What command did you enter?
|
|
- What did you click on?
|
|
- What settings did you change?
|
|
- Did you follow official instructions, or a third-party guide?
|
|
- Provide a step-by-step list of what you tried.
|
|
- Provide a brief description of your setup.
|
|
- What exactly do you see?
|
|
- Did something happen?
|
|
- Did something not happen?
|
|
- Are there any error messages showing?
|
|
- Provide screenshots to help us see what you are seeing.
|
|
- Share your Overseerr logs, which show exactly what happened and are often critical for identifying issues (see [How can I share my logs?](asking-for-support.md#how-can-i-share-my-logs) below).
|
|
|
|
## How can I share my logs?
|
|
|
|
1. Locate the current log file at `<your Overseeerr config directory>/logs/overseerr.log`.
|
|
2. Open the log file and **copy its contents** into a [**secret gist** on GitHub](https://gist.github.com/). If you upload your logs elsewhere, we may ask you to share them again via GitHub Gist.
|
|
3. **Share the link/URL to your secret gist** in the [`#support` channel in our Discord server](https://discord.gg/PkCWJSeCk7).
|