Feat/docker compose json (#3503)

* feat(2fauth): a docker-compose.json config

* ci(app-version): increase image automatically in docker-compose.json

.eslintrc.js

@@ -1,7 +1,13 @@
 module.exports = {
-  extends: ["plugin:json-schema-validator/recommended"],
+  extends: ['plugin:json-schema-validator/recommended'],
   plugins: [],
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    project: './tsconfig.json',
+    tsconfigRootDir: __dirname,
+  },
   rules: {
-    "json-schema-validator/no-invalid": "error",
+    'json-schema-validator/no-invalid': 'error',
   },
 };

.github/workflows/renovate-app-version.sh

@@ -4,14 +4,14 @@
 app_name=$1
 
 # find all docker-compose files under apps/$app_name (there should be only one)
-docker_compose_files=$(find apps/$app_name -name docker-compose.yml)
+docker_compose_files=$(find apps/"$app_name" -name docker-compose.yml)
 
 for docker_compose_file in $docker_compose_files
 do
 	# Assuming that the app version will be from the first docker image
-	first_service=$(yq '.services | keys | .[0]' $docker_compose_file)
+	first_service=$(yq '.services | keys | .[0]' "$docker_compose_file")
 
-	image=$(yq .services.$first_service.image $docker_compose_file)
+	image=$(yq .services."$first_service".image "$docker_compose_file")
 
 	# Only apply changes if the format is <image>:<version>
 	if [[ "$image" == *":"* ]]; then
@@ -20,20 +20,39 @@ do
 	  # Trim the "v" prefix
 	  trimmed_version=${version/#"v"}
 
-	  # Find config file
+	  # ------------------- Update config.json -------------------
 	  config_file=${docker_compose_file/docker-compose.yml/config.json}
 
-	  current_config_version=$(jq -r '.version' $config_file)
+	  current_config_version=$(jq -r '.version' "$config_file")
+    echo "Current config version: $current_config_version"
 
-	  # Update the version in config.json, but only if there's a change
+	  # Update the version in config.json
-	  if [[ "$current_config_version" != "$trimmed_version" ]]; then
+    contents="$(jq --arg trimmed_version "$trimmed_version" '.version=$trimmed_version' "$config_file")"
-	    contents="$(jq --arg trimmed_version "$trimmed_version" '.version=$trimmed_version' $config_file)"
+    echo "${contents}" > "$config_file"
-	    echo "${contents}" > $config_file
 
-	    tipi_version=$(jq -r '.tipi_version' $config_file)
+
-	    tipi_version=$((tipi_version + 1))
+    # ------------------- Update docker-compose.json -------------------
-	    contents="$(jq --argjson tipi_version $tipi_version '.tipi_version=$tipi_version' $config_file)"
+    # Update the version in docker-compose.json if it exists
-	    echo "${contents}" > $config_file
+    if [[ -f ${docker_compose_file/docker-compose.yml/docker-compose.json} ]]; then
-	  fi
+      compose_file=${docker_compose_file/docker-compose.yml/docker-compose.json}
+
+      echo "Updating $compose_file with version $image"
+
+      main_service_index=$(yq '.services | to_entries[] | select(.value.isMain == true) | .key' "$compose_file")
+
+      # apply trimmed version to docker-compose.json's main service
+      contents="$(jq --arg image "$image" --arg main_service_index "$main_service_index" '.services[$main_service_index | tonumber].image=$image' "$compose_file")"
+      echo "${contents}" > "$compose_file"
+    fi
+    
+    # ------------------- Update config.json -------------------
+    tipi_version=$(jq -r '.tipi_version' "$config_file")
+    tipi_version=$((tipi_version + 1))
+    contents="$(jq --argjson tipi_version $tipi_version '.tipi_version=$tipi_version' "$config_file")"
+    echo "${contents}" > "$config_file"
+
+    # ------------------- Format files with prettier -------------------
+    npx prettier "$config_file" --write
+    npx prettier "$compose_file" --write
 	fi
-done
+done

.prettierrc

@@ -1 +0,0 @@
-{}

.prettierrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+  singleQuote: true,
+  semi: true,
+  trailingComma: "all",
+  tabWidth: 2,
+  printWidth: 150,
+};

apps/2fauth/config.json

@@ -6,20 +6,16 @@
   "gid": 1000,
   "available": true,
   "exposable": true,
+  "dynamic_config": true,
   "id": "2fauth",
   "tipi_version": 15,
   "version": "5.1.1",
-  "categories": [
+  "categories": ["security"],
-    "security"
-  ],
   "description": "A Web app to manage your Two-Factor Authentication (2FA) accounts and generate their security codes.",
   "short_desc": "Manage your Two-Factor Authentication codes.",
   "author": "Bubka",
   "source": "https://github.com/Bubka/2FAuth",
   "website": "https://docs.2fauth.app/",
   "form_fields": [],
-  "supported_architectures": [
+  "supported_architectures": ["arm64", "amd64"]
-    "arm64",
-    "amd64"
-  ]
 }

apps/2fauth/docker-compose.json

@@ -0,0 +1,20 @@
+{
+  "services": [
+    {
+      "name": "2fauth",
+      "image": "2fauth/2fauth:5.1.1",
+      "internalPort": 8000,
+      "isMain": true,
+      "volumes": [
+        {
+          "hostPath": "${APP_DATA_DIR}/data",
+          "containerPath": "/2fauth"
+        }
+      ],
+      "environment": {
+        "ASSET_URL": "https://${APP_DOMAIN}",
+        "APP_URL": "https://${APP_DOMAIN}"
+      }
+    }
+  ]
+}

apps/__tests__/app-config.ts

@@ -0,0 +1,32 @@
+import { z } from 'zod';
+
+export const appConfigSchema = z.object({
+  services: z.array(
+    z.object({
+      name: z.string(),
+      image: z.string(),
+      internalPort: z.number().min(1).max(65535),
+      isMain: z.boolean().optional(),
+      command: z.string().optional(),
+      // eg: /path/to/volume:/path/in/container
+      volumes: z.array(
+        z.object({
+          hostPath: z.string().regex(/^\/.+/),
+          containerPath: z.string().regex(/^\/.+/),
+        }),
+      ),
+      environment: z.record(z.string()).optional(),
+      healthCheck: z
+        .object({
+          test: z.string(),
+          // eg: 5s, 1m, 1h
+          interval: z.string().regex(/^\d+[smh]$/),
+          timeout: z.string().regex(/^\d+[smh]$/),
+          retries: z.number().min(0),
+        })
+        .optional(),
+    }),
+  ),
+});
+
+export type AppConfig = z.input<typeof appConfigSchema>;