Skip to content

Change convex port mapping to expose and bump version#730

Open
marcbodea wants to merge 2 commits intoDokploy:canaryfrom
marcbodea:canary
Open

Change convex port mapping to expose and bump version#730
marcbodea wants to merge 2 commits intoDokploy:canaryfrom
marcbodea:canary

Conversation

@marcbodea
Copy link

@marcbodea marcbodea commented Feb 28, 2026

What is this PR about?

New PR of [convex]

Bumped versions to current latest, and removed host port mappings, which should not be needed and in general avoided. Also added default FALSE value for disable beacon as the latest versions error on start if the value is empty.

Checklist

Before submitting this PR, please make sure that:

Issues related (if applicable)

Close automatically the related issues using the keywords: closes #ISSUE_NUMBER

Screenshots or Videos

@github-actions
Copy link

github-actions bot commented Feb 28, 2026

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
templates ✅ Ready (View Log) Visit Preview 690b2c1

@marcbodea marcbodea marked this pull request as ready for review February 28, 2026 11:54
@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Feb 28, 2026
Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.

@dosubot dosubot bot added the version-bump label Feb 28, 2026
@dosubot
Copy link

dosubot bot commented Feb 28, 2026

Related Documentation

1 document(s) may need updating based on files changed in this PR:

Dokploy's Space

copilot-instructions /templates/blob/canary/.github/copilot-instructions.md
View Suggested Changes
@@ -18,13 +18,13 @@
 
 - `meta.json`: Array of template objects. Always process after edits using `node dedupe-and-sort-meta.js` to remove duplicates (by `id`) and sort alphabetically.
 - `blueprints/<service>/`:
-  - `docker-compose.yml`: Standard Docker Compose v3.8. Avoid `ports`, `container_name`, `networks`—Dokploy handles isolation via internal networks.
+  - `docker-compose.yml`: Standard Docker Compose v3.8. **NEVER use `ports` with host port mappings**—use `expose` only. Avoid `container_name`, `networks`—Dokploy handles isolation via internal networks.
   - `template.toml`: Defines variables (e.g., `${domain}`), domains (service:port → host), env vars, and mounts. Use helpers like `${password:32}`, `${uuid}`, `${jwt:secret_var}`.
   - `logo.svg/png`: Service icon, referenced in `meta.json`.
 - `dedupe-and-sort-meta.js`: Standalone script—reads `meta.json`, removes duplicate `id`s (keeps first), sorts by `id` (case-insensitive), creates timestamped backup.
 - `build-scripts/process-meta.js`: Advanced processor with CLI options (`--verbose`, `--no-backup`, `--input`/`--output`), JSON schema validation (required: `id`, `name`, `version`, `description`, `links.github`, `logo`, `tags` array).
 
-Exemplary blueprint: `blueprints/ghost/`—`docker-compose.yml` exposes port 2368; `template.toml` maps domain to Ghost service; meta entry tags as ["blogging", "cms"].
+Exemplary blueprint: `blueprints/ghost/`—`docker-compose.yml` uses `expose: ["2368"]` for port exposure; `template.toml` maps domain to Ghost service; meta entry tags as ["blogging", "cms"].
 
 ## Development Workflow
 
@@ -33,7 +33,7 @@
    - **REQUIREMENT**: Service **MUST** be open source. Only add templates for applications with an open-source license (e.g., MIT, Apache, GPL, AGPL). Proprietary or closed-source services are not allowed.
    - **Verify Docker Images**: Before using any Docker image in `docker-compose.yml`, verify it exists using `docker manifest inspect <image:tag>` (e.g., `docker manifest inspect docker.io/bitnami/discourse:3.5.0`). This ensures the image is available and prevents deployment failures.
    - Create `blueprints/<id>/` (e.g., `ghost`).
-   - Implement `docker-compose.yml` (single service typical; use volumes for persistence).
+   - Implement `docker-compose.yml` (single service typical; use `expose` for ports, volumes for persistence).
    - Configure `template.toml`—reference vars in `[config.domains]`, `[config.env]`, `[config.mounts]`.
    - Add/update `meta.json` entry with exact `id` matching folder.
    - Run `node dedupe-and-sort-meta.js --backup` to validate/sort.
@@ -49,7 +49,10 @@
 
 - **Open Source Requirement**: **ALL services MUST be open source**. Only applications with open-source licenses (MIT, Apache, GPL, AGPL, etc.) are allowed. Proprietary or closed-source services are strictly prohibited.
 - **Template IDs**: Lowercase, kebab-case (e.g., `active-pieces`); unique across repo—enforced by dedupe script.
-- **Docker Compose**: Minimal—omit `ports` (Dokploy proxies), persistent volumes (e.g., `- db-data:/var/lib/postgresql/data`). Services named after folder (e.g., `ghost` service).
+- **Docker Compose**: 
+  - **Port Mappings**: **NEVER use `ports` with host port mappings** (e.g., `"8080:8080"`)—**always use `expose` only** (e.g., `expose: ["8080"]`). Dokploy handles port proxying via its internal reverse proxy, so host port bindings are unnecessary and create potential port conflicts. This applies to ALL blueprints; some older templates may still incorrectly use `ports` and should be updated to use `expose` instead.
+  - Use persistent volumes for data storage (e.g., `- db-data:/var/lib/postgresql/data`). 
+  - Services named after folder (e.g., `ghost` service).
 - **template.toml**:
   - Variables: `[variables] main_domain = "${domain}"`; use helpers for secrets (`${password:64}`, `${base64:32}`).
   - Domains: `[[config.domains]] serviceName = "<service>" port = 80 host = "${main_domain}"` (path="/" optional).

[Accept] [Decline]

Note: You must be authenticated to accept/decline updates.

How did I do? Any feedback?  Join Discord

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:S This PR changes 10-29 lines, ignoring generated files. version-bump

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant