From 6df0bdec29c998dcf4041acf0694d99b34afcbb1 Mon Sep 17 00:00:00 2001 From: Benjamin Teke Date: Wed, 12 Jan 2022 12:48:51 +0100 Subject: [PATCH 1/2] Add Overseerr. --- README.md | 3 ++- docs/applications/overseerr.md | 12 ++++++++++ docs/configuration/application_ports.md | 1 + nas.yml | 5 ++++ roles/overseerr/defaults/main.yml | 17 +++++++++++++ roles/overseerr/tasks/main.yml | 32 +++++++++++++++++++++++++ 6 files changed, 69 insertions(+), 1 deletion(-) create mode 100644 docs/applications/overseerr.md create mode 100644 roles/overseerr/defaults/main.yml create mode 100644 roles/overseerr/tasks/main.yml diff --git a/README.md b/README.md index 5cf4d8cc..6c637f39 100644 --- a/README.md +++ b/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 diff --git a/docs/applications/overseerr.md b/docs/applications/overseerr.md new file mode 100644 index 00000000..1629f4c6 --- /dev/null +++ b/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//nas.yml` file. + + The overseerr web interface can be found at http://ansible_nas_host_or_ip:5055. \ No newline at end of file diff --git a/docs/configuration/application_ports.md b/docs/configuration/application_ports.md index 95e3e8dd..782a8dd0 100644 --- a/docs/configuration/application_ports.md +++ b/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 | diff --git a/nas.yml b/nas.yml index 92ec1364..0bb31f45 100644 --- a/nas.yml +++ b/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 diff --git a/roles/overseerr/defaults/main.yml b/roles/overseerr/defaults/main.yml new file mode 100644 index 00000000..01bb1c9d --- /dev/null +++ b/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 diff --git a/roles/overseerr/tasks/main.yml b/roles/overseerr/tasks/main.yml new file mode 100644 index 00000000..e6ddaafb --- /dev/null +++ b/roles/overseerr/tasks/main.yml @@ -0,0 +1,32 @@ +--- +- name: Create overseerr Directories + file: + path: "{{ item }}" + state: directory + # mode: 0755 + 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" From b990e529137b68b3dfcb8206cd8e93b89ad7b3e6 Mon Sep 17 00:00:00 2001 From: Benjamin Teke Date: Mon, 27 Jun 2022 22:16:45 +0200 Subject: [PATCH 2/2] Remove commented code. --- roles/overseerr/tasks/main.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/roles/overseerr/tasks/main.yml b/roles/overseerr/tasks/main.yml index e6ddaafb..5ac39776 100644 --- a/roles/overseerr/tasks/main.yml +++ b/roles/overseerr/tasks/main.yml @@ -3,7 +3,6 @@ file: path: "{{ item }}" state: directory - # mode: 0755 with_items: - "{{ overseerr_data_directory }}" - "{{ overseerr_data_directory }}/config"