open-source-mirrors
/
overseerr
mirror of https://github.com/sct/overseerr
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
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.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '0918b25413'
${ noResults }
overseerr/docs/support/need-help.md

41 lines
2.2 KiB
Raw Normal View History Unescape

docs: update documentation to reflect recent changes/additions (#1730) [skip ci] * docs: update documentation to reflect recent changes/additions * docs: add list of third-party integrations * docs: add v3 warning * docs: fix Docker for Windows link text * docs: fix Telegram 'Send Silently' setting description * docs: note that application URL is required for password reset/generation * docs: add additional details on webhook template variables
3 years ago
# Need Help?
docs: documentation update (#516) [skip ci] * docs: testing docs with gitbook * GitBook: [docs] 3 pages modified * GitBook: [docs] one page modified * docs: migrate more wiki docs * docs: Update gmail. Add 4k FAQ * GitBook: [docs] 6 pages modified * docs: add media missing in overseerr to faq * GitBook: [docs] one page modified * GitBook: [docs] 5 pages modified * GitBook: [docs] 2 pages modified * GitBook: [docs] 5 pages modified * GitBook: [docs] 5 pages modified * GitBook: [docs] 5 pages modified * GitBook: [docs] one page modified * GitBook: [docs] 2 pages modified Co-authored-by: samwiseg0 <2241731+samwiseg0@users.noreply.github.com> Co-authored-by: samwiseg0 <phillipah@gmail.com>
4 years ago
docs: update documentation to reflect recent changes/additions (#1730) [skip ci] * docs: update documentation to reflect recent changes/additions * docs: add list of third-party integrations * docs: add v3 warning * docs: fix Docker for Windows link text * docs: fix Telegram 'Send Silently' setting description * docs: note that application URL is required for password reset/generation * docs: add additional details on webhook template variables
3 years ago
Before seeking assistance, please make sure you have first tried these following:
docs: documentation update (#516) [skip ci] * docs: testing docs with gitbook * GitBook: [docs] 3 pages modified * GitBook: [docs] one page modified * docs: migrate more wiki docs * docs: Update gmail. Add 4k FAQ * GitBook: [docs] 6 pages modified * docs: add media missing in overseerr to faq * GitBook: [docs] one page modified * GitBook: [docs] 5 pages modified * GitBook: [docs] 2 pages modified * GitBook: [docs] 5 pages modified * GitBook: [docs] 5 pages modified * GitBook: [docs] 5 pages modified * GitBook: [docs] one page modified * GitBook: [docs] 2 pages modified Co-authored-by: samwiseg0 <2241731+samwiseg0@users.noreply.github.com> Co-authored-by: samwiseg0 <phillipah@gmail.com>
4 years ago
docs: organize and edit FAQ (#1336) [skip ci] * docs: organize and edit FAQ * docs: add HAMA to list of supported agents * docs: make suggested changes
4 years ago
- **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!
docs: update documentation to reflect recent changes/additions (#1730) [skip ci] * docs: update documentation to reflect recent changes/additions * docs: add list of third-party integrations * docs: add v3 warning * docs: fix Docker for Windows link text * docs: fix Telegram 'Send Silently' setting description * docs: note that application URL is required for password reset/generation * docs: add additional details on webhook template variables
3 years ago
- **Searching** the [documentation](../README.md), [installation guide](../getting-started/installation.md), and [FAQs](./faq.md).
docs: Various edits, and addition of UI style guide (#982) [skip ci]
4 years ago
docs: organize and edit FAQ (#1336) [skip ci] * docs: organize and edit FAQ * docs: add HAMA to list of supported agents * docs: make suggested changes
4 years ago
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.)
docs: update documentation to reflect recent changes/additions (#1730) [skip ci] * docs: update documentation to reflect recent changes/additions * docs: add list of third-party integrations * docs: add v3 warning * docs: fix Docker for Windows link text * docs: fix Telegram 'Send Silently' setting description * docs: note that application URL is required for password reset/generation * docs: add additional details on webhook template variables
3 years ago
Be sure to also include a link to your logs. (Please see [How can I share my logs?](#how-can-i-share-my-logs) below.)
docs: documentation update (#516) [skip ci] * docs: testing docs with gitbook * GitBook: [docs] 3 pages modified * GitBook: [docs] one page modified * docs: migrate more wiki docs * docs: Update gmail. Add 4k FAQ * GitBook: [docs] 6 pages modified * docs: add media missing in overseerr to faq * GitBook: [docs] one page modified * GitBook: [docs] 5 pages modified * GitBook: [docs] 2 pages modified * GitBook: [docs] 5 pages modified * GitBook: [docs] 5 pages modified * GitBook: [docs] 5 pages modified * GitBook: [docs] one page modified * GitBook: [docs] 2 pages modified Co-authored-by: samwiseg0 <2241731+samwiseg0@users.noreply.github.com> Co-authored-by: samwiseg0 <phillipah@gmail.com>
4 years ago
docs: update documentation to reflect recent changes/additions (#1730) [skip ci] * docs: update documentation to reflect recent changes/additions * docs: add list of third-party integrations * docs: add v3 warning * docs: fix Docker for Windows link text * docs: fix Telegram 'Send Silently' setting description * docs: note that application URL is required for password reset/generation * docs: add additional details on webhook template variables
3 years ago
## What should I include when requesting support?
docs: documentation update (#516) [skip ci] * docs: testing docs with gitbook * GitBook: [docs] 3 pages modified * GitBook: [docs] one page modified * docs: migrate more wiki docs * docs: Update gmail. Add 4k FAQ * GitBook: [docs] 6 pages modified * docs: add media missing in overseerr to faq * GitBook: [docs] one page modified * GitBook: [docs] 5 pages modified * GitBook: [docs] 2 pages modified * GitBook: [docs] 5 pages modified * GitBook: [docs] 5 pages modified * GitBook: [docs] 5 pages modified * GitBook: [docs] one page modified * GitBook: [docs] 2 pages modified Co-authored-by: samwiseg0 <2241731+samwiseg0@users.noreply.github.com> Co-authored-by: samwiseg0 <phillipah@gmail.com>
4 years ago
docs: update documentation to reflect recent changes/additions (#1730) [skip ci] * docs: update documentation to reflect recent changes/additions * docs: add list of third-party integrations * docs: add v3 warning * docs: fix Docker for Windows link text * docs: fix Telegram 'Send Silently' setting description * docs: note that application URL is required for password reset/generation * docs: add additional details on webhook template variables
3 years ago
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.
docs: organize and edit FAQ (#1336) [skip ci] * docs: organize and edit FAQ * docs: add HAMA to list of supported agents * docs: make suggested changes
4 years ago
Try to answer the following questions:
docs: documentation update (#516) [skip ci] * docs: testing docs with gitbook * GitBook: [docs] 3 pages modified * GitBook: [docs] one page modified * docs: migrate more wiki docs * docs: Update gmail. Add 4k FAQ * GitBook: [docs] 6 pages modified * docs: add media missing in overseerr to faq * GitBook: [docs] one page modified * GitBook: [docs] 5 pages modified * GitBook: [docs] 2 pages modified * GitBook: [docs] 5 pages modified * GitBook: [docs] 5 pages modified * GitBook: [docs] 5 pages modified * GitBook: [docs] one page modified * GitBook: [docs] 2 pages modified Co-authored-by: samwiseg0 <2241731+samwiseg0@users.noreply.github.com> Co-authored-by: samwiseg0 <phillipah@gmail.com>
4 years ago
docs: organize and edit FAQ (#1336) [skip ci] * docs: organize and edit FAQ * docs: add HAMA to list of supported agents * docs: make suggested changes
4 years ago
- What were you trying to do, and how did you attempt it?
docs: Various edits, and addition of UI style guide (#982) [skip ci]
4 years ago
- What command did you enter?
- What did you click on?
- What settings did you change?
docs: organize and edit FAQ (#1336) [skip ci] * docs: organize and edit FAQ * docs: add HAMA to list of supported agents * docs: make suggested changes
4 years ago
- Did you follow official instructions, or a third-party guide?
docs: Various edits, and addition of UI style guide (#982) [skip ci]
4 years ago
- Provide a step-by-step list of what you tried.
docs: organize and edit FAQ (#1336) [skip ci] * docs: organize and edit FAQ * docs: add HAMA to list of supported agents * docs: make suggested changes
4 years ago
- Provide a brief description of your setup.
- What exactly do you see?
docs: Various edits, and addition of UI style guide (#982) [skip ci]
4 years ago
- Did something happen?
- Did something not happen?
- Are there any error messages showing?
- Provide screenshots to help us see what you are seeing.
docs: update documentation to reflect recent changes/additions (#1730) [skip ci] * docs: update documentation to reflect recent changes/additions * docs: add list of third-party integrations * docs: add v3 warning * docs: fix Docker for Windows link text * docs: fix Telegram 'Send Silently' setting description * docs: note that application URL is required for password reset/generation * docs: add additional details on webhook template variables
3 years ago
- Share your Overseerr logs, which show exactly what happened and are often critical for identifying issues (see [How can I share my logs?](#how-can-i-share-my-logs) below).
docs: documentation update (#516) [skip ci] * docs: testing docs with gitbook * GitBook: [docs] 3 pages modified * GitBook: [docs] one page modified * docs: migrate more wiki docs * docs: Update gmail. Add 4k FAQ * GitBook: [docs] 6 pages modified * docs: add media missing in overseerr to faq * GitBook: [docs] one page modified * GitBook: [docs] 5 pages modified * GitBook: [docs] 2 pages modified * GitBook: [docs] 5 pages modified * GitBook: [docs] 5 pages modified * GitBook: [docs] 5 pages modified * GitBook: [docs] one page modified * GitBook: [docs] 2 pages modified Co-authored-by: samwiseg0 <2241731+samwiseg0@users.noreply.github.com> Co-authored-by: samwiseg0 <phillipah@gmail.com>
4 years ago
## How can I share my logs?
docs: organize and edit FAQ (#1336) [skip ci] * docs: organize and edit FAQ * docs: add HAMA to list of supported agents * docs: make suggested changes
4 years ago
1. Locate the current log file at `<your Overseeerr config directory>/logs/overseerr.log`.
docs: Various edits, and addition of UI style guide (#982) [skip ci]
4 years ago
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).