From 12a4bfd21ca819a44db430311002482b01debb27 Mon Sep 17 00:00:00 2001 From: Mauricio Siu <47042324+Siumauricio@users.noreply.github.com> Date: Sun, 30 Mar 2025 04:24:06 -0600 Subject: [PATCH] docs: add documentation for watch paths feature in applications and Docker Compose --- apps/docs/content/docs/core/watch-paths.mdx | 31 +++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/apps/docs/content/docs/core/watch-paths.mdx b/apps/docs/content/docs/core/watch-paths.mdx index 4be87f9..39468ac 100644 --- a/apps/docs/content/docs/core/watch-paths.mdx +++ b/apps/docs/content/docs/core/watch-paths.mdx @@ -1,3 +1,34 @@ +--- +title: Watch Paths +description: Learn how to use watch paths in your application or docker compose. +--- + +Watch paths are a feature that allows you to monitor specific directories or files for changes and automatically trigger actions when modifications occur. + +## Overview + +Watch paths functionality is available for both standalone applications and Docker Compose configurations. This feature helps automate deployments based on file changes in your repository. + +## Supported Source Providers + +The following source control providers are supported: + +- GitHub +- GitLab +- Bitbucket +- Git (works with Bitbucket, Github, and GitLab repositories) + +## Basic Usage + +Let's say you have a project with the following directory structure: + +``` +my-app/ +├── src/ +│ ├── index.js +├── public/ +``` + By default, dokploy accepts an array of paths, allowing you to monitor multiple locations. For example: - To trigger deployments when any file in the `src/` directory changes, use the pattern: `src/*`