Dokploy / Dokploy/templates

`Dokployfile.yml` Concept & Template Generator

Open
#646 0 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
226
Forks
451
Avg merge
2d 17h
Merged PRs (30d)
23

Description

Hey Dokploy team! 👋

My main goal is to make use of the functionality Templates in Dokploy are as simple and accessible as possible. Currently, the process of creating and sharing templates looks difficult in my opinion, so this slows down their distribution.

I wanted sharing the template to be as easy as linking to a GitHub repository

💡 The solution: Dokployfile.yml as an alternative to meta.json

I have developed the concept of a Dokployfile, which is a simple YAML manifest that lies in the repository next to your code. It works by analogy with package.json or Dockerfile: describes metadata, icons, and specifies the path to docker-compose and template.toml.

🛠 Live Generator
To demonstrate this, I built a tool that parses a Dokployfile from any public GitHub repository and instantly generates the Base64 data needed for Dokploy.

👉 Try the Live Generator here (This link generates a template from template)

👉 Template Example here

Example Dokployfile.yml:

version: "1"
meta:
  slug: "my-app"
  name: "My App"
  logo: "logo.svg" 
template:
  compose: "docker-compose.yml"
  config: "config.toml"

The concept is described in more detail in my repository: dealenx/Dokployfile.

Template view (Link):
Image

Template Generator view (Link):
Image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Dokployfile.yml example, then review the linked Dokployfile repository and live generator to understand the proposed manifest and generated template data. Done would require an agreed integration scope for Dokploy templates, including how the manifest relates to meta.json, docker-compose.yml, and config.toml.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker-compose, github, yaml
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.