cphipps/jellyseerr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add Nginx Proxy Manager to reverse proxy documentation (#1741) [skip ci]

Browse Source 
* docs: adding npm section reverse-proxy

Adds npm configuration example to the docs for the reverse-proxy page under extending-overseerr.

Adds example image to public/images/docs

* docs: adding npm section reverse-proxy with tcl suggestions

Co-authored-by: TheCatLady <52870424+TheCatLady@users.noreply.github.com>

* Delete npm_example.png

* docs: adding npm section reverse-proxy

Tabulation of nginx services

Co-authored-by: TheCatLady <52870424+TheCatLady@users.noreply.github.com>
This commit is contained in:
HubDuck
2021-06-07 15:03:55 +02:00
committed by GitHub
parent 4368c3aa4f
commit c153c055f1
1 changed files with 36 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
docs/extending-overseerr/reverse-proxy.md
View File

@@ -6,7 +6,10 @@ Base URLs cannot be configured in Overseerr. With this limitation, only subdomai
A Nginx subfolder workaround configuration is provided below, but it is not officially supported. A Nginx subfolder workaround configuration is provided below, but it is not officially supported.
{% endhint %} {% endhint %}
## SWAG ## Nginx
{% tabs %}
{% tab title="SWAG" %}
A sample proxy configuration is included in [SWAG (Secure Web Application Gateway)](https://github.com/linuxserver/docker-swag). A sample proxy configuration is included in [SWAG (Secure Web Application Gateway)](https://github.com/linuxserver/docker-swag).
@@ -39,27 +42,29 @@ server {
} }
``` ```
## Traefik (v2) {% endtab %}
Add the following labels to the Overseerr service in your `docker-compose.yml` file: {% tab title="Nginx Proxy Manager" %}
```text Add a new proxy host with the following settings:
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"
```
For more information, please refer to the [Traefik documentation](https://doc.traefik.io/traefik/user-guides/docker-compose/basic-example/). ### Details
## Nginx - **Domain Names:** Your desired external Overseerr hostname; e.g., `overseerr.example.com`
- **Scheme:** `http`
- **Forward Hostname / IP:** Internal Overseerr hostname or IP
- **Forward Port:** `5055`
- **Cache Assets:** yes
- **Block Common Exploits:** yes
### SSL
- **SSL Certificate:** Select one of the options; if you are not sure, pick “Request a new SSL Certificate”
- **Force SSL:** yes
- **HTTP/2 Support:** yes
{% endtab %}
{% tabs %}
{% tab title="Subdomain" %} {% tab title="Subdomain" %}
Add the following configuration to a new file `/etc/nginx/sites-available/overseerr.example.com.conf`: Add the following configuration to a new file `/etc/nginx/sites-available/overseerr.example.com.conf`:
@@ -148,14 +153,20 @@ location ^~ /overseerr {
{% endtab %} {% endtab %}
{% endtabs %} {% endtabs %}
Next, test the configuration: ## Traefik (v2)
```bash Add the following labels to the Overseerr service in your `docker-compose.yml` file:
sudo nginx -t
```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"
``` ```
Finally, reload `nginx` for the new configuration to take effect: For more information, please refer to the [Traefik documentation](https://doc.traefik.io/traefik/user-guides/docker-compose/basic-example/).
```bash
sudo systemctl reload nginx
```