joplin

truenas · Feb 14, 2025 · 287ff73 · 287ff73
1 parent 3477e25
commit 287ff73
Show file tree

Hide file tree

Showing 6 changed files with 83 additions and 12 deletions.
diff --git a/ix-dev/community/joplin/app.yaml b/ix-dev/community/joplin/app.yaml
@@ -1,3 +1,5 @@
+annotations:
+  min_scale_version: '25.04'
 app_version: 3.0.1-beta
 capabilities: []
 categories:
@@ -36,4 +38,4 @@ sources:
 - https://hub.docker.com/r/joplin/server/
 title: Joplin
 train: community
-version: 1.3.8
+version: 1.4.0
diff --git a/ix-dev/community/joplin/app_migrations.yaml b/ix-dev/community/joplin/app_migrations.yaml
@@ -0,0 +1,6 @@
+migrations:
+  - file: ip_port_migration
+    # from:
+    #   max_version: "FIXME:"
+    target:
+      min_version: 1.4.0
diff --git a/ix-dev/community/joplin/migrations/ip_port_migration b/ix-dev/community/joplin/migrations/ip_port_migration
@@ -0,0 +1,23 @@
+#!/usr/bin/python3
+
+import os
+import sys
+import yaml
+
+
+def migrate(values):
+    values["network"]["web_port"] = {
+        "port_number": values["network"]["web_port"],
+        "bind_mode": "published",
+        "host_ips": [],
+    }
+    return values
+
+
+if __name__ == "__main__":
+    if len(sys.argv) != 2:
+        exit(1)
+
+    if os.path.exists(sys.argv[1]):
+        with open(sys.argv[1], "r") as f:
+            print(yaml.dump(migrate(yaml.safe_load(f.read()))))
diff --git a/ix-dev/community/joplin/questions.yaml b/ix-dev/community/joplin/questions.yaml
@@ -85,13 +85,51 @@ questions:
       attrs:
         - variable: web_port
           label: WebUI Port
-          description: The port for Joplin WebUI
           schema:
-            type: int
-            default: 30106
-            required: true
-            $ref:
-              - definitions/port
+            type: dict
+            attrs:
+              - variable: bind_mode
+                label: Port Bind Mode
+                description: |
+                  The port bind mode.</br>
+                  - Publish: The port will be published on the host for external access.</br>
+                  - Expose: The port will be exposed for inter-container communication.</br>
+                  - None: The port will not be exposed or published.</br>
+                  Note: If the Dockerfile defines an EXPOSE directive,
+                  the port will still be exposed for inter-container communication regardless of this setting.
+                schema:
+                  type: string
+                  default: "published"
+                  enum:
+                    - value: "published"
+                      description: Publish port on the host for external access
+                    - value: "exposed"
+                      description: Expose port for inter-container communication
+                    - value: ""
+                      description: None
+              - variable: port_number
+                label: Port Number
+                schema:
+                  type: int
+                  show_if: [["bind_mode", "!=", ""]]
+                  default: 30106
+                  required: true
+                  $ref:
+                    - definitions/port
+              - variable: host_ips
+                label: Host IPs
+                description: IPs on the host to bind this port
+                schema:
+                  type: list
+                  default: []
+                  items:
+                    - variable: host_ip
+                      label: Host IP
+                      schema:
+                        type: string
+                        required: true
+                        $ref:
+                          - definitions/node_bind_ip
 
   - variable: storage
     label: ""

diff --git a/ix-dev/community/joplin/templates/docker-compose.yaml b/ix-dev/community/joplin/templates/docker-compose.yaml
@@ -17,11 +17,11 @@
 ) %}
 
 {% do c1.set_user(values.consts.run_user, values.consts.run_group) %}
-{% do c1.healthcheck.set_test("tcp", {"port": values.network.web_port}) %}
+{% do c1.healthcheck.set_test("tcp", {"port": values.network.web_port.port_number}) %}
 {% do c1.depends.add_dependency(values.consts.postgres_container_name, "service_healthy") %}
-{% do c1.ports.add_port(values.network.web_port, values.network.web_port) %}
+{% do c1.add_port(values.network.web_port) %}
 
-{% do c1.environment.add_env("APP_PORT", values.network.web_port) %}
+{% do c1.environment.add_env("APP_PORT", values.network.web_port.port_number) %}
 {% do c1.environment.add_env("APP_BASE_URL", values.joplin.base_url) %}
 {% do c1.environment.add_env("DB_CLIENT", "pg") %}
 {% do c1.environment.add_env("POSTGRES_HOST", values.consts.postgres_container_name) %}
@@ -42,6 +42,6 @@
   {% do c1.depends.add_dependency(values.consts.perms_container_name, "service_completed_successfully") %}
 {% endif %}
 
-{% do tpl.portals.add_portal({"port": values.network.web_port}) %}
+{% do tpl.portals.add_portal({"port": values.network.web_port.port_number}) %}
 
 {{ tpl.render() | tojson }}
diff --git a/ix-dev/community/joplin/templates/test_values/basic-values.yaml b/ix-dev/community/joplin/templates/test_values/basic-values.yaml
@@ -10,7 +10,9 @@ joplin:
   additional_envs: []
 
 network:
-  web_port: 8080
+  web_port:
+    bind_mode: published
+    port_number: 8080
 
 ix_volumes:
   postgres_data: /opt/tests/mnt/joplin-postgres-data