Add Flame

README.md

@@ -34,6 +34,7 @@ If you have a spare domain name you can configure applications to be accessible
 * [Emby](https://emby.media/) - Media streaming and management
 * [ESPHome](https://esphome.io/) - ESP8266/ESP32 programming and management for home automation
 * [Firefly III](https://firefly-iii.org/) - Free and open source personal finance manager
+* [Flame](https://github.com/pawelmalak/flame/) - Self-hosted startpage for your server
 * [Fresh RSS](https://freshrss.org/) - Self-hosted RSS feed aggregator like Leed or Kriss Feed
 * [get_iplayer](https://github.com/get-iplayer/get_iplayer) - download programmes from BBC iplayer
 * [Gitea](https://gitea.io/en-us/) - Simple self-hosted GitHub clone

nas.yml

@@ -113,6 +113,10 @@
       tags:
         - firefly
 
+    - role: flame
+      tags:
+        - flame
+
     - role: freshrss
       tags:
         - freshrss

roles/flame/defaults/main.yml

@@ -0,0 +1,20 @@
+---
+flame_enabled: false
+flame_available_externally: false
+
+# directories
+flame_data_directory: "{{ docker_home }}/flame"
+
+# network
+flame_port: "5005"
+flame_hostname: "flame"
+
+# specs
+flame_memory: 1g
+
+# docker
+flame_container_name: "flame"
+flame_image: "pawelmalak/flame"
+flame_tag: "latest"
+flame_user_id: "1000"
+flame_group_id: "1000"

roles/flame/docs/flame.md

@@ -0,0 +1,17 @@
+# Flame
+
+Homepage: <https://github.com/pawelmalak/flame>
+
+Flame is self-hosted startpage for your server. Easily manage your apps and bookmarks with built-in editors.
+
+## Usage
+
+Set `flame_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+
+Set all `flame_*` variables in `inventories/<your_inventory>/group_vars/all.yml`.
+
+The flame web interface can be found at <http://ansible_nas_host_or_ip:5005>.
+
+## Specific Configuration
+
+Check <https://github.com/pawelmalak/flame> for more details on using the docker integration.

roles/flame/molecule/default/molecule.yml

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

roles/flame/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"
+      include_role:
+        name: "{{ lookup('env', 'MOLECULE_PROJECT_DIRECTORY') | basename }}"
+      vars:
+        flame_enabled: false

roles/flame/molecule/default/verify.yml

@@ -0,0 +1,19 @@
+---
+- name: Verify
+  hosts: all
+  gather_facts: false
+  tasks:
+    - name: Include vars
+      include_vars:
+        file: ../../defaults/main.yml
+
+    - name: Get Flame container state
+      docker_container_info:
+        name: "{{ flame_container_name }}"
+      register: result
+
+    - name: Check if flame docker container is running
+      assert:
+        that:
+          - result.container['State']['Status'] == "running"
+          - result.container['State']['Restarting'] == false

roles/flame/molecule/default/verify_stopped.yml

@@ -0,0 +1,19 @@
+---
+- name: Verify
+  hosts: all
+  gather_facts: false
+  tasks:
+    - name: Include vars
+      include_vars:
+        file: ../../defaults/main.yml
+
+    - name: Try and stop and remove flame
+      docker_container:
+        name: "{{ flame_container_name }}"
+        state: absent
+      register: result
+
+    - name: Check if flame containers are stopped
+      assert:
+        that:
+          - not result.changed

roles/flame/tasks/main.yml

@@ -0,0 +1,43 @@
+---
+- name: Start Flame
+  block:
+    - name: Create Flame Directory
+      file:
+        path: "{{ item }}"
+        state: directory
+      with_items:
+        - "{{ flame_data_directory }}"
+
+    - name: Flame Docker Container
+      community.docker.docker_container:
+        name: "{{ flame_container_name }}"
+        image: "{{ flame_image }}:{{ flame_tag }}"
+        pull: true
+        volumes:
+          - "{{ flame_data_directory }}:/app/data"
+          - "/var/run/docker.sock:/var/run/docker.sock"
+        ports:
+          - "{{ flame_port }}:5005"
+        env:
+          TZ: "{{ ansible_nas_timezone }}"
+          PUID: "{{ flame_user_id }}"
+          PGID: "{{ flame_group_id }}"
+        labels:
+          traefik.enable: "{{ flame_available_externally | string }}"
+          traefik.http.routers.flame.rule: "Host(`{{ flame_hostname }}.{{ ansible_nas_domain }}`)"
+          traefik.http.routers.flame.tls.certresolver: "letsencrypt"
+          traefik.http.routers.flame.tls.domains[0].main: "{{ ansible_nas_domain }}"
+          traefik.http.routers.flame.tls.domains[0].sans: "*.{{ ansible_nas_domain }}"
+          traefik.http.services.flame.loadbalancer.server.port: "5005"
+        restart_policy: unless-stopped
+        memory: "{{ flame_memory }}"
+  when: flame_enabled is true
+
+- name: Stop flame
+  block:
+    - name: Stop Flame
+      community.docker.docker_container:
+        name: "{{ flame_container_name }}"
+        state: absent
+
+  when: flame_enabled is false

website/docs/applications/dashboards/flame.md

@@ -0,0 +1,19 @@
+---
+title: "Flame"
+---
+
+Homepage: <https://github.com/pawelmalak/flame>
+
+Flame is self-hosted startpage for your server. Easily manage your apps and bookmarks with built-in editors.
+
+## Usage
+
+Set `flame_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+
+Set all `flame_*` variables in `inventories/<your_inventory>/group_vars/all.yml`.
+
+The flame web interface can be found at <http://ansible_nas_host_or_ip:5005>.
+
+## Specific Configuration
+
+Check <https://github.com/pawelmalak/flame> for more details on using the docker integration.