Commit Graph

172 Commits

Author SHA1 Message Date
Mauricio Siu
de61dfbfa3 docs: add storage cleanup note to cluster documentation
- Introduced a Callout component to highlight the importance of manual storage cleanup for workers and associated nodes in Dokploy.
- Provided guidance on configuring remote servers for automatic cleanup and clarified that no setup is needed when adding a node as a remote server. https://github.com/Dokploy/dokploy/issues/3195
2025-12-09 17:42:47 -06:00
Mauricio Siu
1ca89a17dd docs: clarify network requirements for Dokploy in Docker Compose
- Added a note regarding the necessity of including `dokploy-network` in all services when not using Isolated Deployments to ensure connectivity.
- Enhanced the documentation to provide clearer guidance on network configurations in Docker Compose setups.
2025-12-09 16:54:42 -06:00
Mauricio Siu
7ab0dc1e54 fix: update documentation to replace Traefik with Docker Compose
- Changed the link and description in the core documentation to focus on Docker Compose instead of Traefik.
- Updated the content to provide guidance on using Docker Compose with Dokploy.
2025-12-09 14:01:43 -06:00
Mauricio Siu
0a5e3a160e docs: add timezone configuration instructions to manual installation guide
- Included a new environment variable, TZ, for setting the timezone in Dokploy installations.
- Added a section detailing how to update the timezone using a Docker command, enhancing user guidance for server configuration.

Fix this question https://github.com/Dokploy/dokploy/issues/2688
2025-12-07 22:59:44 -06:00
Mauricio Siu
4c874988b8 docs: add 'goodies' section to meta.json for improved documentation structure
- Included a new 'goodies' entry in the meta.json file to enhance the organization of documentation topics.
- This addition aims to streamline user navigation and access to relevant resources within the documentation.
2025-12-07 21:46:02 -06:00
Mauricio Siu
a4bca9b709 docs: update development server ports and enhance Railpack documentation
- Changed development server ports for both the docs and website applications to avoid conflicts.
- Expanded the Railpack documentation to include a section on specifying the Railpack version, detailing how to pin, upgrade, or maintain stable versions for consistent builds.
- Added a callout for invalid version specifications to improve user guidance.
2025-12-07 20:25:46 -06:00
Mauricio Siu
33777b77c1 docs: update validation requirements for remote servers in Dokploy documentation
- Expanded the validation section for Deployment and Build Servers, detailing specific components required for each server type.
- Added callouts to clarify the roles of Deployment and Build Servers, emphasizing their distinct configurations and functionalities.
- Improved overall structure and clarity of the validation process, ensuring users understand the prerequisites for successful server setup.
2025-12-07 19:23:43 -06:00
Mauricio Siu
011359836c docs: expand rollbacks documentation with detailed mechanisms and configurations
- Added sections on Docker Swarm and registry-based rollback mechanisms, explaining their functionalities and differences.
- Included prerequisites and steps for enabling registry-based rollbacks, enhancing user control over application versions.
- Improved clarity with callouts emphasizing important considerations for both rollback methods.
- Updated the structure to provide a comprehensive guide for users on managing application rollbacks effectively.
2025-12-07 19:18:39 -06:00
Mauricio Siu
0b52b9b1af docs: refactor code for consistency and readability
- Standardized import statements across various components to use double quotes for consistency.
- Updated component files to ensure proper formatting and adherence to coding standards.
- Enhanced overall code readability by aligning code structure and improving comment clarity.
- Made minor adjustments to ensure all components follow the same coding conventions, improving maintainability.
2025-12-07 18:13:12 -06:00
Mauricio Siu
4f685a2df9 docs: enhance Tailscale guide with UFW security configuration
- Added a new section on securing servers with UFW (Uncomplicated Firewall) after Tailscale setup.
- Included detailed steps for enabling UFW, configuring default rules, and allowing Tailscale traffic.
- Emphasized the importance of verifying SSH access over Tailscale before restricting public access.
- Provided warnings about Docker's interaction with UFW and recommended solutions for maintaining security.
2025-12-07 18:04:30 -06:00
Mauricio Siu
4253060701 docs: add Tailscale guide for secure access to Dokploy applications
- Introduced a new guide on using Tailscale to securely access Dokploy applications and servers through a private network.
- Updated meta.json to include the new Tailscale guide in the documentation structure.
- The guide covers setup, configuration, and security benefits of using Tailscale, emphasizing zero-config VPN features and private service access.
2025-12-07 17:52:23 -06:00
Mauricio Siu
7f1966915f docs: update manual installation instructions and usage examples
- Added commands for using specific Dokploy versions with curl and bash, enhancing clarity on installation options.
- Updated the install.sh script comments to reflect new usage instructions for setting the DOKPLOY_VERSION environment variable.
2025-12-07 15:02:56 -06:00
Mauricio Siu
8cd50f2a62 docs: update meta descriptions for API, CLI, and Core documentation
- Revised the description for the API documentation to specify it as a RESTful API reference for programmatic access to Dokploy.
- Updated the CLI documentation description to clarify it as a command-line interface for managing Dokploy from the terminal.
- Enhanced the Core documentation description to provide essential guides for deploying and managing applications, databases, and server configurations.
2025-12-07 14:04:35 -06:00
Mauricio Siu
0003348ad7 docs: enhance volume backups and Docker Compose documentation
- Added important notes regarding the use of Docker named volumes for volume backups, clarifying that bind mounts are not supported.
- Updated the Docker Compose section to differentiate between bind mounts and named volumes, including guidance on when to use each method.
- Included a comparison table to help users choose the appropriate volume method based on their needs.
- Enhanced callouts to emphasize the implications of using bind mounts versus named volumes for data persistence and backup functionality.
2025-12-07 13:55:49 -06:00
Mauricio Siu
a7fa8c1473 docs: add webhook notification provider and update related documentation
- Introduced a new webhook notification provider in the meta.json file.
- Updated the overview documentation to include webhook notifications as a supported method.
- Created a detailed guide for configuring and testing webhook notifications, including JSON payload examples and production setup recommendations.
2025-12-07 13:48:41 -06:00
Mauricio Siu
56145b083e docs: restructure user permissions documentation to clarify roles and access levels
- Updated the permissions section to define three distinct user roles: Owner, Admin, and Members, each with specific capabilities and limitations.
- Enhanced the description of permissions available to Members, detailing actions they can perform.
- Improved clarity on project permissions and the ability to assign access at the environment level for granular control.
2025-12-07 13:07:53 -06:00
Mauricio Siu
4a7a62b51c docs: update schedule jobs documentation and add Lark notifications
- Enhanced the schedule jobs section to clarify the execution context for Server and Dokploy Server Jobs, emphasizing their interaction with Docker commands.
- Introduced a new Lark notifications guide, detailing setup steps and configuration for receiving notifications in the Dokploy panel.
- Updated the overview of notification providers to include Lark, ensuring comprehensive coverage of available options.
2025-12-07 13:02:49 -06:00
Mauricio Siu
04e2d330e4 docs: add build server configuration section to advanced.mdx
- Introduced a new section detailing the use of external build servers for application compilation and deployment.
- Explained the benefits of using build servers, including resource optimization and isolation from production environments.
- Provided a step-by-step overview of the build, push, and deploy phases when using a custom build server.
- Added important callouts regarding the limitations and required configurations for using build servers.
2025-12-07 12:56:17 -06:00
Mauricio Siu
102e53a629 docs: add environment variables section for Dockerfile builds
- Introduced a new section detailing the configuration of build time arguments and build-time secrets for Dockerfile builds.
- Explained the importance of using build-time secrets for sensitive information and provided links to relevant Docker documentation.
- Added a callout emphasizing best practices for handling sensitive data during the build process.
2025-12-07 12:52:15 -06:00
Mauricio Siu
9da77b4ac7 docs: expand Docker Compose domain management with automatic label handling
- Added a new section explaining how Dokploy automatically adds Traefik labels to Docker Compose files during deployment.
- Included example Docker Compose configurations to illustrate the default and final states after domain configuration.
- Highlighted the functionality of the Preview Compose feature for users to verify modifications before deployment.
- Emphasized important notes regarding domain settings and their impact on deployment behavior.
2025-12-07 12:43:57 -06:00
Mauricio Siu
5a39783804 docs: add detailed domain management section for Applications and Docker Compose
- Introduced a comprehensive guide on how domains are managed differently for Applications and Docker Compose.
- Included specific configurations for each method, highlighting key points such as redeployment requirements and hot reloading capabilities.
- Added YAML examples for Applications and outlined the use of Traefik Docker Labels for Docker Compose, enhancing user understanding of domain configurations.
2025-12-07 12:38:27 -06:00
Mauricio Siu
080a687084 docs: update Docker Compose utilities documentation
- Clarified the functionality of Isolated Deployments, emphasizing automatic network handling.
- Added a warning callout regarding installation type considerations for custom installations, detailing potential issues after system restarts and the need for manual redeployment.
- Enhanced the Randomize Compose section with important notes on system restart implications and recommended approaches for different installation types.
2025-12-07 12:32:07 -06:00
Mauricio Siu
f47045c824 docs: enhance Docker Compose domain configuration guide
- Added a new section for troubleshooting in meta.json to improve user navigation.
- Expanded the Docker Compose documentation to include two methods for domain configuration: using Dokploy Domains (recommended) and manual configuration with Traefik labels.
- Included detailed steps and callouts for both methods, emphasizing best practices and important considerations for users.
- Updated the example tutorial to clarify the manual configuration process and highlight Docker Stack requirements.
2025-12-07 12:25:45 -06:00
Mauricio Siu
dbc753502b docs: expand remote servers documentation with server types
- Added detailed descriptions for two types of remote servers: Deployment Servers and Build Servers.
- Included functionalities and benefits of each server type to enhance user understanding.
- Clarified the configuration process for using build servers in application settings.
2025-12-07 12:14:27 -06:00
Mauricio Siu
61fabbd4ea feat: add build server documentation and update meta.json
- Introduced a new guide for configuring a custom build server, detailing the setup process, prerequisites, and usage.
- Updated meta.json to include the new build server documentation entry, enhancing the overall structure of the remote servers section.
- Renamed the existing instructions file to better reflect its focus on deployment servers.
2025-12-07 11:59:15 -06:00
Mauricio Siu
46798a2403 docs: enhance resource management section in advanced.mdx
- Expanded the documentation on managing memory and CPU resources for applications, including detailed explanations of memory and CPU limits and reservations.
- Added user-friendly examples and formats for input values, ensuring clarity on how to set resource constraints.
- Included important reminders regarding the relationship between memory and CPU reservations and limits.
- Updated the file mount description to clarify its persistence across deployments.
2025-12-07 11:43:32 -06:00
Mauricio Siu
c5d7653a4c feat: add meta.json for Applications documentation
- Introduced a new meta.json file to structure the Applications documentation.
- Included pages for advanced topics, build types, preview deployments, rollbacks, zero downtime, and going production.
2025-12-07 11:34:44 -06:00
Mauricio Siu
a41453f354 feat: add new guides for Cloudflare Tunnels and EC2 setup
- Introduced comprehensive guides for setting up Cloudflare Tunnels and deploying applications on AWS EC2.
- Updated meta.json to include new guide entries, enhancing the documentation structure.
- Removed outdated EC2 instructions to streamline content and improve clarity.
2025-12-07 11:32:01 -06:00
Mauricio Siu
47d5139255 chore: update documentation titles and remove unnecessary entries
- Changed the title of the remote servers documentation from 'Remote Servers' to 'Introduction' for better clarity.
- Removed an unnecessary entry from the meta.json file to streamline the documentation structure.
2025-12-07 11:28:14 -06:00
Mauricio Siu
acfc837c76 fix: update comparison table and improve remote server instructions
- Updated the comparison table to reflect support for Cloudflare Tunnels and added Custom Build Server.
- Enhanced the description in the remote server instructions for clarity and detail.
2025-12-07 11:24:12 -06:00
Mauricio Siu
1388b1266d chore: update documentation and assets for new features
- Enhanced API documentation with new MDX files and improved structure.
- Updated OpenAPI specifications to reflect recent changes and added new components.
- Refined global CSS and layout configurations for better styling and user experience.
- Added various images and icons to enrich the visual aspects of the documentation.
- Updated package dependencies to ensure compatibility with the latest features.
2025-12-07 06:26:03 -06:00
Mauricio Siu
d208d98c35 docs: update installation documentation to include port requirements
- Added a new section detailing the required ports (80, 443, and 3000) for Dokploy installation.
- Included a warning about the necessity of ensuring these ports are free before installation to prevent errors.
2025-11-30 02:08:19 -06:00
Mauricio Siu
7214380f79 docs: add troubleshooting section for 404 errors with Templates and Compose Services
- Introduced guidance on resolving 404 errors related to Traefik routing for services created from templates and Docker Compose.
- Explained the differences in routing configuration between Applications and Templates/Compose Services.
- Provided a step-by-step solution for configuring domains and redeploying services to ensure changes take effect.
2025-11-30 02:00:01 -06:00
Mauricio Siu
8576a3c58b docs: enhance installation instructions for securing Dokploy
- Updated the section on securing the installation by enabling HTTPS, including a reference to the Domains documentation for SSL/TLS configuration.
- Added a warning about the importance of having a working domain with HTTPS before disabling IP:port access.
- Clarified the steps to disable IP:port access after verifying domain functionality.
2025-11-30 01:52:53 -06:00
Mauricio Siu
1ea9c8592b Merge branch 'main' into danielepintore/main 2025-11-30 01:49:42 -06:00
Mauricio Siu
5546da429f Merge branch 'main' into docs/update-uninstall 2025-11-30 01:48:11 -06:00
Mauricio Siu
9989eebf52 docs: remove outdated examples and uninstall documentation 2025-11-30 01:45:13 -06:00
Mauricio Siu
878f7b82bf Merge pull request #89 from fir4tozden/fix/volume-name-updates
fix: volume name updates
2025-11-30 01:43:49 -06:00
Mauricio Siu
346e073c51 chore: remove deprecated API documentation files
- Deleted multiple outdated API documentation files to streamline the documentation structure.
- This cleanup aligns with recent efforts to maintain an organized and efficient documentation system.
2025-11-30 01:31:07 -06:00
Mauricio Siu
6dbf34e2fe chore: update OpenAPI documentation paths and add openapi.json file
- Copied openapi.json to the docs public folder for easier access.
- Updated paths in generated documentation files to reference the new location of openapi.json.
- Ensured all references to openapi.json are consistent across documentation files.
2025-11-30 01:12:13 -06:00
Mauricio Siu
2e5564dea7 chore: update OpenAPI documentation paths and enhance references
- Changed input path for documentation generation from './api.json' to '../../public/openapi.json'.
- Updated multiple generated documentation files to reference the new OpenAPI document path.
- Added new documentation files for 'Environment', 'Gitea', 'Organization', 'Preview Deployment', 'Rollback', 'Schedule', 'Swarm', and 'Volume Backups'.
- Enhanced existing documentation with additional endpoints and improved structure for clarity.
2025-11-30 01:03:04 -06:00
Mauricio Siu
74f902e3d9 Merge pull request #81 from nhridoy/patch-1
docs: Add Dokploy Deploy Action 3 to goodies list
2025-11-30 00:16:26 -06:00
Mauricio Siu
4e70b92740 Merge pull request #85 from nenas1ya/patch-1
docs(troubleshooting): correct instructions for recreate Traefik swarm service
2025-11-30 00:15:59 -06:00
Mauricio Siu
f24f9e8aa0 Merge branch 'main' into patch-1 2025-11-30 00:15:34 -06:00
Mauricio Siu
e58a3d75a9 Merge pull request #79 from Fradd747/docs/update-app-file-mount-desc-and-image
docs: update app file mount desc and image
2025-11-30 00:13:08 -06:00
Mauricio Siu
8fb8b05f5e Merge pull request #73 from microfauna/patch-1
docs: Update Railpack Docs
2025-11-30 00:12:03 -06:00
Mauricio Siu
3c24d631da docs: enhance Cloudflare section by adding detailed steps for using Let's Encrypt and removing redundant instructions 2025-11-30 00:05:07 -06:00
Mauricio Siu
520060d2a4 Merge branch 'main' into docs-add-cloudflare-origin-certs 2025-11-29 23:56:10 -06:00
фырат ёздэн
201bb86539 docs: update uninstall 2025-11-27 03:48:18 +03:00
фырат ёздэн
34d769ad23 docs: update uninstall 2025-11-27 03:48:10 +03:00