From ea3f38010c5ae6477c3011f0331e912f1b141f91 Mon Sep 17 00:00:00 2001
From: Thomas Schneider <thomas.schneider@chefkoch.de>
Date: Thu, 10 Apr 2025 15:37:42 +0200
Subject: [PATCH] add DEPLOY_SUBPATH documentation

---
 README.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/README.md b/README.md
index dc4693c..dc64d02 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,7 @@ Example `config.mk`:
 	DEPLOY_PATH = /srv
 	DEPLOY_TYPE = compose
 	DEPLOY_HOSTS = server01.example.com server02.example.com
+	DEPLOY_SUBPATH = my-sub-path
 
 	DOCKER_IMAGE = dr.example.com/my-project:latest
 	DOCKER_LOGIN = 1
@@ -36,6 +37,8 @@ Example `secrets.mk`:
     DOCKER_USER = root
     DOCKER_PASS = secret1234
 
+`DEPLOY_SUBPATH` is used to define a location for `DEPLOY_TYPE` = compose that states where the docker-compose.yml is placed at. If that variable is undefined, it is expected to be in projects root.
+
 By setting `DEPLOY_CONFIG_OVERRIDE`, an alternative config can be loaded to override existing configuration settings. This is useful in script calling make deploy or in a `.gitlab-ci.yml` in order to control settings for different targets.
 
 ## Usage