Commit Graph

248 Commits

Author SHA1 Message Date
Mauricio Siu
17e1ae05d3 docs: document full service setup for existing Docker Swarm and drop vestigial ADVERTISE_ADDR env
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.
2026-07-07 10:14:50 -06:00
Mauricio Siu
9f004e6d23 Merge pull request #133 from Dokploy/feat/add-teams-provider
docs: Add Microsoft Teams as a notification provider and update relat…
2026-07-07 10:13:56 -06:00
Mauricio Siu
a72311e486 docs: document IPVS kernel requirements and DNSRR workaround for Docker Swarm VIP mode 2026-07-07 09:31:56 -06:00
Mauricio Siu
965ea7f2df docs: add troubleshooting section for Docker DNS failures on Hetzner and similar VPS providers
Documents the fix for builds and domain validation failing with DNS
errors when the provider's default resolvers misbehave inside Docker
containers (reported in Dokploy/website#146 and Dokploy/dokploy#3981).
2026-07-07 09:18:58 -06:00
Mauricio Siu
4bca945f3c fix: exclude Docker-created interfaces from swarm advertise address detection
The install script's get_private_ip() fallback picked the first RFC1918
address from `ip addr show`, which matches the docker0 bridge (172.17.0.1)
when Docker is already installed — an address other swarm nodes can never
reach. Exclude docker0/br-*/veth* interfaces so a real host/VPN interface
wins, and fall back to the public IP when no private interface exists
(e.g. servers with only a public IP).

Verified end-to-end in Ubuntu 24.04 and Debian 13 containers (Docker
pre-installed, WireGuard-like interface, public IP on eth0), plus the
detection logic on Debian 12, AlmaLinux 9, Fedora 44 and openSUSE Leap 15.6.

Fixes #153

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-07 04:59:44 -06:00
Mauricio Siu
c44d9b2d8b docs: update installation and troubleshooting guides for ADVERTISE_ADDR usage
- Clarified instructions for setting the ADVERTISE_ADDR variable when running the installation script with sudo, emphasizing the need to pass the variable inline.
- Added warnings in the installation and troubleshooting sections to prevent confusion regarding environment variable handling with sudo.
2026-07-07 03:39:11 -06:00
Mauricio Siu
c03c59c391 docs: fix typos in going production page
Fixes #164
2026-07-07 03:24:28 -06:00
Mauricio Siu
f3e09d33e0 docs: clarify that custom compose command replaces the default instead of appending
The docs claimed the Command field appends to the default command, but
createCommand in dokploy fully replaces it with the custom command.
Update both pages to describe the override behavior.

Fixes #142

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-07 03:21:53 -06:00
Mauricio Siu
f2012c8204 docs: update manual installation guide to recommend specific version installation
- Added instructions for installing a specific version of Dokploy using the release asset `install.sh`, emphasizing this as the recommended method for older versions.
- Included a note highlighting potential compatibility issues with the latest installation script for older versions.
2026-07-07 03:11:34 -06:00
Mauricio Siu
979a16bd16 docs: remove Redis from architecture documentation
- Updated the architecture documentation to reflect the removal of Redis from the Dokploy setup, ensuring accuracy in the description of the system components.
2026-07-07 02:50:23 -06:00
Mauricio Siu
bcba9f4ded docs: remove Redis references from architecture and installation documentation
- Updated the architecture documentation to reflect the removal of the Redis database from the Dokploy setup.
- Modified the manual installation guide to eliminate Redis configuration instructions.
- Adjusted troubleshooting documentation to indicate that only three containers should be running, following the removal of Redis.
- Cleaned up the installation script by removing Redis service creation commands.
2026-07-07 02:50:14 -06:00
Mauricio Siu
250017cb1b Merge pull request #163 from mikaoelitiana/patch-1
docs: Update authentication instructions
2026-07-06 19:15:14 -06:00
Mauricio Siu
da662c4f3d feat: update Enterprise documentation with additional features and images
- Expanded the description of Enterprise features to include Application Authentication and Unlimited Concurrent Builds, enhancing clarity and detail.
- Added links to specific documentation sections for SSO, Custom Roles, Audit Logs, Whitelabeling, and the new features, improving navigation and user experience.
- Updated images related to the Enterprise features to ensure visual consistency and support the new content.
2026-07-06 18:32:40 -06:00
Mauricio Siu
33d5a296ad feat: update differences and enterprise documentation for clarity and detail
- Revised the "Differences" section to clarify the operational distinctions between Dokploy editions and introduced a comprehensive table summarizing features across Self-Hosted and Cloud options.
- Added a new section in the "Enterprise" documentation outlining the two flavors of Enterprise offerings, detailing their features and operational differences.
- Enhanced the overall structure and clarity of the documentation to improve user understanding of Dokploy's offerings.
2026-07-06 18:24:36 -06:00
Mauricio Siu
c74ff95953 feat: enhance Enterprise documentation with new features and images
- Added detailed sections for Enterprise features including SSO, Custom Roles, Whitelabeling, and Audit Logs, each with descriptive text and accompanying images for better understanding.
- Introduced new images to visually represent the configuration settings for these features, improving the overall documentation quality.
- Updated the existing documentation to include links and references to the new content, ensuring comprehensive coverage of Enterprise capabilities.
2026-07-06 18:18:49 -06:00
Mauricio Siu
41c2e7a072 feat: add Interface Overview documentation page
- Introduced a new documentation page titled "Interface Overview" that provides a visual tour of the Dokploy dashboard, including detailed descriptions and screenshots of major sections such as Home, Projects, Applications, Databases, and more.
- Updated meta.json to include the new "interface-overview" entry for improved navigation.
- Added multiple new images to enhance the visual representation of the dashboard features.
2026-07-06 18:08:40 -06:00
Mauricio Siu
e9bc1e68f7 docs: add Application Authentication feature documentation
- Introduced a new documentation page for Application Authentication, detailing how to protect deployed applications with SSO using oauth2-proxy and Traefik.
- Updated the main SSO index to link to the new Application Authentication section.
- Modified meta.json to include "application-authentication" for navigation purposes.
2026-07-06 04:02:05 -06:00
Mauricio Siu
04c036307d docs: add documentation for concurrent builds feature
- Introduced a new section on how Dokploy manages build and deployment concurrency per server, including configuration details and limits based on the plan.
- Updated meta.json to include the new "concurrent-builds" entry for navigation.
2026-07-06 03:51:20 -06:00
Mika Andrianarijaona
83cbcd2065 docs: Update authentication instructions 2026-05-30 17:50:36 +02:00
iam-eurika
87f56886c4 docs: typo fix in the going-production 2026-05-17 08:17:09 +00:00
Mauricio Siu
5b48176575 docs: add Cloudflare Access + trusted origins troubleshooting section
Documents the login-hangs-behind-Cloudflare-Access issue and the required
configuration (BETTER_AUTH_SECRET, BETTER_AUTH_TRUSTED_ORIGINS, Web Server
host/HTTPS settings) to fix it. Closes #4361.
2026-05-08 22:40:41 -06:00
Mauricio Siu
998c041756 Merge pull request #154 from el-kurto/add-nix-dokploy-goodie
docs: add nix-dokploy to goodies
2026-05-04 14:52:42 -06:00
Mauricio Siu
8b539f1c26 feat: add AI Assistant documentation for Docker Compose template generation
- Introduced a new section detailing the integration of AI providers for generating Docker Compose templates in Dokploy.
- Provided step-by-step instructions for setting up AI providers and generating configurations from natural language prompts.
- Included examples of compatible AI providers and usage scenarios to enhance user understanding and accessibility.
2026-04-08 23:27:51 -06:00
Mauricio Siu
06f3bbb830 feat: enhance Dokploy documentation with cloud and multi-tenancy details
- Updated the cloud documentation to clarify the managed service model and its benefits.
- Added a new section comparing Cloud vs Self-Hosted versions, detailing operational differences.
- Introduced a comprehensive guide on multi-tenancy, explaining resource organization and access control.
- Improved overall structure and clarity of the documentation for better user understanding.
2026-04-08 23:21:02 -06:00
kurt
d114bcefad Update apps/docs/content/docs/core/goodies.mdx
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
2026-03-20 09:34:19 +10:00
kurt
e284e32503 docs: add nix-dokploy to goodies 2026-03-20 09:31:38 +10:00
Mauricio Siu
5b9925a279 feat: introduce Custom Roles and Audit Logs for Enterprise users
- Added documentation for Custom Roles, allowing Enterprise users to create tailored roles with granular permissions.
- Introduced a new Audit Logs section, detailing how to track actions performed by organization members for security and compliance.
- Updated meta.json to include references to the new features.

These enhancements provide greater control and visibility for Enterprise users, improving overall user management and compliance capabilities.
2026-03-17 23:46:34 -06:00
Mauricio Siu
9826b2f28d fix: update health check route in rollback and zero downtime documentation
- Changed the health check route in both rollback and zero downtime deployment sections from `/api/health` to `/health` for consistency and accuracy.
- Ensured that the documentation reflects the correct endpoint for NodeJS applications, enhancing clarity for users.

Close here https://github.com/Dokploy/dokploy/issues/3994
2026-03-16 23:55:44 -06:00
Mauricio Siu
8b00ef7db3 feat: add Zitadel to SSO providers list in meta.json
- Updated the meta.json file to include Zitadel as a supported SSO provider alongside existing options, enhancing the configuration capabilities for enterprise users.
2026-03-16 11:50:58 -06:00
Mauricio Siu
42ddbb24f0 feat: add Zitadel SSO configuration documentation
- Introduced a new guide for configuring SSO with Zitadel, detailing application setup, issuer URL retrieval, and Dokploy integration steps.
- Updated the main SSO index to include Zitadel as a supported provider, enhancing the documentation for enterprise users.
2026-03-16 11:40:26 -06:00
Mauricio Siu
85ef391e99 Merge pull request #149 from Bredo/patch-1
docs: Improve preview deployments documentation with reference to variables
2026-03-10 11:32:15 -06:00
Mauricio Siu
4501b700a2 feat: restructure pricing section and create dedicated pricing page
- Removed the Pricing component from the homepage and created a new dedicated Pricing page.
- Updated navigation links to point to the new Pricing page instead of the homepage section.
- Enhanced the Pricing component with an animated grid pattern for improved visual appeal.
2026-03-10 11:30:09 -06:00
Jonathan Bredo
c0733d69c1 Enhance preview deployments documentation with reference to variables documentation
Added information on referencing generated domain in environment variables for preview deployments.
2026-03-10 17:52:24 +01:00
Mauricio Siu
98238483af feat: add 'patches' to core meta.json
- Updated the core meta.json file to include 'patches' in the list of features, enhancing documentation related to applying patches during the build process.
2026-03-10 10:32:12 -06:00
Mauricio Siu
c99a7502df feat: add documentation for applying patches during build process
- Introduced a new section on patches, detailing how to apply file-level modifications to repositories during builds.
- Included use cases, step-by-step instructions for creating, editing, and deleting patches, and information on managing patches effectively.
2026-03-10 10:30:57 -06:00
Mauricio Siu
4c4b3d7337 feat: add Whitelabeling documentation and update enterprise index
- Introduced a new Whitelabeling documentation page detailing customization options for branding, appearance, metadata, and error pages.
- Updated the enterprise index to include a description of the Whitelabeling feature.
2026-03-10 10:27:15 -06:00
Mauricio Siu
ef4b8ffe3d docs: Add Microsoft Teams as a notification provider and update related documentation
- Included Microsoft Teams in the list of supported notification providers in meta.json.
- Updated overview.mdx to describe Microsoft Teams notifications.
- Created a new teams.mdx file with detailed setup instructions for Microsoft Teams notifications.
2026-02-16 21:24:17 -06:00
Mauricio Siu
f07960cccb docs: Update monitoring feature status for deployment tools comparison
Close here https://github.com/Dokploy/website/issues/52
2026-02-15 21:21:22 -06:00
Mauricio Siu
340e59c0aa Merge pull request #131 from HPaulson/hp/docs-env-fix
docs: Adds warning for env injection in docker-compose
2026-02-15 21:18:58 -06:00
Mauricio Siu
4424847c8e docs: Clarify environment variable injection options for Docker Compose
- Updated the documentation to specify two methods for injecting environment variables into containers: using the `env_file` option to load all variables or referencing specific variables with the `${VAR_NAME}` syntax.
2026-02-15 21:18:09 -06:00
Mauricio Siu
d2fc4db5bb Merge pull request #129 from JOduMonT/patch-1
Include ingress network removal in uninstall steps
2026-02-15 21:13:56 -06:00
Mauricio Siu
e0dd5e4b6b Merge branch 'main' into main 2026-02-15 21:12:40 -06:00
Hunter Paulson
5fa4611d8d docs: Adds warning for .env injection in docker-compose 2026-02-10 20:15:09 -05:00
Mauricio Siu
d77bc3a8b7 Merge pull request #130 from Dokploy/docs/enterprise
Docs/enterprise
2026-02-10 02:24:34 -06:00
Mauricio Siu
3e108f168e Add documentation for Audit Logs and Whitelabeling features
- Introduced new files detailing the Audit Logs and Whitelabeling features for Enterprise users.
- The Audit Logs section outlines logged events, access methods, retention policies, and compliance support.
- The Whitelabeling section describes customization options, configuration steps, and best practices for branding the application.
- These additions enhance the documentation by providing comprehensive guidance on key Enterprise functionalities.
2026-02-10 02:23:58 -06:00
Jonathan DUMONT
ead8a4ce79 Include ingress network removal in uninstall steps
Add command to remove ingress network in uninstall instructions.
2026-02-10 09:07:48 +01:00
Mauricio Siu
0809cc79cc docs: add manual update instructions for Traefik container
Included a new section detailing the steps to manually update the Traefik container in Dokploy, emphasizing the importance of checking for breaking changes in Traefik versions before upgrading.

Close https://github.com/Dokploy/website/issues/127
2026-02-09 01:35:42 -06:00
Mauricio Siu
ec7ed206c9 Merge pull request #122 from Harsh-2909/patch-1
fix: Fixes the step numbers for production deployment doc
2026-02-09 01:17:21 -06:00
Mauricio Siu
6fa1fb6405 Enhance SSO documentation for Auth0 by adding SAML configuration details and troubleshooting sections. Update Azure and Okta documentation to replace 'Entity ID' with 'Issuer URL' for clarity. This improves user guidance for SSO setup across multiple providers. 2026-02-01 19:50:00 -06:00
Mauricio Siu
ab1c76987d Update SSO documentation for Auth0, Azure AD, Keycloak, and Okta to clarify domain usage and enhance troubleshooting sections for OIDC and SAML configurations. 2026-02-01 19:07:16 -06:00