Skip to content

fix typo

Joe Skeenrequested to merge
joeskeen/HomelabOS:override-typo into dev

The last line of the last example on this page causes an invalid docker compose override error when you try to run the container. I tried to use this format/syntax for my Plex override (also for volumes) and got this error:

root@homelabserver:/var/homelabos/install# systemctl status plex
● plex.service - HomelabOS plex Service
     Loaded: loaded (/etc/systemd/system/plex.service; enabled; vendor preset: enabled)
     Active: activating (auto-restart) (Result: exit-code) since Wed 2022-11-02 15:37:25 UTC; 2s ago
    Process: 868388 ExecStart=/usr/bin/docker-compose -p plex up (code=exited, status=1/FAILURE)
   Main PID: 868388 (code=exited, status=1/FAILURE)

Nov 02 15:37:28 homelabserver systemd[1]: plex.service: Scheduled restart job, restart counter is at 52.
Nov 02 15:37:28 homelabserver systemd[1]: Stopped HomelabOS plex Service.
Nov 02 15:37:28 homelabserver systemd[1]: Started HomelabOS plex Service.
Nov 02 15:37:29 homelabserver docker-compose[868393]: The Compose file './docker-compose.override.yml' is invalid because:
Nov 02 15:37:29 homelabserver docker-compose[868393]: services.plex.volumes contains an invalid type, it should be an array
Nov 02 15:37:29 homelabserver systemd[1]: plex.service: Main process exited, code=exited, status=1/FAILURE
Nov 02 15:37:29 homelabserver systemd[1]: plex.service: Failed with result 'exit-code'.
Nov 02 15:37:32 homelabserver systemd[1]: plex.service: Scheduled restart job, restart counter is at 53.
Nov 02 15:37:32 homelabserver systemd[1]: Stopped HomelabOS plex Service.
Nov 02 15:37:32 homelabserver systemd[1]: Started HomelabOS plex Service.
Nov 02 15:37:33 homelabserver docker-compose[868400]: The Compose file './docker-compose.override.yml' is invalid because:
Nov 02 15:37:33 homelabserver docker-compose[868400]: services.plex.volumes contains an invalid type, it should be an array
Nov 02 15:37:33 homelabserver systemd[1]: plex.service: Main process exited, code=exited, status=1/FAILURE
Nov 02 15:37:33 homelabserver systemd[1]: plex.service: Failed with result 'exit-code'.

Referring to the Docker Compose Overrides documentation: https://docs.docker.com/compose/extends/#adding-and-overriding-configuration, it states:

For the multi-value options ports, expose, external_links, dns, dns_search, and tmpfs, Compose concatenates both sets of values:

original service:

services:
  myservice:
    # ...
    expose:
      - "3000"

local service:

services:
  myservice:
    # ...
    expose:
      - "4000"
      - "5000"

result:

services:
  myservice:
    # ...
    expose:
      - "3000"
      - "4000"
      - "5000"

Thus the example in HomelabOS documentation should correctly include a - prefixing the value "/mnt/NAS/media/video:/media"

Merge request reports