Cumulus MX 5 draaien in Docker op een Synology NAS
Ik draai mijn weerstation-software Cumulus MX nu in een Docker-container op mijn Synology NAS (DS918+) in plaats van op een aparte computer. In dit artikel beschrijf ik de hele procedure, inclusief de valkuilen waar ik tegenaan liep en hoe je een back-up van een oude installatie terugzet.
Waarom geen kant-en-klaar image?
Er is een community-project dat een Docker-image van Cumulus MX bouwt, maar de Dockerfile daarvan is verouderd. Hij is gebaseerd op Ubuntu 20.04 en Mono, voegt een nginx-PPA toe dat niet meer bestaat en haalt sleutels op via een keyserver die op mijn NAS in een time-out liep. Cumulus MX 5 heeft Mono bovendien niet meer nodig, maar draait op .NET 10. Daarom heb ik een eigen, kleine Dockerfile gemaakt op basis van het officiële Microsoft .NET-runtimeimage.
In dit artikel gebruik ik Cumulus MX 5.2.0 (build 5026). Kijk op de releasepagina van Cumulus MX (github.com/cumulusmx/CumulusMX/releases) welke build op dit moment de nieuwste is, en controleer daar ook de naam van het zipbestand bij de assets.
Wat je nodig hebt
- Een Synology NAS met Container Manager (Docker) en toegang tot internet.
- Een weerstation dat via het netwerk met Cumulus MX communiceert. Zit je station aan USB, dan moet je daarnaast het USB-apparaat aan de container doorgeven. Dat valt buiten dit artikel.
- Een teksteditor zoals Notepad++.
Stap 1: de map en de bestanden
Maak op de NAS een nieuwe projectmap, bijvoorbeeld /volume1/docker/mxweather-build, en maak daarnaast een lege map /volume1/docker/mxweather/app aan. In die laatste map komt straks alles wat je wilt bewaren: programma, configuratie, data en back-ups.
Maak in de projectmap drie bestanden aan.
Dockerfile
FROM mcr.microsoft.com/dotnet/runtime:10.0
ARG MX_BUILD=5027
ENV MX_BUILD=${MX_BUILD}
RUN apt-get update \
&& apt-get install -y --no-install-recommends curl unzip ca-certificates tzdata \
&& rm -rf /var/lib/apt/lists/*
RUN mkdir -p /opt/cmx-dist \
&& curl -fsSL -o /tmp/mx.zip \
"https://github.com/cumulusmx/CumulusMX/releases/download/b${MX_BUILD}/CumulusMXDist${MX_BUILD}.zip" \
&& unzip -q /tmp/mx.zip -d /opt/cmx-dist \
&& rm /tmp/mx.zip
COPY entrypoint.sh /entrypoint.sh
RUN chmod +x /entrypoint.sh
WORKDIR /opt/CumulusMX
EXPOSE 8998
ENTRYPOINT ["/entrypoint.sh"]
entrypoint.sh
#!/bin/sh
set -e
APP=/opt/CumulusMX
src=$(dirname "$(find /opt/cmx-dist -name CumulusMX.dll | head -n 1)")
if [ ! -f "$APP/CumulusMX.dll" ]; then
# Eerste start: kopieer MX naar het (lege) volume
echo "Eerste start: Cumulus MX build $MX_BUILD installeren"
cp -a "$src"/. "$APP"/
echo "$MX_BUILD" > "$APP/.mx_build"
elif [ "$(cat "$APP/.mx_build" 2>/dev/null)" != "$MX_BUILD" ]; then
# Nieuwe build in de image: werk de programmabestanden bij, jouw gegevens blijven staan
echo "Bijwerken naar build $MX_BUILD"
if [ -f "$APP/Cumulus.ini" ]; then
cp -a "$APP/Cumulus.ini" "$APP/Cumulus.ini.voor-update"
fi
tar -C "$src" \
--exclude=./Cumulus.ini --exclude=./data --exclude=./backup \
--exclude=./mqtt --exclude=./web --exclude=./Reports \
--exclude=./publicweb --exclude=./MXdiags \
-cf - . | tar -C "$APP" -xf -
echo "$MX_BUILD" > "$APP/.mx_build"
fi
cd "$APP"
exec dotnet CumulusMX.dll
docker-compose.yml
services:
mxweather:
build: .
container_name: MXWeather
restart: unless-stopped
environment:
- TZ=Europe/Amsterdam
volumes:
- /volume1/docker/mxweather/app:/opt/CumulusMX
ports:
- 8998:8998
stdin_open: true
tty: true
Een paar opmerkingen bij deze bestanden:
- Het hele Cumulus MX-programma staat in één volume op de NAS. Je hoeft dus geen losse mappen of een los
Cumulus.inite koppelen, en een update van de container raakt je gegevens niet. execin de entrypoint zorgt ervoor dat het stopsignaal van Container Manager bij Cumulus MX aankomt, zodat het programma netjes afsluit en zijn instellingen wegschrijft.stdin_openenttystaan erin voor het geval Cumulus MX een console verwacht.- Pas het pad van het volume aan als je Docker-share anders heet, en de tijdzone als je niet in Nederland woont.
Stap 2: het project in Container Manager
- Open Container Manager, ga naar Project en klik op Aanmaken.
- Geef het project een naam (bijvoorbeeld
mxweather) en kies als pad de projectmap met de drie bestanden. - Kies Bestaande docker-compose.yml gebruiken.
- Klik door en laat Container Manager de image bouwen en de container starten.
De eerste build duurt een paar minuten. Het log van de build laat zien waar het proces mee bezig is. Op een zuinige NAS-processor kan het langer duren dan je gewend bent.
Stap 3: de wizard doorlopen
Open als de container draait de webinterface van Cumulus MX op poort 8998 van je NAS, bijvoorbeeld http://<ip-van-je-nas>:8998/. Bij de eerste start doorloop je de installatiewizard: je kiest je weerstationtype, de verbinding, je locatie en eenheden. Herstart daarna de container.
De website tonen
Cumulus MX kan zelf webpagina’s genereren. Stel bij de internetinstellingen als lokale kopie-map /opt/CumulusMX/publicweb in. Die map verschijnt op je NAS onder mxweather/app/publicweb. Laat daar Web Station naar wijzen, of upload de map naar je eigen hosting.
Gegevens naar Home Assistant sturen (MQTT)
Cumulus MX kan zijn meetwaarden via MQTT publiceren, zodat Home Assistant er sensoren van maakt. Daarvoor gebruik je een template-bestand. Mijn IntervalTemplate.txt stuurt op elk interval een bericht naar het topic CumulusMX/Interval:
{"topics":[
{
"topic": "CumulusMX/Interval",
"data": "{\"time\":\"<#timehhmmss>\",\"temp\":<#temp rc=y>,\"humidity\":<#hum>,\"wgust\":<#wgust rc=y>,\"rainrate\":<#rrate>,\"rfall\":<#rfall>}",
"retain": false
}
]}
De parameter rc=y bij een tag zorgt ervoor dat een decimale komma als punt wordt doorgegeven, zodat Home Assistant er een getal van kan maken.
Zet het bestand in de map mqtt van je Cumulus MX-installatie (op de NAS dus mxweather/app/mqtt). Vul bij Settings → MQTT settings de gegevens van je MQTT-broker in, inclusief username en password, en geef daar de template op.
Sensoren in Home Assistant
In Home Assistant staan de MQTT-sensoren in een apart bestand, cumulusmx.yaml, in de map mqtt_sensors. In configuration.yaml staat deze verwijzing, die alle bestanden in die map samenvoegt:
mqtt:
sensor: !include_dir_merge_list mqtt_sensors/
Dit is cumulusmx.yaml:
#weerstation
- name: "CMX_time"
unique_id: "CMX_time"
state_topic: "CumulusMX/Interval"
value_template: "{{ value_json.time }}"
- name: "CMX_temp"
unique_id: "CMX_temp"
state_topic: "CumulusMX/DataUpdate"
unit_of_measurement: "°C"
value_template: "{{ value_json.temp }}"
- name: "CMX_humidity"
unique_id: "CMX_humidity"
state_topic: "CumulusMX/DataUpdate"
unit_of_measurement: "%"
value_template: "{{ value_json.humidity }}"
- name: "CMX_wgust"
unique_id: "CMX_wgust"
state_topic: "CumulusMX/DataUpdate"
unit_of_measurement: "m/s"
value_template: "{{ value_json.wgust }}"
- name: "CMX_rainrate"
unique_id: "CMX_rainrate"
state_topic: "CumulusMX/DataUpdate"
unit_of_measurement: "mm/h"
value_template: "{{ value_json.rainrate }}"
- name: "CMX_rainfall"
unique_id: "CMX_rainfall"
state_topic: "CumulusMX/DataUpdate"
unit_of_measurement: "mm"
value_template: "{{ value_json.rfall }}"
- name: "CMX_windspeed"
unique_id: "CMX_windspeed"
state_topic: "CumulusMX/DataUpdate"
unit_of_measurement: "m/s"
value_template: "{{ value_json.windspeed }}"
- name: "CMX_winddir"
unique_id: "CMX_winddir"
state_topic: "CumulusMX/DataUpdate"
unit_of_measurement: "°"
value_template: "{{ value_json.winddir }}"
- name: "CMX_Dew Point"
unique_id: "CMX_dew"
state_topic: "CumulusMX/DataUpdate"
unit_of_measurement: "°C"
value_template: "{{ value_json.dew }}"
- name: "CMX_Windchill"
unique_id: "CMX_wchill"
state_topic: "CumulusMX/DataUpdate"
unit_of_measurement: "°C"
value_template: "{{ value_json.wchill }}"
- name: "CMX_press"
unique_id: "CMX_Barometer"
state_topic: "CumulusMX/DataUpdate"
unit_of_measurement: "mb"
value_template: "{{ value_json.press }}"
- name: "CMX_UV Index"
unique_id: "CMX_UV"
state_topic: "CumulusMX/DataUpdate"
unit_of_measurement: ""
value_template: "{{ value_json.UV }}"
- name: "CMX_Solar Radiation"
unique_id: "CMX_SolarRad"
state_topic: "CumulusMX/DataUpdate"
unit_of_measurement: "W/m²"
value_template: "{{ value_json.SolarRad }}"
- name: "CMX_Heat Index"
unique_id: "CMX_heatindex"
state_topic: "CumulusMX/DataUpdate"
unit_of_measurement: "°C"
value_template: "{{ value_json.heatindex }}"
- name: "CMX_Wind Speed (avg)"
unique_id: "CMX_wspeed"
state_topic: "CumulusMX/DataUpdate"
unit_of_measurement: "m/s"
value_template: "{{ value_json.wspeed }}"
Let op: alleen CMX_time leest het topic CumulusMX/Interval. De andere sensoren lezen CumulusMX/DataUpdate. Dat topic vul je met een tweede template, DataUpdateTemplate.txt, die alle waarden in één bericht naar dat topic stuurt:
{"topics":[
{
"topic": "CumulusMX/DataUpdate",
"data": "{\"time\":\"<#timehhmmss>\",\"temp\":<#temp rc=y>,\"humidity\":<#hum>,\"wgust\":<#wgust rc=y>,\"rainrate\":<#rrate>,\"rfall\":<#rfall>,\"windspeed\":<#wlatest rc=y>,\"winddir\":<#bearing>,\"dew\":<#dew rc=y>,\"wchill\":<#wchill rc=y>,\"press\":<#press rc=y>,\"UV\":<#UV>,\"SolarRad\":<#SolarRad>,\"heatindex\":<#heatindex>,\"wspeed\":<#wspeed rc=y>}",
"retain": false,
"doNotTriggerOnTags": ""
}
]}
Zet ook dit bestand in de map mqtt en geef het bij Settings → MQTT settings op als template voor de data-update. De sleutels in dit bericht komen precies overeen met de value_json-velden in de sensoren hierboven.
Herstart Home Assistant (of herlaad de MQTT-configuratie) nadat je het bestand hebt aangemaakt. De sensoren verschijnen dan onder hun unique_id.
Een oude installatie terugzetten
Had je al een Cumulus MX-installatie, dan hoef je niet opnieuw te beginnen. Je zet een back-up als volgt terug:
- Stop de container in Container Manager.
- Kopieer uit je oude installatie de mappen
dataenbackupnaar de mapmxweather/appop de NAS. - Kopieer ook het bestand
Cumulus.inidaarheen. - Gebruik je eigen template-bestanden, bijvoorbeeld in de map
mqtt? Kopieer die dan ook terug. - Start de container opnieuw.
Let op: de gebruikersnamen en wachtwoorden moet je opnieuw invullen. Ga naar Settings → MQTT settings en vul je username en password weer in. Dat geldt ook voor FTP, als je dat gebruikt. Zolang je dat niet doet, kan Cumulus MX niet inloggen op je MQTT-broker of FTP-server.
Valkuilen
- Regeleinden: maak
entrypoint.shmet Unix-regeleinden (LF). In Notepad++ doe je dat via Bewerken → EOL-conversie → Unix (LF). Met Windows-regeleinden stopt de container direct na het starten met een foutmelding over/bin/sh^Mofno such file or directory. - Bestandsnaam: de Dockerfile heet precies
Dockerfile, met een hoofdletter D en zonder extensie. Notepad++ en Windows zetten er snel.txtachter. Zet in Verkenner de bestandsnaamextensies aan om dat te controleren. - Locatie: alle drie de bestanden staan direct in de projectmap, niet in een submap. Anders meldt Docker dat het de Dockerfile niet kan vinden.
- Poort 80: de community-versie publiceerde ook poort 80, maar die is op een Synology meestal al in gebruik. In deze opzet is poort 80 niet nodig.
Updaten
Om te updaten pas je alleen MX_BUILD in de Dockerfile aan naar het nieuwe buildnummer en bouw je het project opnieuw. De entrypoint ziet dan dat het buildnummer in de image afwijkt van dat op je volume en werkt de programmabestanden bij. Je gegevens en instellingen blijven behouden.
Zo ga je te werk:
- Maak een back-up van de map
app. - Pas
MX_BUILDaan in de Dockerfile en sla het bestand op (met Unix-regeleinden). - Stop het project in Container Manager en kies Verwijderen. De bestanden in
appblijven staan. - Verwijder onder Image de image van het project. Doe je dat niet, dan gebruikt Docker mogelijk de oude lagen en draait de oude build gewoon door. Een build die opvallend snel klaar is, wijst daarop.
- Maak het project opnieuw aan met het pad naar de projectmap. De build duurt weer een paar minuten.
- Controleer onderaan de webpagina van Cumulus MX of het nieuwe buildnummer wordt getoond.
Bij een update overschrijft de entrypoint nooit Cumulus.ini, data, backup, mqtt, web, Reports, publicweb en MXdiags. Voor de zekerheid maakt hij eerst een kopie van Cumulus.ini als Cumulus.ini.voor-update. Let op: als een nieuwe build sjablonen in web of mqtt wijzigt, moet je die zelf bijwerken. Lees daarom de releasenotes.
Draaide je installatie al voordat je deze entrypoint gebruikte, dan is er nog geen buildnummer vastgelegd. De eerste keer behandelt de entrypoint dat als een update naar de build in de image.
Tot slot
Met deze opzet draait Cumulus MX zuinig op je NAS, start het vanzelf op na een herstart en staan al je gegevens op één plek, zodat een back-up simpel is. Veel succes!
![]()