add DEPLOY_SUBPATH documentation
This commit is contained in:
		
							parent
							
								
									0071d31d26
								
							
						
					
					
						commit
						ea3f38010c
					
				
					 1 changed files with 3 additions and 0 deletions
				
			
		| 
						 | 
				
			
			@ -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
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue