diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml index cb8f737..48cfaa8 100644 --- a/.github/workflows/validate.yml +++ b/.github/workflows/validate.yml @@ -49,6 +49,82 @@ jobs: echo "✅ Blueprint folders validated successfully." fi + - name: Validate meta.json structure and required fields + run: | + echo "🔍 Validating meta.json structure and required fields..." + + # First check if meta.json exists and is valid JSON + if [ ! -f "meta.json" ]; then + echo "❌ meta.json file not found" + exit 1 + fi + + if ! jq empty meta.json 2>/dev/null; then + echo "❌ meta.json is not a valid JSON file" + exit 1 + fi + + ERROR=0 + ERRORS_FOUND="" + + # Debug: Show total number of entries + TOTAL_ENTRIES=$(jq '. | length' meta.json) + echo "📊 Total entries in meta.json: $TOTAL_ENTRIES" + + # Get all entries at once and process them + TOTAL_INDEX=$(($TOTAL_ENTRIES - 1)) + + for i in $(seq 0 $TOTAL_INDEX); do + entry=$(jq -c ".[$i]" meta.json) + INDEX=$((i + 1)) + + echo "-------------------------------------------" + echo "🔍 Checking entry #$INDEX..." + + # Get the ID for better error reporting + ID=$(echo "$entry" | jq -r '.id // "UNKNOWN"') + echo "📝 Processing entry with ID: $ID" + + # Validate required top-level fields + for field in "id" "name" "version" "description" "logo" "links" "tags"; do + if [ "$(echo "$entry" | jq "has(\"$field\")")" != "true" ]; then + ERROR_MSG="❌ Entry #$INDEX (ID: $ID) is missing required field: $field" + echo "$ERROR_MSG" + ERRORS_FOUND="${ERRORS_FOUND}${ERROR_MSG}\n" + ERROR=1 + fi + done + + # Validate links object required fields + if [ "$(echo "$entry" | jq 'has("links")')" == "true" ]; then + for link_field in "github" "website" "docs"; do + if [ "$(echo "$entry" | jq ".links | has(\"$link_field\")")" != "true" ]; then + ERROR_MSG="❌ Entry #$INDEX (ID: $ID): links object is missing required field: $link_field" + echo "$ERROR_MSG" + ERRORS_FOUND="${ERRORS_FOUND}${ERROR_MSG}\n" + ERROR=1 + fi + done + fi + + # Validate tags array is not empty + if [ "$(echo "$entry" | jq '.tags | length')" -eq 0 ]; then + ERROR_MSG="❌ Entry #$INDEX (ID: $ID): tags array cannot be empty" + echo "$ERROR_MSG" + ERRORS_FOUND="${ERRORS_FOUND}${ERROR_MSG}\n" + ERROR=1 + fi + done + + echo "-------------------------------------------" + if [ $ERROR -eq 1 ]; then + echo "❌ meta.json structure validation failed." + echo -e "Summary of all errors found:${ERRORS_FOUND}" + exit 1 + else + echo "✅ meta.json structure validated successfully." + fi + - name: Validate meta.json matches blueprint folders and logo files run: | echo "🔍 Validating meta.json against blueprint folders and logos..." diff --git a/README.md b/README.md index 3c706ab..fcb2886 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ This is the official repository for the Dokploy Open Source Templates. 1. Fork the repository 2. Create a new branch -3. Add the template to the `blueprints` folder (docker-compose.yml, template.yml) +3. Add the template to the `blueprints` folder (`docker-compose.yml`, `template.toml`) 4. Add the template metadata (name, description, version, logo, links, tags) to the `meta.json` file 5. Add the logo to the template folder 6. Commit and push your changes @@ -58,7 +58,7 @@ port = 3000 host = "${main_domain}" -[[config.env]] +[config.env] [[config.mounts]] ``` @@ -131,7 +131,7 @@ My content """ ``` -Important: you can reference any variable in the `domains`, `env` and `mounts` sections. just use the `${variable_name}` syntax, in the case you don't want to define a variable, you can use the `domain`, `base64`, `password`, `hash`, `uuid`, `randomPort` or `timestamp` helpers. +Important: you can reference any variable in the `domains`, `env` and `mounts` sections. just use the `${variable_name}` syntax, in the case you don't want to define a variable, you can use the `domain`, `base64`, `password`, `hash`, `uuid`, `randomPort`, `timestamp`, `jwt`, `email`, or `username` helpers. ### Helpers @@ -145,6 +145,8 @@ We have a few helpers that are very common when creating a template, these are: - `randomPort`: This is a helper that will generate a random port for the template. - `timestamp`: This is a helper that will generate a timestamp. - `jwt or jwt:length`: This is a helper that will generate a jwt for the template. +- `email`: This is a helper that will generate a random email for the template. +- `username`: This is a helper that will generate a random username in lowercase for the template. diff --git a/blueprints/kestra/docker-compose.yml b/blueprints/kestra/docker-compose.yml new file mode 100644 index 0000000..8ec7fba --- /dev/null +++ b/blueprints/kestra/docker-compose.yml @@ -0,0 +1,65 @@ +volumes: + postgres-data: + driver: local + kestra-data: + driver: local + +services: + postgres: + image: postgres + volumes: + - postgres-data:/var/lib/postgresql/data + environment: + POSTGRES_DB: kestra + POSTGRES_USER: kestra + POSTGRES_PASSWORD: k3str4 + healthcheck: + test: ["CMD-SHELL", "pg_isready -d $${POSTGRES_DB} -U $${POSTGRES_USER}"] + interval: 30s + timeout: 10s + retries: 10 + + kestra: + image: kestra/kestra:latest + pull_policy: always + # Note that this setup with a root user is intended for development purpose. + # Our base image runs without root, but the Docker Compose implementation needs root to access the Docker socket + # To run Kestra in a rootless mode in production, see: https://kestra.io/docs/installation/podman-compose + user: "root" + command: server standalone + volumes: + - kestra-data:/app/storage + - /var/run/docker.sock:/var/run/docker.sock + - /tmp/kestra-wd:/tmp/kestra-wd + environment: + KESTRA_CONFIGURATION: | + datasources: + postgres: + url: jdbc:postgresql://postgres:5432/kestra + driverClassName: org.postgresql.Driver + username: kestra + password: k3str4 + kestra: + server: + basicAuth: + enabled: false + username: "admin@localhost.dev" # it must be a valid email address + password: kestra + repository: + type: postgres + storage: + type: local + local: + basePath: "/app/storage" + queue: + type: postgres + tasks: + tmpDir: + path: /tmp/kestra-wd/tmp + url: http://localhost:8080/ + ports: + - "8080" + - "8081" + depends_on: + postgres: + condition: service_started \ No newline at end of file diff --git a/blueprints/kestra/kestra.svg b/blueprints/kestra/kestra.svg new file mode 100644 index 0000000..4d12c86 --- /dev/null +++ b/blueprints/kestra/kestra.svg @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/blueprints/kestra/template.toml b/blueprints/kestra/template.toml new file mode 100644 index 0000000..c941e42 --- /dev/null +++ b/blueprints/kestra/template.toml @@ -0,0 +1,13 @@ +[variables] +main_domain = "${domain}" + +[config] +[[config.domains]] +serviceName = "kestra" +port = 8080 +host = "${main_domain}" + + +[config.env] + +[[config.mounts]] diff --git a/meta.json b/meta.json index 79cec75..910e7f7 100644 --- a/meta.json +++ b/meta.json @@ -1,5 +1,4 @@ -[ - { +[ { "id": "appwrite", "name": "Appwrite", "version": "1.6.0", @@ -273,6 +272,21 @@ "automation" ] }, + { + "id": "kestra", + "name": "Kestra", + "version": "latest", + "description": "Unified Orchestration Platform to Simplify Business-Critical Workflows and Govern them as Code and from the UI.", + "logo": "kestra.svg", + "links": { + "github": "https://github.com/kestra-io/kestra", + "website": "https://kestra.io", + "docs": "https://kestra.io/docs" + }, + "tags": [ + "automation" + ] + }, { "id": "wordpress", "name": "Wordpress", @@ -1636,7 +1650,8 @@ "logo": "it-tools.svg", "links": { "github": "https://github.com/CorentinTh/it-tools", - "website": "https://it-tools.tech" + "website": "https://it-tools.tech", + "docs": "https://it-tools.tech/docs" }, "tags": [ "developer", @@ -1670,7 +1685,8 @@ "logo": "glance.png", "links": { "github": "https://github.com/glanceapp/glance", - "docs": "https://github.com/glanceapp/glance/blob/main/docs/configuration.md" + "docs": "https://github.com/glanceapp/glance/blob/main/docs/configuration.md", + "website": "https://glance.app/" }, "tags": [ "dashboard", @@ -2148,7 +2164,8 @@ "logo": "logo.png", "links": { "github": "https://github.com/supernova3339/anonupload", - "docs": "https://github.com/Supernova3339/anonupload/blob/main/env.md" + "docs": "https://github.com/Supernova3339/anonupload/blob/main/env.md", + "website": "https://anonupload.com/" }, "tags": [ "file-sharing", @@ -2265,7 +2282,9 @@ "description": "Barrage is a minimalistic Deluge WebUI app with full mobile support. It features a responsive mobile-first design, allowing you to manage your torrents with ease from any device.", "logo": "logo.png", "links": { - "github": "https://github.com/maulik9898/barrage" + "github": "https://github.com/maulik9898/barrage", + "website": "https://github.com/maulik9898/barrage", + "docs": "https://github.com/maulik9898/barrage/blob/main/README.md" }, "tags": [ "torrents", @@ -2536,7 +2555,8 @@ "logo": "logo.png", "links": { "github": "https://github.com/linuxserver/docker-chromium", - "docs": "https://docs.linuxserver.io/images/docker-chromium" + "docs": "https://docs.linuxserver.io/images/docker-chromium", + "website": "https://docs.linuxserver.io/images/docker-chromium" }, "tags": [ "browser",