Verified Commit 8e366077 authored by Jakob Moser's avatar Jakob Moser
Browse files

Extend documentation

parent e0969794
Loading
Loading
Loading
Loading
+14 −3
Changes for README.md: 14 added lines, 3 removed lines.
Original line number Diff line number Diff line
@@ -35,6 +35,17 @@ BASE_DIR = Path("/coli")
sudo ./meta.py restart
```

When executed, the script iterates over all directories in the base dir `/coli` and does the following:

1. If the directory has a compose file defining docker services and at least one of them are up, stops them and notes them for later.
2. Restarts Traefik.
3. Restarts all other services.

> [!note] Why the extra step for Traefik?
>
> Traefik is configured to receive a static IP in the container, which other containers need to know to access (yet again) other containers (e.g. if the Node-RED container wants to access the WordPress container). If another services is started before Traefik, it snatches the IP from Traefik, and then Traefik won't start.
> So, this script makes sure Traefik starts first and it gets the IP it wants.

### Update all services

```bash
@@ -43,9 +54,9 @@ sudo ./meta.py update

When executed, the script iterates over all directories in the base dir `/coli` and does the following:

1. If the directory contains a `.git` folder, execute: `git pull`
2. If the directory has a docker compose file (as indicated by `docker compose config`), execute: `docker compose pull` and `docker compose build --pull`
3. If at least one of the services defined in the said docker compose file is running, execute `docker compose up -d`
1. If the directory contains a `.git` folder, executes: `git pull`
2. If the directory has a docker compose file (as indicated by `docker compose config`), executes: `docker compose pull` and `docker compose build --pull`
3. If at least one of the services defined in the said docker compose file is running, executes `docker compose up -d`

> [!note]
>