chore(release): 1.2.0

.ansible-lint

@@ -0,0 +1,13 @@
+skip_list:
+  - 'yaml'
+  - 'risky-shell-pipe'
+  - 'role-name'
+  - 'no-handler'
+
+kinds:
+  - meta: "**/meta/main.yml"
+  - tasks: "**/tasks/*.yml"
+  - vars: "**/vars/*.yml"
+
+exclude_paths:
+  - "**/requirements.yml"

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: equinoxel
+patreon: laurivan

.travis.yml

@@ -9,7 +9,7 @@ sudo: false
 addons:
   apt:
     packages:
-    - python-pip
+      - python-pip
 
 install:
   # Install ansible
@@ -26,4 +26,4 @@ script:
   - ansible-playbook tests/test.yml -i tests/inventory --syntax-check
 
 notifications:
-  webhooks: https://galaxy.ansible.com/api/v1/notifications/
+  webhooks: https://galaxy.ansible.com/api/v1/notifications/

CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+## [1.2.0](https://git.laurivan.com/Dev/ansible-role-arrs/compare/v1.1.0...v1.2.0) (2024-01-26)
+
+
+### Features
+
+* Add FlareSolverr docker ([eded032](https://git.laurivan.com/Dev/ansible-role-arrs/commit/eded03224311a2cdc8c68dd2655d1bd42674faad))
+
+## [1.1.0](https://git.laurivan.com/Dev/ansible-role-arrs/compare/v1.0.1...v1.1.0) (2024-01-26)
+
+
+### Features
+
+* Pull new images on running the role. ([d7397e0](https://git.laurivan.com/Dev/ansible-role-arrs/commit/d7397e00b016cab0a154ef00b4573ab7637ccd4d))
+
+### 1.0.1 (2022-12-12)

README.md

@@ -32,6 +32,7 @@ If you need to install the containers with a specific user/group ID, then define
 arrs_uid:
 arrs_gid:
 ```
+
 The role allows oyu to specify which components will be installed:
 
 ```yml
@@ -71,6 +72,7 @@ You can specify the image version and the port exposed:
 radarr_image_version: 'latest'
 radarr_host_port: 7878
 ```
+
 You can also overwrite the location where radarr's configuration is stored (e.g. if you already have it installed and you want to use the Ansible role):
 
 ```yml
@@ -96,6 +98,7 @@ You can specify the image version and the port exposed:
 sonarr_image_version: 'latest'
 sonarr_host_port: 8989
 ```
+
 You can also overwrite the location where sonarr's configuration is stored (e.g. if you already have it installed and you want to use the Ansible role):
 
 ```yml
@@ -113,7 +116,7 @@ sonarr_series_volume: '/mnt/videos/Series'
 - Depending on your settings, it will also rename your current series
 - You need write access to that directory, so Sonarr can actually copy the files
 
-# Lidarr
+### Lidarr
 
 You can specify the image version and the port exposed:
 
@@ -121,11 +124,13 @@ You can specify the image version and the port exposed:
 lidarr_image_version: 'latest'
 lidarr_host_port: 8686
 ```
+
 You can also overwrite the location where lidarr's configuration is stored (e.g. if you already have it installed and you want to use the Ansible role):
 
 ```yml
 lidarr_config_volume: '{{ arrs_configuration_volume }}/lidarr'
 ```
+
 Lidarr needs a place to copy the downloaded music:
 
 ```yml
@@ -143,7 +148,8 @@ lidarr_music_volumes:
 
 The `path` is the actual directory where the collection is located and the `alias` is the internal mapping name in Docker.
 
-# Jakett
+### Jakett
+
 You can specify the image version, the port exposed and to autoupdate:
 
 ```yml
@@ -151,6 +157,7 @@ jackett_image_version: 'latest'
 jackett_auto_update: true
 jackett_host_port: 9117
 ```
+
 You can also overwrite the location where jackett's configuration is stored (e.g. if you already have it installed and you want to use the Ansible role):
 
 ```yml
@@ -173,6 +180,6 @@ You need a machine with docker and docker-compose installed.
 
 MIT
 
-##  Author Information
+## Author Information
 
 This role was created in 2022 by [Laur Ivan](https://www.laurivan.com).

defaults/main.yml

@@ -10,10 +10,10 @@ arrs_setup_path: '~/arrs'
 arrs_uid:
 arrs_gid:
 
-deluge_enabled: true 
-radarr_enabled: true 
-sonarr_enabled: true 
-lidarr_enabled: true 
+deluge_enabled: true
+radarr_enabled: true
+sonarr_enabled: true
+lidarr_enabled: true
 jackett_enabled: true
 
 # Deluge torrent
@@ -32,7 +32,11 @@ radarr_image_version: 'latest'
 radarr_host_port: 7878
 
 radarr_config_volume: '{{ arrs_configuration_volume }}/radarr'
-radarr_series_volume: '/mnt/videos/Movies'
+radarr_upload_volume: '/mnt/videos/Movies'
+radarr_library_volumes:
+  - {path: '/mnt/video/Gold', alias: 'gold'}
+  - {path: '/mnt/video/Current', alias: 'current'}
+  - {path: '/mnt/video/Temporary', alias: 'temporary'}
 
 # Sonarr
 #
@@ -40,21 +44,32 @@ sonarr_image_version: 'latest'
 sonarr_host_port: 8989
 
 sonarr_config_volume: '{{ arrs_configuration_volume }}/sonarr'
-sonarr_series_volume: '/mnt/videos/Series'
+sonarr_upload_volume: '/mnt/videos/Series'
+sonarr_library_volumes:
+  - {path: '/mnt/tv/Series', alias: 'series'}
+  - {path: '/mnt/tv/Animation', alias: 'animation'}
+  - {path: '/mnt/tv/SciFi', alias: 'scifi'}
 
 # Lidarr
 lidarr_image_version: 'latest'
 lidarr_host_port: 8686
 
 lidarr_config_volume: '{{ arrs_configuration_volume }}/lidarr'
-lidarr_music_upload_volume: '/mnt/music/Reference'
-lidarr_music_volumes: 
-  - {path: '/mnt/music/Sonos', alias: 'sonos' }
-  - {path: '/mnt/music/Audiophile', alias: 'audiophile' }
-  - {path: '/mnt/music/Raw', alias: 'raw' }
+lidarr_upload_volume: '/mnt/music/Reference'
+lidarr_library_volumes:
+  - {path: '/mnt/music/Sonos', alias: 'sonos'}
+  - {path: '/mnt/music/Audiophile', alias: 'audiophile'}
+  - {path: '/mnt/music/Raw', alias: 'raw'}
 
 # Jakett
 jackett_image_version: 'latest'
 jackett_auto_update: true
 jackett_host_port: 9117
 jackett_config_volume: '{{ arrs_configuration_volume }}/jackett'
+
+# FlareSolverr
+flaresolverr_log_level: info
+flaresolverr_log_html: "false"
+flaresolverr_captcha_solver: none
+flaresolverr_timezone: 'Europe/Brussels'
+flaresolverr_host_port: 8191

handlers/main.yml

@@ -1,2 +1,2 @@
 ---
-# handlers file for arrs
+# handlers file for arrs

meta/main.yml

@@ -1,3 +1,4 @@
+---
 galaxy_info:
   author: Laur Ivan
   namespace: laurivan
@@ -25,7 +26,7 @@ galaxy_info:
       versions:
         - all
 
-  galaxy_tags: 
+  galaxy_tags:
     - sonarr
     - lidarr
     - deluge

molecule/default/cleanup.yml

@@ -15,7 +15,7 @@
         state: absent
       when: docker_compose_file.stat.exists
       become: false
-      
+
     - name: Remove the docker-compose file
       ansible.builtin.file:
         path: "~/arrs/docker-compose.yml"

molecule/default/converge.yml

@@ -6,7 +6,6 @@
     - name: "Include necessary variables"
       ansible.builtin.include_vars:
         file: "../../.env.yml"
-      
+
   roles:
     - role: laurivan.arrs
-

molecule/default/molecule.yml

@@ -27,4 +27,4 @@ verifier:
 lint: |
   set -e
   yamllint .
-  ansible-lint .
+  ansible-lint .

molecule/default/prepare.yml

@@ -8,28 +8,31 @@
       register: docker_sock_stat
 
     - name: Create docker.sock
-      raw: touch /var/run/docker.sock
+      ansible.builtin.raw: touch /var/run/docker.sock
       become: true
       changed_when: false
       when: not docker_sock_stat.stat.exists
 
     - name: Move docker.sock from tmp
-      raw: mount --move /tmp/docker_mounted.sock /var/run/docker.sock
+      ansible.builtin.raw: >
+        mount --move /tmp/docker_mounted.sock /var/run/docker.sock
       become: true
       changed_when: false
       when: not docker_sock_stat.stat.exists
-      
+
     - name: Update apt cache.
-      apt: update_cache=yes cache_valid_time=600
+      ansible.builtin.apt: update_cache=yes cache_valid_time=600
       when: ansible_os_family == 'Debian'
+
     - name: Install python requests
-      pip:
-        name: 
+      ansible.builtin.pip:
+        name:
           - requests
           - docker
           - docker-compose
+
     - name: Install docker
       vars:
         docker_service_manage: false
-      include_role:
+      ansible.builtin.include_role:
         name: geerlingguy.docker

tasks/main.yml

@@ -1,6 +1,6 @@
 ---
 # tasks file for arrs
-- name: Set up directories
+- name: Set up main directory
   ansible.builtin.file:
     state: directory
     path: "{{ item }}"
@@ -12,13 +12,13 @@
   tags:
     - configuration
   become: true
-- name: Set up directories
 
+- name: Set up config directories
   ansible.builtin.file:
     state: directory
     path: "{{ item }}"
-    owner: "{% if arrs_uid %}{{ arrs_uid }}{% else %}{{ ansible_effective_user_id }}{%endif%}"
-    group: "{% if arrs_gid %}{{ arrs_gid }}{% else %}{{ ansible_effective_group_id }}{%endif%}"
+    owner: "{% if arrs_uid %}{{ arrs_uid }}{% else %}{{ ansible_effective_user_id }}{% endif %}"
+    group: "{% if arrs_gid %}{{ arrs_gid }}{% else %}{{ ansible_effective_group_id }}{% endif %}"
     mode: "0750"
   with_items:
     - "{{ deluge_config_volume }}"
@@ -30,6 +30,21 @@
     - configuration
   become: true
 
+- name: Set up upload directories
+  ansible.builtin.file:
+    state: directory
+    path: "{{ item }}"
+    owner: "{% if arrs_uid %}{{ arrs_uid }}{% else %}{{ ansible_effective_user_id }}{% endif %}"
+    group: "{% if arrs_gid %}{{ arrs_gid }}{% else %}{{ ansible_effective_group_id }}{% endif %}"
+    mode: "0750"
+  with_items:
+    - "{{ radarr_upload_volume }}"
+    - "{{ sonarr_upload_volume }}"
+    - "{{ lidarr_upload_volume }}"
+  tags:
+    - configuration
+  become: true
+
 - name: Write configuration files
   ansible.builtin.template:
     src: "{{ item }}.j2"
@@ -42,6 +57,7 @@
     - "env.sonarr.conf"
     - "env.lidarr.conf"
     - "env.jackett.conf"
+    - "env.flaresolverr.conf"
   tags:
     - configuration
 
@@ -49,4 +65,5 @@
   community.docker.docker_compose:
     project_src: "{{ arrs_setup_path }}"
     build: false
+    pull: true
   become: false

templates/docker-compose.yml.j2

@@ -5,10 +5,10 @@ services:
     image: "lscr.io/linuxserver/deluge:{{ deluge_image_version }}"
     restart: unless-stopped
     env_file:
-      - {{ arrs_setup_path }}/env.deluge.conf
+      - "{{ arrs_setup_path }}/env.deluge.conf"
     volumes:
-      - {{ deluge_config_volume }}:/config
-      - {{ torrent_downloads_volume }}:/downloads
+      - "{{ deluge_config_volume }}:/config"
+      - "{{ torrent_downloads_volume }}:/downloads"
     ports:
       - {{ deluge_admin_port }}:8112
       - {{ deluge_host_port }}:6881
@@ -17,15 +17,18 @@ services:
       - arrs
 {% endif %}
 {% if radarr_enabled %}
-  sonarr:
+  radarr:
     image: "lscr.io/linuxserver/radarr:{{ radarr_image_version }}"
     restart: unless-stopped
     env_file:
-      - {{ arrs_setup_path }}/env.radarr.conf
+      - "{{ arrs_setup_path }}/env.radarr.conf"
     volumes:
-      - {{ radarr_config_volume }}:/config
-      - {{ radarr_series_volume }}:/movies
-      - {{ torrent_downloads_volume }}:/downloads
+      - "{{ radarr_config_volume }}:/config"
+      - "{{ torrent_downloads_volume }}:/downloads"
+      - "{{ radarr_upload_volume }}:/movies"
+{% for item in radarr_library_volumes %}
+      - "{{ item.path }}:/library/{{ item.alias }}"
+{% endfor %}
     ports:
       - {{ radarr_host_port }}:7878
     networks:
@@ -36,11 +39,14 @@ services:
     image: "lscr.io/linuxserver/sonarr:{{ sonarr_image_version }}"
     restart: unless-stopped
     env_file:
-      - {{ arrs_setup_path }}/env.sonarr.conf
+      - "{{ arrs_setup_path }}/env.sonarr.conf"
     volumes:
-      - {{ sonarr_config_volume }}:/config
-      - {{ sonarr_series_volume }}:/tv
-      - {{ torrent_downloads_volume }}:/downloads
+      - "{{ sonarr_config_volume }}:/config"
+      - "{{ torrent_downloads_volume }}:/downloads"
+      - "{{ sonarr_upload_volume }}:/tv"
+{% for item in sonarr_library_volumes %}
+      - "{{ item.path }}:/library/{{ item.alias }}"
+{% endfor %}
     ports:
       - {{ sonarr_host_port }}:8989
     networks:
@@ -51,12 +57,13 @@ services:
     image: "lscr.io/linuxserver/lidarr:{{ lidarr_image_version }}"
     restart: unless-stopped
     env_file:
-      - {{ arrs_setup_path }}/env.sonarr.conf
+      - "{{ arrs_setup_path }}/env.sonarr.conf"
     volumes:
-      - {{ lidarr_config_volume }}:/config
-      - {{ torrent_downloads_volume }}:/downloads
-{% for item in lidarr_music_volumes %}
-      - {{ item.path }}:/music/{{ item.alias }}
+      - "{{ lidarr_config_volume }}:/config"
+      - "{{ torrent_downloads_volume }}:/downloads"
+      - "{{ lidarr_upload_volume }}:/music"
+{% for item in lidarr_library_volumes %}
+      - "{{ item.path }}:/library/{{ item.alias }}"
 {% endfor %}
     ports:
       - {{ lidarr_host_port }}:8686
@@ -68,7 +75,7 @@ services:
     image: "lscr.io/linuxserver/jackett:{{ jackett_image_version }}"
     restart: unless-stopped
     env_file:
-      - {{ arrs_setup_path }}/env.jackett.conf
+      - "{{ arrs_setup_path }}/env.jackett.conf"
     volumes:
       - {{ jackett_config_volume }}:/config
       - {{ torrent_downloads_volume }}:/downloads
@@ -77,7 +84,19 @@ services:
       - {{ jackett_host_port }}:9117
     networks:
       - arrs
+
+  flaresolverr:
+    image: ghcr.io/flaresolverr/flaresolverr:latest
+    container_name: flaresolverr
+    env_file:
+      - "{{ arrs_setup_path }}/env.flaresolverr.conf"
+    ports:
+      - "{{ flaresolverr_host_port }}:8191"
+    restart: unless-stopped     
+    networks:
+      - arrs
 {% endif %}
 
+
 networks:
   arrs: {}

templates/env.deluge.conf.j2

@@ -5,4 +5,4 @@ PUID={{ arrs_uid }}
 {% endif %}
 {% if arrs_gid %}
 PGID={{ arrs_gid }}
-{% endif %}
+{% endif %}

templates/env.flaresolverr.conf.j2

@@ -0,0 +1,4 @@
+LOG_LEVEL={{ flaresolverr_log_level }}
+LOG_HTML={{ flaresolverr_log_html }}
+CAPTCHA_SOLVER={{ flaresolverr_captcha_solver }}
+TZ={{ flaresolverr_timezone }}

templates/env.jackett.conf.j2

@@ -5,4 +5,4 @@ PUID={{ arrs_uid }}
 {% endif %}
 {% if arrs_gid %}
 PGID={{ arrs_gid }}
-{% endif %}
+{% endif %}

templates/env.lidarr.conf.j2

@@ -4,4 +4,4 @@ PUID={{ arrs_uid }}
 {% endif %}
 {% if arrs_gid %}
 PGID={{ arrs_gid }}
-{% endif %}
+{% endif %}

templates/env.radarr.conf.j2

@@ -5,4 +5,4 @@ PUID={{ arrs_uid }}
 {% endif %}
 {% if arrs_gid %}
 PGID={{ arrs_gid }}
-{% endif %}
+{% endif %}

tests/test.yml

@@ -2,4 +2,4 @@
 - hosts: localhost
   remote_user: root
   roles:
-    - arrs
+    - arrs

vars/main.yml

@@ -1,2 +1,2 @@
 ---
-# vars file for arrs
+# vars file for arrs