Dokploy / Dokploy/dokploy

Add support for .env.ecample

Open
#2,326 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
37.4k
Forks
3k
Avg merge
1d 3h
Merged PRs (30d)
73

Description

What problem will this feature address?

Each time I add a new environment variable to my project and update the .env.example, I need to manually update the env vars in Dokploy with it. Sometimes, I forget, which leads to issues. Also, it's good for self-documentation; you may add an env var with a default and never override it, and after time you may forget about it, having this feature also prevents this.

Describe the solution you'd like

In the environment variables tab, add a sub tab named something like "example", and fill it with the .env.example you find in the root dir of the downloaded project.

Describe alternatives you've considered

I don't see one. It should be manually handled by the user otherwise.

Additional context

No response

Will you send a PR to implement it?

No

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 in the environment variables tab and trace how the downloaded project's root directory is accessed. Use the requested .env.example location and the proposed example subtab as the scope; done means the tab displays the discovered example environment variables for the project.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
devops
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.