Added a clear requirement stating that all services must be open source and only applications with open-source licenses (e.g., MIT, Apache, GPL, AGPL) are allowed. This update aims to ensure compliance and maintain the integrity of the project.
Updated the GitHub Actions workflow for validating Docker Compose files by streamlining the detection of changed blueprints and improving the validation process. Removed redundant steps and consolidated the validation of docker-compose.yml and template.toml files into a more efficient structure. Added clearer output messages for validation results and ensured that best practices are checked for each blueprint. This refactor aims to improve maintainability and clarity in the CI/CD process.
Clarified the importance of pinning image versions in docker-compose.yml and explicitly stated to avoid using the `latest` tag to prevent potential issues with template functionality when upstream images change.
* docs: add copilot instructions for project development
Added comprehensive documentation file (.github/copilot-instructions.md) that provides detailed guidance on the Dokploy Open Source Templates project structure, development workflow, and conventions. The document covers the project overview, key files and directories, development workflow for adding/updating templates, local development setup, CI/CD processes, and established conventions and patterns. This documentation will help onboard new contributors and ensure consistent development practices across the project.
* docs(copilot-instructions): enhance project overview and development guide
Updated copilot instructions to reflect expanded app capabilities (200+ apps, TypeScript integration, Fuse.js search) and detailed processes for templates, local dev, and CI/CD for improved clarity and accuracy.
* refactor: remove frontend development instructions from AGENTS.md and update contributing guidelines
- Removed frontend development commands from AGENTS.md to streamline the document.
- Updated CONTRIBUTING.md by removing the recommendation to set `restart: unless-stopped` for services.
---------
Co-authored-by: Mauricio Siu <siumauricio@icloud.com>
- Introduced a new section in the pull request template to encourage contributors to include screenshots or videos, enhancing the clarity and context of their submissions.
- Changed the link in the pull request template from 'general suggestions' to 'general requirements' to better reflect the content and ensure users follow the correct guidelines when creating templates.
- Replaced the pipe with an array to handle directory names, ensuring that errors within the loop propagate correctly to the parent shell.
- Updated the loop structure for better reliability in processing the directories.
- Converted the handling of COMPOSE_FILES from a pipe to an array to ensure error propagation in the parent shell.
- Updated the loop to iterate over the array for better reliability in the validation process.
- Introduced a GitHub Actions workflow to validate Docker Compose files and template.toml on pull requests.
- Added helper functions for generating random values and processing variables in templates.
- Implemented validation scripts for checking the structure, syntax, and best practices of Docker Compose and template files.
- Created necessary TypeScript types and configuration files for the build scripts.
* docs: reorganize GitHub directory structure and improve PR template
- Move pull_request_template.md from .github/.github/ to .github/
- Change PR template heading from markdown level 2 to level 1
- Convert README.md reference in PR template to a markdown link
* chore: move pull request template to uppercase directory
Relocated pull_request_template.md from .github/ to .github/PULL_REQUEST_TEMPLATE/
to align with GitHub's recommended directory structure. No content changes.
* added
* chore: remove outdated pull request templates for bug fixes, documentation updates, and feature additions
* chore: remove outdated pull request template
* chore: replace old pull request template with a new structured version
* chore: add contributing guidelines for Dokploy Open Source Templates
* chore: update contributing guidelines and refine pull request template
- Changed validation step in contributing guidelines to use `node dedupe-and-sort-meta.js`.
- Simplified pull request template by removing unnecessary sections and improving checklist formatting.
---------
Co-authored-by: Mauricio Siu <47042324+Siumauricio@users.noreply.github.com>
Added comprehensive documentation file (.github/copilot-instructions.md) that provides detailed guidance on the Dokploy Open Source Templates project structure, development workflow, and conventions. The document covers the project overview, key files and directories, development workflow for adding/updating templates, local development setup, CI/CD processes, and established conventions and patterns. This documentation will help onboard new contributors and ensure consistent development practices across the project.
* removed
n8n (appears 2 times)
Authelia (appears 2 times)
SupaBase (appears 2 times)
Livekit (appears 2 times)
WG-Easy (appears 2 times)
Open Notebook (appears 2 times)
Booklore (appears 2 times)
Scrypted (appears 2 times)
Wallos (appears 2 times)
Statping-NG (appears 2 times)
* Replace application catalog entries with new software entries
* Test 1
* Updated Scripts
* Final Test
* Fix
* Remove redundant dependency installation steps from GitHub Actions workflow
* Test 2
* Update meta sorting logic to ASCII order and add --backup option for deduplication
* Fix meta.json: Remove duplicates and apply correct ASCII sorting
- Remove duplicate entries: scrypted, searxng (243 → 241 entries)
- Fix sorting algorithm to use ASCII order for CI/CD compatibility
- Update both dedupe-and-sort-meta.js and build-scripts/process-meta.js
- Add missing --backup CLI argument to build script
- Ensure consistent sorting across all processing interfaces
* Fix CI/CD pipeline: Count JSON entries instead of lines
- Update validate-meta.yml to count JSON entries using Node.js instead of wc -l
- Add custom JSON formatting functions to both processing scripts
- Ensure consistent output formatting across all processing interfaces
- Fix false positive where line count increased due to expanded JSON formatting
The CI/CD failure was caused by counting file lines (4124) instead of actual
JSON entries (241). Both files now produce identical results with proper
entry counting in the validation workflow.
* Fix meta.json formatting to match processing script output
- Apply consistent JSON formatting to meta.json using processing script
- Ensure file formatting matches expected CI/CD workflow output
- Files now pass diff comparison in validation workflow
This resolves the CI/CD pipeline failure where files had identical content
but different formatting, causing diff validation to fail.
* Test 3
* Removed duplicate and action worked :)
* Remove pull_request_template.md
* Remove duplicate meta entries to prevent processing conflicts
---------
Co-authored-by: Mauricio Siu <47042324+Siumauricio@users.noreply.github.com>
- Introduced a new pull request template to guide contributors in providing necessary information and ensuring best practices are followed before submission.
- Included a checklist for testing and issue linking to streamline the review process.
- Changed the expected template file from 'template.yml' to 'template.toml' in the GitHub Actions validation workflow to reflect recent changes in file format.
- Removed commented-out deployment steps for Cloudflare Pages to enhance clarity and focus on the build process.
- Maintained the artifact upload step to ensure build outputs are preserved.
- Introduced a new GitHub Actions workflow to handle deployment of preview builds to Cloudflare Pages upon successful completion of the build preview workflow.
- Configured necessary permissions and steps for downloading build artifacts and deploying to the specified Cloudflare project.
- Eliminated an internal issue comment from the artifact upload step for clarity.
- Ensured the workflow remains clean and focused on essential configurations.
- Renamed job to "Build Preview Deployment" and adjusted concurrency settings.
- Streamlined steps by removing unnecessary permissions and comments.
- Updated pnpm action to the latest version and ensured Node.js setup is consistent.
- Removed deployment step to Cloudflare Pages and related verification steps for simplification.
- Introduced a new GitHub Actions workflow for deploying the application to Cloudflare Pages upon pushes to the main branch.
- Configured steps for Node.js setup, dependency installation, and build processes using pnpm.
- Included necessary permissions and secrets for secure deployment.
- Deleted the deploy preview workflow file as it is no longer needed.
- This change simplifies the workflow configuration and reduces maintenance overhead.
- Renamed job to "Build and Deploy Preview" for clarity.
- Added a deployment step to Cloudflare Pages with necessary configurations.
- Updated permissions to include deployment rights.
- Updated workflow trigger to use a list format for better readability.
- Separated the deploy preview job into distinct steps for improved organization.
- Enhanced debug information to provide more detailed event context.
- Updated artifact download action to the latest version for better performance.
- Added an ID to the artifact upload step for better tracking.
- Enhanced the verification step to include workflow and repository information.
- Updated permissions to allow writing actions in the deploy workflow.
- Added debug information to the deploy workflow for better visibility of event details.
- Updated permissions to allow writing actions.
- Added a step to list build output for verification.
- Included a verification step to confirm artifact upload completion.
- Introduced a new workflow for building the preview site and uploading build artifacts.
- Added a deployment workflow to Cloudflare Pages triggered by the successful completion of the build workflow.
- Configured Node.js and pnpm for dependency management and build processes.
