Add immich

README.md

@@ -46,6 +46,7 @@ If you have a spare domain name you can configure applications to be accessible
 * [Heimdall](https://heimdall.site/) - Home server dashboard
 * [Home Assistant](https://www.home-assistant.io) - Open source home automation
 * [Homebridge](https://github.com/nfarina/homebridge) - Emulate the iOS HomeKit API
+* [Immich](https://immich.app/) - Self-hosted photo and video backup solution directly from your mobile phone.
 * [Jackett](https://github.com/Jackett/Jackett) - API Support for your favorite torrent trackers
 * [Jellyfin](https://jellyfin.github.io) - The Free Software Media System
 * [Joomla](https://www.joomla.org/) - Open source content management system

nas.yml

@@ -171,6 +171,10 @@
         - homebridge
       when: (homebridge_enabled | default(False))
 
+    - role: immich
+      tags:
+        - immich
+
     - role: jackett
       tags:
         - jackett

roles/immich/defaults/main.yml

@@ -0,0 +1,56 @@
+---
+immich_enabled: false
+immich_available_externally: false
+
+# directories
+immich_data_directory: "{{ docker_home }}/immich"
+immich_upload_directory: "{{ docker_home }}/immich/upload"
+
+# network
+immich_port: "2283"
+immich_hostname: "immich"
+immich_network_name: "immich"
+
+# specs
+immich_postgres_memory: 1g
+immich_redis_memory: 1g
+immich_typesense_memory: 1g
+immich_server_memory: 1g
+immich_microservices_memory: 1g
+immich_machinelearning_memory: 1g
+immich_web_memory: 1g
+immich_proxy_memory: 1g
+
+# docker
+immich_postgres_container_name: "immich_postgres"
+immich_redis_container_name: "immich_redis"
+immich_server_container_name: "immich_server"
+immich_microservices_container_name: "immich_microservices"
+immich_machinelearning_container_name: "immich_machine_learning"
+
+immich_postgres_image: "tensorchord/pgvecto-rs"
+immich_postgres_tag: "pg14-v0.2.0"
+immich_redis_image: "redis"
+immich_redis_tag: "6.2-alpine"
+immich_server_image: "ghcr.io/immich-app/immich-server"
+immich_server_tag: "{{ immich_version}}"
+immich_microservices_image: "ghcr.io/immich-app/immich-server"
+immich_microservices_tag: "{{ immich_version}}"
+immich_machinelearning_image: "ghcr.io/immich-app/immich-machine-learning"
+immich_machinelearning_tag: "{{ immich_version}}"
+immich_user_id: "1000"
+immich_group_id: "1000"
+
+# database
+immich_db_password: "postgres" # $(pwgen -s 40 1)
+immich_db_username: "postgres"
+immich_db_name: "immich"
+immich_db_port: "5432"
+
+# immich
+immich_version: "release"
+immich_jwt_secret: "verylongandsecrettext"
+immich_enable_mapbox: "false"
+immich_mapbox_key: ""
+immich_upload_location: "./library"
+immich_public_login_page_message: "Welcome to Immich!"

roles/immich/docs/immich.md

@@ -0,0 +1,15 @@
+# Immich
+
+Homepage: [https://immich.app/](https://immich.app/)
+
+Self-hosted photo and video backup solution directly from your mobile phone.
+
+## Usage
+
+Set `immich_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+
+Set all `immich_*` variables in `inventories/<your_inventory>/group_vars/all.yml`.
+
+The immich web interface can be found at [http://ansible_nas_host_or_ip:2283](http://ansible_nas_host_or_ip:2283).
+
+Refer to [https://immich.app/docs/install/post-install](https://immich.app/docs/install/post-install) for post-install steps (Registering Admin User, adding users, etc.).

roles/immich/molecule/default/molecule.yml

@@ -0,0 +1,6 @@
+---
+provisioner:
+  inventory:
+    group_vars:
+      all:
+        immich_enabled: true

roles/immich/molecule/default/side_effect.yml

@@ -0,0 +1,10 @@
+---
+- name: Stop
+  hosts: all
+  become: true
+  tasks:
+    - name: "Include {{ lookup('env', 'MOLECULE_PROJECT_DIRECTORY') | basename }} role"
+      ansible.builtin.include_role:
+        name: "{{ lookup('env', 'MOLECULE_PROJECT_DIRECTORY') | basename }}"
+      vars:
+        immich_enabled: false

roles/immich/molecule/default/verify.yml

@@ -0,0 +1,47 @@
+---
+- name: Verify
+  hosts: all
+  gather_facts: false
+  tasks:
+    - name: Include vars
+      ansible.builtin.include_vars:
+        file: ../../defaults/main.yml
+
+    - name: Get Immich Postgres container state
+      community.docker.docker_container_info:
+        name: "{{ immich_postgres_container_name }}"
+      register: result_postgres
+
+    - name: Get Immich Redis container state
+      community.docker.docker_container_info:
+        name: "{{ immich_redis_container_name }}"
+      register: result_redis
+
+    - name: Get Immich Server container state
+      community.docker.docker_container_info:
+        name: "{{ immich_server_container_name }}"
+      register: result_server
+
+    - name: Get Immich Microservies container state
+      community.docker.docker_container_info:
+        name: "{{ immich_microservices_container_name }}"
+      register: result_microservices
+
+    - name: Get Immich Machine Learning container state
+      community.docker.docker_container_info:
+        name: "{{ immich_machinelearning_container_name }}"
+      register: result_machinelearning
+
+    - name: Check if Immich docker containers are running
+      ansible.builtin.assert:
+        that:
+          - result_postgres.container['State']['Status'] == "running"
+          - result_postgres.container['State']['Restarting'] == false
+          - result_redis.container['State']['Status'] == "running"
+          - result_redis.container['State']['Restarting'] == false
+          - result_server.container['State']['Status'] == "running"
+          - result_server.container['State']['Restarting'] == false
+          - result_microservices.container['State']['Status'] == "running"
+          - result_microservices.container['State']['Restarting'] == false
+          - result_machinelearning.container['State']['Status'] == "running"
+          - result_machinelearning.container['State']['Restarting'] == false

roles/immich/molecule/default/verify_stopped.yml

@@ -0,0 +1,47 @@
+---
+- name: Verify
+  hosts: all
+  gather_facts: false
+  tasks:
+    - name: Include vars
+      ansible.builtin.include_vars:
+        file: ../../defaults/main.yml
+
+    - name: Try and stop and remove Immich Postgres
+      community.docker.docker_container:
+        name: "{{ immich_postgres_container_name }}"
+        state: absent
+      register: result_postgres
+
+    - name: Try and stop and remove Immich Redis
+      community.docker.docker_container:
+        name: "{{ immich_redis_container_name }}"
+        state: absent
+      register: result_redis
+
+    - name: Try and stop and remove Immich Server
+      community.docker.docker_container:
+        name: "{{ immich_server_container_name }}"
+        state: absent
+      register: result_server
+
+    - name: Try and stop and remove Immich Microservices
+      community.docker.docker_container:
+        name: "{{ immich_microservices_container_name }}"
+        state: absent
+      register: result_microservices
+
+    - name: Try and stop and remove Immich Machine Learning
+      community.docker.docker_container:
+        name: "{{ immich_machinelearning_container_name }}"
+        state: absent
+      register: result_machinelearning
+
+    - name: Check if immich containers are stopped
+      ansible.builtin.assert:
+        that:
+          - not result_postgres.changed
+          - not result_redis.changed
+          - not result_server.changed
+          - not result_microservices.changed
+          - not result_machinelearning.changed