dnix/make-deploy
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

add DEPLOY_SUBPATH documentation

Browse source
This commit is contained in:
Thomas Schneider 2025-04-10 15:37:42 +02:00
parent 0071d31d26
commit ea3f38010c
1 changed files with 3 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -24,6 +24,7 @@ Example `config.mk`:
DEPLOY_PATH = /srv DEPLOY_PATH = /srv
DEPLOY_TYPE = compose DEPLOY_TYPE = compose
DEPLOY_HOSTS = server01.example.com server02.example.com DEPLOY_HOSTS = server01.example.com server02.example.com
DEPLOY_SUBPATH = my-sub-path
DOCKER_IMAGE = dr.example.com/my-project:latest DOCKER_IMAGE = dr.example.com/my-project:latest
DOCKER_LOGIN = 1 DOCKER_LOGIN = 1
@ -36,6 +37,8 @@ Example `secrets.mk`:
DOCKER_USER = root DOCKER_USER = root
DOCKER_PASS = secret1234 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. 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 ## Usage