Merge pull request #542 from brumi1024/add-overseerr

Add Overseerr.

README.md

@@ -62,7 +62,8 @@ If you have a spare domain name you can configure applications to be accessible
 * [Ombi](https://ombi.io/) - web application that automatically gives your users the ability to request content
 * [Organizr](https://organizr.app/) - ORGANIZR aims to be your one stop shop for your Servers Frontend.
 * [openHAB](https://www.openhab.org/) - A vendor and technology agnostic open source automation software for your home
-* [Paperless_ng](https://github.com/jonaswinkler/paperless-ng) - Scan, index and archive all your physical documents 
+* [overseerr](https://docs.overseerr.dev) - open source software application for managing requests for your media library
+* [Paperless_ng](https://github.com/jonaswinkler/paperless-ng) - Scan, index and archive all your physical documents
 * [Piwigo](https://piwigo.org/) - Photo Gallery Software
 * [Plex](https://www.plex.tv/) - Plex Media Server
 * [Portainer](https://portainer.io/) - for managing Docker and running custom images

docs/applications/overseerr.md

@@ -0,0 +1,12 @@
+# overseerr
+
+ Homepage: [https://docs.overseerr.dev](https://docs.overseerr.dev)
+ Docker Container: [https://hub.docker.com/r/sctx/overseerr](https://hub.docker.com/r/sctx/overseerr)
+
+ Overseerr is a free and open source software application for managing requests for your media library. It integrates with your existing services, such as Sonarr, Radarr, and Plex!
+
+ ## Usage
+
+ Using overseerr: Set `overseerr_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+
+ The overseerr web interface can be found at http://ansible_nas_host_or_ip:5055.

docs/configuration/application_ports.md

@@ -68,6 +68,7 @@ By default, applications can be found on the ports listed below.
 | openHAB         | 7778    | Host    | HTTPS          |
 | Organizr        | 10081   | Bridge  | HTTP           |
 | Organizr        | 10444   | Bridge  | HTTPS          |
+| Overseerr       | 5055    | Bridge  | HTTP           |
 | Paperless_ng    | 16922   | Bridge  | HTTP           |
 | Piwigo          | 16923   | Bridge  | HTTP           |
 | Plex            | 32400   | Bridge  | HTTP           |

nas.yml

@@ -233,6 +233,11 @@
         - organizr
       when: (organizr_enabled | default(False))
 
+    - role: overseerr
+      tags:
+        - overseerr
+      when: (overseerr_enabled | default(False))
+
     - role: paperless_ng
       tags:
         - paperless_ng

roles/overseerr/defaults/main.yml

@@ -0,0 +1,17 @@
+---
+overseerr_enabled: false
+overseerr_available_externally: "false"
+
+# directories
+overseerr_data_directory: "{{ docker_home }}/overseerr"
+
+# uid / gid
+overseerr_user_id: "1000"
+overseerr_group_id: "1000"
+
+# network config
+overseerr_webui_port: "5055"
+overseerr_hostname: "overseerr"
+
+# specs
+overseerr_memory: 1g

roles/overseerr/tasks/main.yml

@@ -0,0 +1,31 @@
+---
+- name: Create overseerr Directories
+  file:
+    path: "{{ item }}"
+    state: directory
+  with_items:
+    - "{{ overseerr_data_directory }}"
+    - "{{ overseerr_data_directory }}/config"
+
+- name: Overseerr
+  docker_container:
+    name: overseerr
+    image: sctx/overseerr:latest
+    pull: true
+    volumes:
+      - "{{ overseerr_data_directory }}/config:/app/config:rw"
+    ports:
+      - "{{ overseerr_webui_port }}:5055"
+    env:
+      TZ: "{{ ansible_nas_timezone }}"
+      PUID: "{{ overseerr_user_id }}"
+      PGID: "{{ overseerr_group_id }}"
+    restart_policy: unless-stopped
+    memory: "{{ overseerr_memory }}"
+    labels:
+      traefik.enable: "{{ overseerr_available_externally }}"
+      traefik.http.routers.overseerr.rule: "Host(`{{ overseerr_hostname }}.{{ ansible_nas_domain }}`)"
+      traefik.http.routers.overseerr.tls.certresolver: "letsencrypt"
+      traefik.http.routers.overseerr.tls.domains[0].main: "{{ ansible_nas_domain }}"
+      traefik.http.routers.overseerr.tls.domains[0].sans: "*.{{ ansible_nas_domain }}"
+      traefik.http.services.overseerr.loadbalancer.server.port: "5055"