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>pull/519/head
sct
4 years ago
committed by
GitHub
parent
c034496f55
commit
30ed82e155
@ -0,0 +1,4 @@
|
|||||||
|
# Introduction
|
||||||
|
|
||||||
|
Welcome to the Overseerr Documentation.
|
||||||
|
|
||||||
@ -0,0 +1,17 @@
|
|||||||
|
# Table of contents
|
||||||
|
|
||||||
|
* [Introduction](README.md)
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
* [Installation](getting-started/installation.md)
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
* [Frequently Asked Questions](support/faq.md)
|
||||||
|
* [Asking for Support](support/asking-for-support.md)
|
||||||
|
|
||||||
|
## Extending Overseerr
|
||||||
|
|
||||||
|
* [Reverse Proxy Examples](extending-overseerr/reverse-proxy-examples.md)
|
||||||
|
|
||||||
@ -0,0 +1,135 @@
|
|||||||
|
# Reverse Proxy Examples
|
||||||
|
|
||||||
|
## Note: Base URLs cannot be configured in Overseerr. With this limitation, only subdomain configurations are supported.
|
||||||
|
|
||||||
|
## Reverse Proxies:
|
||||||
|
|
||||||
|
- [LE/SWAG](#leswag)
|
||||||
|
- [Traefik (v2)](#traefik-v2)
|
||||||
|
- [LE/NGINX](#lenginx)
|
||||||
|
|
||||||
|
### LE/SWAG
|
||||||
|
|
||||||
|
#### Subdomain
|
||||||
|
|
||||||
|
Place in the `proxy-confs` folder as `overseerr.subdomain.conf`
|
||||||
|
|
||||||
|
Example Configuration:
|
||||||
|
|
||||||
|
```
|
||||||
|
server {
|
||||||
|
listen 443 ssl http2;
|
||||||
|
listen [::]:443 ssl http2;
|
||||||
|
|
||||||
|
server_name overseerr.*;
|
||||||
|
|
||||||
|
include /config/nginx/ssl.conf;
|
||||||
|
|
||||||
|
client_max_body_size 0;
|
||||||
|
|
||||||
|
location / {
|
||||||
|
|
||||||
|
include /config/nginx/proxy.conf;
|
||||||
|
resolver 127.0.0.11 valid=30s;
|
||||||
|
set $upstream_app overseerr;
|
||||||
|
set $upstream_port 5055;
|
||||||
|
set $upstream_proto http;
|
||||||
|
proxy_pass $upstream_proto://$upstream_app:$upstream_port;
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Traefik (v2)
|
||||||
|
|
||||||
|
Add the labels to the Overseerr service in your `docker-compose` file. A basic example for a `docker-compose` file using Traefik can be found [here](https://doc.traefik.io/traefik/user-guides/docker-compose/basic-example/).
|
||||||
|
|
||||||
|
#### Subdomain
|
||||||
|
|
||||||
|
Example Configuration:
|
||||||
|
|
||||||
|
```
|
||||||
|
labels:
|
||||||
|
- "traefik.enable=true"
|
||||||
|
## HTTP Routers
|
||||||
|
- "traefik.http.routers.overseerr-rtr.entrypoints=https"
|
||||||
|
- "traefik.http.routers.overseerr-rtr.rule=Host(`overseerr.domain.com`)"
|
||||||
|
- "traefik.http.routers.overseerr-rtr.tls=true"
|
||||||
|
## HTTP Services
|
||||||
|
- "traefik.http.routers.overseerr-rtr.service=overseerr-svc"
|
||||||
|
- "traefik.http.services.overseerr-svc.loadbalancer.server.port=5055"
|
||||||
|
```
|
||||||
|
|
||||||
|
### LE/NGINX
|
||||||
|
|
||||||
|
#### Subdomain
|
||||||
|
|
||||||
|
Take the configuration below and place it in `/etc/nginx/sites-available/overseerr.example.com.conf`.
|
||||||
|
|
||||||
|
Create a symlink to `/etc/nginx/sites-enabled`:
|
||||||
|
|
||||||
|
```
|
||||||
|
sudo ln -s /etc/nginx/sites-available/overseerr.example.com.conf /etc/nginx/sites-enabled/overseerr.example.com.conf
|
||||||
|
```
|
||||||
|
|
||||||
|
Test the configuration:
|
||||||
|
|
||||||
|
```
|
||||||
|
sudo nginx -t
|
||||||
|
```
|
||||||
|
|
||||||
|
Reload your configuration for NGINX:
|
||||||
|
|
||||||
|
```
|
||||||
|
sudo systemctl reload nginx
|
||||||
|
```
|
||||||
|
|
||||||
|
Example Configuration:
|
||||||
|
|
||||||
|
```
|
||||||
|
server {
|
||||||
|
listen 80;
|
||||||
|
server_name overseerr.example.com;
|
||||||
|
return 301 https://$server_name$request_uri;
|
||||||
|
}
|
||||||
|
|
||||||
|
server {
|
||||||
|
listen 443 ssl http2;
|
||||||
|
server_name overseerr.example.com;
|
||||||
|
|
||||||
|
ssl_certificate /etc/letsencrypt/live/overseerr.example.com/fullchain.pem;
|
||||||
|
ssl_certificate_key /etc/letsencrypt/live/overseerr.example.com/privkey.pem;
|
||||||
|
|
||||||
|
proxy_set_header Referer $http_referer;
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
proxy_set_header X-Real-Port $remote_port;
|
||||||
|
proxy_set_header X-Forwarded-Host $host:$remote_port;
|
||||||
|
proxy_set_header X-Forwarded-Server $host;
|
||||||
|
proxy_set_header X-Forwarded-Port $remote_port;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
proxy_set_header X-Forwarded-Ssl on;
|
||||||
|
real_ip_header CF-Connecting-IP;
|
||||||
|
# Control the behavior of the Referer header (Referrer-Policy)
|
||||||
|
add_header Referrer-Policy "no-referrer";
|
||||||
|
# HTTP Strict Transport Security
|
||||||
|
add_header Strict-Transport-Security "max-age=63072000; includeSubDomains" always;
|
||||||
|
# Reduce XSS risks (Content-Security-Policy)
|
||||||
|
add_header Content-Security-Policy "default-src 'self'; connect-src 'self' https://plex.tv; style-src 'self' 'unsafe-inline' https://rsms.me/inter/inter.css; script-src 'self'; img-src 'self' data: https://plex.tv https://assets.plex.tv https://secure.gravatar.com https://i2.wp.com https://image.tmdb.org; font-src 'self' https://rsms.me/inter/font-files/" always;
|
||||||
|
# Prevent some categories of XSS attacks (X-XSS-Protection)
|
||||||
|
add_header X-XSS-Protection "1; mode=block" always;
|
||||||
|
# Provide clickjacking protection (X-Frame-Options)
|
||||||
|
add_header X-Frame-Options "SAMEORIGIN" always;
|
||||||
|
# Prevent Sniff Mimetype (X-Content-Type-Options)
|
||||||
|
add_header X-Content-Type-Options "nosniff" always;
|
||||||
|
|
||||||
|
access_log /var/log/nginx/overseerr.example.com-access.log;
|
||||||
|
error_log /var/log/nginx/overseerr.example.com-error.log;
|
||||||
|
|
||||||
|
location / {
|
||||||
|
proxy_pass http://127.0.0.1:5055;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
@ -0,0 +1,132 @@
|
|||||||
|
# Reverse Proxy Examples
|
||||||
|
|
||||||
|
{% hint style="warning" %}
|
||||||
|
Base URLs cannot be configured in Overseerr. With this limitation, only subdomain configurations are supported.Base URLs cannot be configured in Overseerr. With this limitation, only subdomain configurations are supported.
|
||||||
|
{% endhint %}
|
||||||
|
|
||||||
|
## LE/SWAG
|
||||||
|
|
||||||
|
### Subdomain
|
||||||
|
|
||||||
|
Place in the `proxy-confs` folder as `overseerr.subdomain.conf`
|
||||||
|
|
||||||
|
Example Configuration:
|
||||||
|
|
||||||
|
```text
|
||||||
|
server {
|
||||||
|
listen 443 ssl http2;
|
||||||
|
listen [::]:443 ssl http2;
|
||||||
|
|
||||||
|
server_name overseerr.*;
|
||||||
|
|
||||||
|
include /config/nginx/ssl.conf;
|
||||||
|
|
||||||
|
client_max_body_size 0;
|
||||||
|
|
||||||
|
location / {
|
||||||
|
|
||||||
|
include /config/nginx/proxy.conf;
|
||||||
|
resolver 127.0.0.11 valid=30s;
|
||||||
|
set $upstream_app overseerr;
|
||||||
|
set $upstream_port 5055;
|
||||||
|
set $upstream_proto http;
|
||||||
|
proxy_pass $upstream_proto://$upstream_app:$upstream_port;
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Traefik \(v2\)
|
||||||
|
|
||||||
|
Add the labels to the Overseerr service in your `docker-compose` file. A basic example for a `docker-compose` file using Traefik can be found [here](https://doc.traefik.io/traefik/user-guides/docker-compose/basic-example/).
|
||||||
|
|
||||||
|
### Subdomain
|
||||||
|
|
||||||
|
Example Configuration:
|
||||||
|
|
||||||
|
```text
|
||||||
|
labels:
|
||||||
|
- "traefik.enable=true"
|
||||||
|
## HTTP Routers
|
||||||
|
- "traefik.http.routers.overseerr-rtr.entrypoints=https"
|
||||||
|
- "traefik.http.routers.overseerr-rtr.rule=Host(`overseerr.domain.com`)"
|
||||||
|
- "traefik.http.routers.overseerr-rtr.tls=true"
|
||||||
|
## HTTP Services
|
||||||
|
- "traefik.http.routers.overseerr-rtr.service=overseerr-svc"
|
||||||
|
- "traefik.http.services.overseerr-svc.loadbalancer.server.port=5055"
|
||||||
|
```
|
||||||
|
|
||||||
|
## LE/NGINX
|
||||||
|
|
||||||
|
### Subdomain
|
||||||
|
|
||||||
|
Take the configuration below and place it in `/etc/nginx/sites-available/overseerr.example.com.conf`.
|
||||||
|
|
||||||
|
Create a symlink to `/etc/nginx/sites-enabled`:
|
||||||
|
|
||||||
|
```text
|
||||||
|
sudo ln -s /etc/nginx/sites-available/overseerr.example.com.conf /etc/nginx/sites-enabled/overseerr.example.com.conf
|
||||||
|
```
|
||||||
|
|
||||||
|
Test the configuration:
|
||||||
|
|
||||||
|
```text
|
||||||
|
sudo nginx -t
|
||||||
|
```
|
||||||
|
|
||||||
|
Reload your configuration for NGINX:
|
||||||
|
|
||||||
|
```text
|
||||||
|
sudo systemctl reload nginx
|
||||||
|
```
|
||||||
|
|
||||||
|
Example Configuration:
|
||||||
|
|
||||||
|
```text
|
||||||
|
server {
|
||||||
|
listen 80;
|
||||||
|
server_name overseerr.example.com;
|
||||||
|
return 301 https://$server_name$request_uri;
|
||||||
|
}
|
||||||
|
|
||||||
|
server {
|
||||||
|
listen 443 ssl http2;
|
||||||
|
server_name overseerr.example.com;
|
||||||
|
|
||||||
|
ssl_certificate /etc/letsencrypt/live/overseerr.example.com/fullchain.pem;
|
||||||
|
ssl_certificate_key /etc/letsencrypt/live/overseerr.example.com/privkey.pem;
|
||||||
|
|
||||||
|
proxy_set_header Referer $http_referer;
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
proxy_set_header X-Real-Port $remote_port;
|
||||||
|
proxy_set_header X-Forwarded-Host $host:$remote_port;
|
||||||
|
proxy_set_header X-Forwarded-Server $host;
|
||||||
|
proxy_set_header X-Forwarded-Port $remote_port;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
proxy_set_header X-Forwarded-Ssl on;
|
||||||
|
real_ip_header CF-Connecting-IP;
|
||||||
|
# Control the behavior of the Referer header (Referrer-Policy)
|
||||||
|
add_header Referrer-Policy "no-referrer";
|
||||||
|
# HTTP Strict Transport Security
|
||||||
|
add_header Strict-Transport-Security "max-age=63072000; includeSubDomains" always;
|
||||||
|
# Reduce XSS risks (Content-Security-Policy)
|
||||||
|
add_header Content-Security-Policy "default-src 'self'; connect-src 'self' https://plex.tv; style-src 'self' 'unsafe-inline' https://rsms.me/inter/inter.css; script-src 'self'; img-src 'self' data: https://plex.tv https://assets.plex.tv https://secure.gravatar.com https://i2.wp.com https://image.tmdb.org; font-src 'self' https://rsms.me/inter/font-files/" always;
|
||||||
|
# Prevent some categories of XSS attacks (X-XSS-Protection)
|
||||||
|
add_header X-XSS-Protection "1; mode=block" always;
|
||||||
|
# Provide clickjacking protection (X-Frame-Options)
|
||||||
|
add_header X-Frame-Options "SAMEORIGIN" always;
|
||||||
|
# Prevent Sniff Mimetype (X-Content-Type-Options)
|
||||||
|
add_header X-Content-Type-Options "nosniff" always;
|
||||||
|
|
||||||
|
access_log /var/log/nginx/overseerr.example.com-access.log;
|
||||||
|
error_log /var/log/nginx/overseerr.example.com-error.log;
|
||||||
|
|
||||||
|
location / {
|
||||||
|
proxy_pass http://127.0.0.1:5055;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
@ -0,0 +1,93 @@
|
|||||||
|
# Installation
|
||||||
|
|
||||||
|
{% hint style="danger" %}
|
||||||
|
Overseerr is currently under very heavy, rapid development and things are likely to break often. We need all the help we can get to find bugs and get them fixed to hit a more stable release. If you would like to help test the bleeding edge, please use the image **`sctx/overseerr:develop`** instead!
|
||||||
|
{% endhint %}
|
||||||
|
|
||||||
|
{% hint style="info" %}
|
||||||
|
After running Overseerr for the first time, configure it by visiting the web UI at `http://[address]:5055` and completing the setup steps.
|
||||||
|
{% endhint %}
|
||||||
|
|
||||||
|
## Docker
|
||||||
|
|
||||||
|
{% tabs %}
|
||||||
|
{% tab title="Basic" %}
|
||||||
|
```bash
|
||||||
|
docker run -d \
|
||||||
|
-e LOG_LEVEL=info \
|
||||||
|
-e TZ=Asia/Tokyo \
|
||||||
|
-p 5055:5055 \
|
||||||
|
-v /path/to/appdata/config:/app/config \
|
||||||
|
--restart unless-stopped \
|
||||||
|
sctx/overseerr
|
||||||
|
```
|
||||||
|
{% endtab %}
|
||||||
|
|
||||||
|
{% tab title="UID/GID" %}
|
||||||
|
```
|
||||||
|
docker run -d \
|
||||||
|
--user=[ user | user:group | uid | uid:gid | user:gid | uid:group ] \
|
||||||
|
-e LOG_LEVEL=info \
|
||||||
|
-e TZ=Asia/Tokyo \
|
||||||
|
-p 5055:5055 \
|
||||||
|
-v /path/to/appdata/config:/app/config \
|
||||||
|
--restart unless-stopped \
|
||||||
|
sctx/overseerr
|
||||||
|
```
|
||||||
|
{% endtab %}
|
||||||
|
|
||||||
|
{% tab title="Manual Update" %}
|
||||||
|
```
|
||||||
|
# Stop the Overseerr container
|
||||||
|
docker stop overseerr
|
||||||
|
|
||||||
|
# Remove the Overseerr container
|
||||||
|
docker rm overseerr
|
||||||
|
|
||||||
|
# Pull the latest update
|
||||||
|
docker pull sctx/overseerr
|
||||||
|
|
||||||
|
# Run the Overseerr container with the same parameters as before
|
||||||
|
docker run -d ...
|
||||||
|
```
|
||||||
|
{% endtab %}
|
||||||
|
{% endtabs %}
|
||||||
|
|
||||||
|
{% hint style="info" %}
|
||||||
|
Use a 3rd party updating mechanism such as [Watchtower](https://github.com/containrrr/watchtower) or [Ouroboros](https://github.com/pyouroboros/ouroboros) to keep Overseerr up-to-date automatically.
|
||||||
|
{% endhint %}
|
||||||
|
|
||||||
|
## Unraid
|
||||||
|
|
||||||
|
1. Ensure you have the **Community Applications** plugin installed.
|
||||||
|
2. Inside the **Communtiy Applications** app store, search for **Overseerr**.
|
||||||
|
3. Click the **Install Button**.
|
||||||
|
4. On the following **Add Container** screen, make changes to the **Host Port** and **Host Path 1**\(Appdata\) as needed.
|
||||||
|
5. Click apply and access "Overseerr" at your `<ServerIP:HostPort>` in a web browser.
|
||||||
|
|
||||||
|
## Windows
|
||||||
|
|
||||||
|
Please refer to the [docker for windows documentation](https://docs.docker.com/docker-for-windows/) for installation.
|
||||||
|
|
||||||
|
{% hint style="danger" %}
|
||||||
|
**WSL2 will need to be installed to prevent DB corruption! Please see** [**Docker Desktop WSL 2 backend**](https://docs.docker.com/docker-for-windows/wsl/) **on how to enable WSL2. The command below will only work with WSL2 installed! Details below.**
|
||||||
|
{% endhint %}
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker run -d -e LOG_LEVEL=info -e TZ=Asia/Tokyo -p 5055:5055 -v "/your/path/here:/app/config" --restart unless-stopped sctx/overseerr
|
||||||
|
```
|
||||||
|
|
||||||
|
{% hint style="info" %}
|
||||||
|
Docker on Windows works differently than it does on Linux; it uses a VM to run a stripped-down Linux and then runs docker within that. The volume mounts are exposed to the docker in this VM via SMB mounts. While this is fine for media, it is unacceptable for the `/app/config` directory because SMB does not support file locking. This will eventually corrupt your database which can lead to slow behavior and crashes. If you must run in docker on Windows, you should put the `/app/config` directory mount inside the VM and not on the Windows host. It's worth noting that this warning also extends to other containers which use SQLite databases.
|
||||||
|
{% endhint %}
|
||||||
|
|
||||||
|
## ArchLinux \(Third party\)
|
||||||
|
|
||||||
|
Built from tag \(master\): [https://aur.archlinux.org/packages/overseerr/](https://aur.archlinux.org/packages/overseerr/)
|
||||||
|
Built from latest \(develop\): [aur.archlinux.org/packages/overseerr-git](https://aur.archlinux.org/packages/overseerr-git/)
|
||||||
|
**To install these just use your favorite AUR package manager:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yay -S overseer
|
||||||
|
```
|
||||||
|
|
||||||
@ -0,0 +1,34 @@
|
|||||||
|
# Asking for Support
|
||||||
|
|
||||||
|
## Before asking for support, make sure you try these things first
|
||||||
|
|
||||||
|
* Make sure you have **updated** to the latest version.
|
||||||
|
* ["Have you tried turning it off and on again?"](https://www.youtube.com/watch?v=nn2FB1P_Mn8)
|
||||||
|
* **Analyzing** your logs, you just might find the solution yourself!
|
||||||
|
* **Search** the [Wiki](../), [Installation Guides](../getting-started/installation.md), and [FAQs](faq.md).
|
||||||
|
* If you have questions, feel free to ask them on [Discord](https://discord.gg/PkCWJSeCk7) \(Please review our [Code of Conduct](https://github.com/sct/overseerr/blob/develop/CODE_OF_CONDUCT.md)\). Please include a link to your logs. See [How can I share my logs?](asking-for-support.md#how-can-i-share-my-logs) for more details.
|
||||||
|
|
||||||
|
## What should I include when asking for support?
|
||||||
|
|
||||||
|
When you contact support saying something like "it doesn't work" leaves little to go on to figure out what is wrong for you. When contacting support try to include information such as the following:
|
||||||
|
|
||||||
|
* What did you try to do? When you describe what you did to reach the state you are in we may notice something you did different from the instructions, or something that your unique setup requires in addition. Some examples of what to provide here:
|
||||||
|
* What command did you enter?
|
||||||
|
* What did you click on?
|
||||||
|
* What settings did you change?
|
||||||
|
* Provide a step-by-step list of what you tried.
|
||||||
|
* What do you see? We cannot see your screen so some of the following is necessary for us to know what is going on:
|
||||||
|
* Did something happen?
|
||||||
|
* Did something not happen?
|
||||||
|
* Are there any error messages showing?
|
||||||
|
* Screenshots can help us see what you are seeing
|
||||||
|
* The Overseerr logs 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?
|
||||||
|
|
||||||
|
First you will need to gather your logs from the install directory.
|
||||||
|
|
||||||
|
1. Collect the log file from `<Overseeerr-install-directory>/logs/overseerr.log`
|
||||||
|
2. Open the log file and **upload the text** by going to [gist.github.com](https://gist.github.com/) and creating a new secret Gist of the contents.
|
||||||
|
3. **Share the link** with support in [Discord](https://discord.gg/PkCWJSeCk7) by copying the URL of the page.
|
||||||
|
|
||||||
@ -0,0 +1,96 @@
|
|||||||
|
# Frequently Asked Questions
|
||||||
|
|
||||||
|
{% hint style="info" %}
|
||||||
|
If you can't find a solution here, please ask on [Discord](https://discord.gg/PkCWJSeCk7). Please do not post questions on the GitHub issues tracker.
|
||||||
|
{% endhint %}
|
||||||
|
|
||||||
|
## General
|
||||||
|
|
||||||
|
### I receive 409 or 400 errors when requesting a movie or tv show!
|
||||||
|
|
||||||
|
**A:** Verify your are running radarr and sonarr v3. Overseerr was developed for v3 and is not currently backward compatible.
|
||||||
|
|
||||||
|
### How do I keep Overseerr up-to-date?
|
||||||
|
|
||||||
|
**A:** Use a 3rd party updating mechanism such as [Watchtower](https://github.com/containrrr/watchtower) or [Ouroboros](https://github.com/pyouroboros/ouroboros) to keep Overseerr up-to-date automatically.
|
||||||
|
|
||||||
|
### How can I access Overseerr outside my home network?
|
||||||
|
|
||||||
|
**A:** The easy and least secure method is to forward an external port \(`5055`\) on your router to the internal port used by Overseerr \(default is TCP `5055`\). Visit [Port Forward](http://portforward.com/) for instructions for your particular router. You will then be able to access Overseerr via `http://EXTERNAL-IP-ADDRESS:5055`.
|
||||||
|
|
||||||
|
The more advanced and most preferred method \(and more secure if you use SSL\) is to set up a web server with NGINX/Apache, and use a reverse proxy to access Overseerr. You can lookup many guides on the internet to find out how to do this. There are several reverse proxy config examples located [here](../extending-overseerr/reverse-proxy-examples.md).
|
||||||
|
|
||||||
|
The most secure method, but also the most inconvenient, is to set up a VPN tunnel to your home server, then you can access Overseerr as if it is on a local network via `http://LOCAL-IP-ADDRESS:5055`.
|
||||||
|
|
||||||
|
### Overseerr is amazing! But it is not translated in my language yet! Can I help with translations?
|
||||||
|
|
||||||
|
**A:** You sure can! We are using Weblate for translations! Check it out [here](https://hosted.weblate.org/engage/overseerr/). If your language is not listed please open an [enhancement request in issues](https://github.com/sct/overseerr/issues/new/choose).
|
||||||
|
|
||||||
|
### Where can I find the changelog?
|
||||||
|
|
||||||
|
**A:** You can find the changelog in the **Settings -> About** page in your instance. You can also find it on github [here](https://github.com/sct/overseerr/releases).
|
||||||
|
|
||||||
|
### Can I make 4K requests?
|
||||||
|
|
||||||
|
**A:** 4K requests are not supported just yet but they will be supported in the future!
|
||||||
|
|
||||||
|
### Some media is missing from Overseerr that I know is in Plex!
|
||||||
|
|
||||||
|
**A:** Overseerr supports the new Plex Movie, Legacy Plex Movie, TheTVDB agent, and the TMDb agent. Please verify that your library is using one of the agents previously listed. If you are changing agents, a full metadata refresh will need to be performed. Caution, this can take a long time depending on how many items you have in your movie library.
|
||||||
|
|
||||||
|
**Troubleshooting Steps:**
|
||||||
|
|
||||||
|
Check the Overseerr logs for media items that are missing. The logs will contain an error as to why that item could not be matched. One example might be `errorMessage":"SQLITE_CONSTRAINT: NOT NULL`. This means that the TMDb ID is missing from the Plex XML for that item.
|
||||||
|
|
||||||
|
1. Verify that you are using one of the agents mentioned above.
|
||||||
|
2. Refresh the metadata for just that item.
|
||||||
|
3. Run a full scan in Overseerr to see if that item is now matched properly.
|
||||||
|
4. If the item is now seen by Overseerr then repeat step 2 for each missing item. If you have a large amount of items missing then a full metadata refresh is recommended for that library.
|
||||||
|
5. Run a full scan on Overseerr after refreshing all unmatched items.
|
||||||
|
|
||||||
|
Perform these steps to verify the media item has a guid Overseerr can match.
|
||||||
|
|
||||||
|
1. Go to the media item in Plex and **"Get info"** and click on **"View XML"**.
|
||||||
|
2. Verify that the media item has the same format of one of the examples below.
|
||||||
|
|
||||||
|
**Examples:**
|
||||||
|
|
||||||
|
1. TMDB agent `guid="com.plexapp.agents.themoviedb://1705"`
|
||||||
|
2. The new Plex Movie agent `<Guid id="tmdb://464052"/>`
|
||||||
|
3. TheTVDB agent `guid="com.plexapp.agents.thetvdb://78874/1/1"`
|
||||||
|
4. Legacy Plex Movie agent `guid="com.plexapp.agents.imdb://tt0765446"`
|
||||||
|
|
||||||
|
### Where can I find the logs?
|
||||||
|
|
||||||
|
**A:** The logs are located at `<Overseeerr-install-directory>/logs/overseerr.log`
|
||||||
|
|
||||||
|
## User Management
|
||||||
|
|
||||||
|
### Why can't I see all my Plex users?
|
||||||
|
|
||||||
|
**A:** Navigate to your **User List** in Overseerr and click **Import Users From Plex** button.
|
||||||
|
|
||||||
|
### Can I create local users in Overseerr?
|
||||||
|
|
||||||
|
**A:** Not at this time. But it is a planned feature!
|
||||||
|
|
||||||
|
### Is is possible to set user roles in Overseerr?
|
||||||
|
|
||||||
|
**A:** Unfortunately, this is not possible yet. It is planned!
|
||||||
|
|
||||||
|
## Requests
|
||||||
|
|
||||||
|
### I approved a requested movie and radarr didn't search for it!
|
||||||
|
|
||||||
|
**A:** Check your minimum availability in radarr. If an added item does not meet the minimum availability, no search will be performed. Also verify that radarr did not search for it by checking the radarr logs. Lastly, verify the item was not already being monitored by radarr. Currently there is no state sync with radarr.
|
||||||
|
|
||||||
|
### Help! My request still shows "requested" even though it's in Plex!?!
|
||||||
|
|
||||||
|
**A:** See "[Some media is missing from Overseerr that I know is in Plex!](https://docs.overseerr.dev/v/docs/support/faq#some-media-is-missing-from-overseerr-that-i-know-is-in-plex)" for troubleshooting steps.
|
||||||
|
|
||||||
|
## Notifications
|
||||||
|
|
||||||
|
### I am getting "Username and Password not accepted" when sending email notifications to gmail!
|
||||||
|
|
||||||
|
**A:** If you have 2-Step Verification enabled on your account you will need to create an app password. More details can be found [here](https://support.google.com/mail/answer/185833).
|
||||||
|
|
||||||
Loading…
Reference in new issue