-
-
Notifications
You must be signed in to change notification settings - Fork 455
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #570 from sct/release/release-20210104
Release
- Loading branch information
Showing
84 changed files
with
2,179 additions
and
455 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| root: ./docs | ||
|
|
||
| structure: | ||
| readme: README.md | ||
| summary: SUMMARY.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # Introduction | ||
|
|
||
| Welcome to the Overseerr Documentation. | ||
|
|
||
| ## Features | ||
|
|
||
| - **Full Plex integration**. Login and manage user access with Plex. | ||
| - **Syncs to your Plex library** to show what titles you already have. | ||
| - **Integrates with Sonarr and Radarr**. With more services to come in the future. | ||
| - **Easy to use request system** allowing users to request individual seasons or movies in a friendly, clean UI. | ||
| - **Simple request management UI**. Don't dig through the app to approve recent requests. | ||
| - **Mobile-friendly design**, for when you need to approve requests on the go. | ||
| - Granular permission system. | ||
| - Localization into other languages. | ||
|
|
||
| ## Motivation | ||
|
|
||
| The primary motivation for starting this project was to have an incredibly performant and easy to use application. There is a heavy focus on the user experience for both the server owner and the users. We feel requesting should be **effortless for the user**. Find the media you want, click request, and branch off efficiently into other titles that interest you, all in one seamless flow. For the server owner, Overseerr takes all the hassle out of approving your users' requests. | ||
|
|
||
| ## We need your help! | ||
|
|
||
| Overseerr is an ambitious project. We have already poured a lot of work into this, with more coming. We need your valuable feedback and help with finding bugs. Also, being that this is an open-source project, anyone is welcome to contribute. Contribution includes building features, patching bugs, or even translating the application. You can find the contribution guide on our GitHub. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
| {% 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; | ||
| } | ||
| } | ||
| ``` | ||
|
|
Oops, something went wrong.