mirror of
https://github.com/Dokploy/website.git
synced 2026-07-14 10:25:24 +02:00
17e1ae05d3
The Existing Docker Swarm section only created the network and the dokploy service, so installs failed against current versions that require the dokploy_postgres_password and dokploy_auth_secret Docker secrets, the dokploy-postgres service, and Traefik (issue #111). It now mirrors what install.sh does today, minus the swarm re-initialization. Also remove the ADVERTISE_ADDR env passed to the dokploy service in install.sh and the docs: the app stopped reading process.env.ADVERTISE_ADDR in February 2025, and the private-IP lookup step in troubleshooting only existed to fill it. The recreate-service commands now also mount the auth secret so recreated instances don't fall back to the insecure hardcoded default, and the advertise-addr customization section documents the ADVERTISE_ADDR env override instead of a script line that no longer exists.
Contributing
Hey, thanks for your interest in contributing to Dokploy! We appreciate your help and taking your time to contribute.
Before you start, please first discuss the feature/bug you want to add with the owners and community via github issues.
We have a few guidelines to follow when contributing to this project:
Commit Convention
Before you create a Pull Request, please make sure your commit message follows the Conventional Commits specification.
Commit Message Format
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
Type
Must be one of the following:
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug nor adds a feature
- perf: A code change that improves performance
- test: Adding missing tests or correcting existing tests
- build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
- ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
- chore: Other changes that don't modify
srcortestfiles - revert: Reverts a previous commit
Example:
feat: add new feature
Pull Request
- The
mainbranch is the source of truth and should always reflect the latest stable release. - Create a new branch for each feature or bug fix.
- Make sure to add tests for your changes.
- Make sure to update the documentation for any changes Go to the docs.dokploy.com website to see the changes.
- When creating a pull request, please provide a clear and concise description of the changes made.
- If you include a video or screenshot, would be awesome so we can see the changes in action.
- If your pull request fixes an open issue, please reference the issue in the pull request description.
- Once your pull request is merged, you will be automatically added as a contributor to the project.
Thank you for your contribution!
Docs
To run the docs locally, run the following command:
pnpm run docs:dev
To build the docs, run the following command:
pnpm run docs:build
Website
To run the website locally, run the following command:
pnpm run website:dev
To build the website, run the following command:
pnpm run website:build