Skip to content

Commit 77283ef

Browse files
author
Slyke
committed
Added warning when using overrides
1 parent 6091913 commit 77283ef

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/Custom.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,23 @@ Create a file called `compose-override.yml` in the main directory, and place you
1111
3. Using the `yaml_merge.py` script, merge both the `compose-override.yml` and the temporary docker compose file together; Using the temporary file as the default values and interating through each level of the yaml structure, check to see if the `compose-override.yml` has a value set.
1212
4. Output the final file to the main directory, calling it `docker-compose.yml`.
1313

14+
## A word of caution
15+
If you specify an override for a service, and then rebuild the `compose-override.yml` file, but deselect the service from the list, then the YAML merging will still produce that override.
16+
17+
For example, lets say NodeRed was selected to have have the following override specified in `compose-override.yml`:
18+
```
19+
services:
20+
nodered:
21+
restart: always
22+
```
23+
24+
When rebuilding the menu, since the NodeRed service is not longer included, the only values showing in the final `docker-compose.yml` file for NodeRed will be the `restart` key and its value. Docker Compose will error with the following message:
25+
```
26+
Service nodered has neither an image nor a build context specified. At least one must be provided.
27+
```
28+
29+
When attempting to bring the services up with `docker-compose up -d`.
30+
1431
## Examples
1532

1633
### Overriding default settings

0 commit comments

Comments
 (0)