ID.nl logo
Warmtepomp installeren? Denk aan de vergunningsplicht of meldingsplicht
© Nancy Pauwels - stock.adobe.com
Energie

Warmtepomp installeren? Denk aan de vergunningsplicht of meldingsplicht

Je hebt uiteindelijk de knoop doorgehakt… Er komt een warmtepomp. Mag je die dan zomaar op het dak van de aangebouwde garage plaatsen of tegen de voorgevel van je woning? Of kan het gespecialiseerde bedrijf een gat van 90 meter diep in je tuin boren voor een geothermische warmtepomp, zonder dat je daarvoor eerst een vergunning hebt ontvangen? Het antwoord is: Nee.

Het is verstandig om toch op de hoogte te zijn van de regels die overheid oplegt over de plaatsing van warmtepompen. In veel situaties is geen vergunning en zelfs geen melding nodig. Maar er zijn uitzonderingen.

**In dit artikel lees je: **

  • Wat de verschillen zijn tussen een vergunningsplicht en een meldingsplicht
  • Wanneer een van de twee verplicht is
  • Wat de WKO-bodemenergietool is
  • Welke geluidsnormen gelden

Lees ook: Welke typen warmtepompen zijn er?

Welke warmtepomp past bij jou?

Doe de check op Kieskeurig.nl en je weet het binnen 5 minuten!

Of je een vergunning nodig hebt, hangt af van de lokale regelgeving, het type warmtepomp dat je kiest en de plaats waar je ze opstelt. Er wordt in Nederland (nog) niet actief op gecontroleerd, maar beter check je toch vooraf bij de gemeente. Als er een meld- of vergunningsplicht geldt en je hebt dit niet gedaan, dan kan dit leiden tot boetes, de verplichting om de installatie aan te passen of zelfs een bevel om ze te verwijderen. Je hebt er dus baat bij om je goed te informeren.

Tegenwoordig zie je ook buitenunits die op het dak worden geplaatst. Hiervoor gelden dezelfde regels als wanneer de warmtepomp op de grond of aan de muur wordt gehangen.

Vergunningsplicht versus meldingsplicht

Als je een vergunning wilt, dan moet je een formele aanvraag indienen en wachten met de installatie tot je toestemming hebt gekregen. Om een vergunning te krijgen moet je meestal een bouwtekening en een gedetailleerd plan van de installatie indienen. Het installatiebedrijf zal je helpen bij het opstellen van deze documenten.

Een meldingsplicht is een vereenvoudigde procedure voor kleinere bouwprojecten waarbij je de werkzaamheden alleen vooraf moet melden. Je hoeft dus geen goedkeuring af te wachten. In de meeste gevallen is voor het plaatsen van een warmtepomp gelukkig geen vergunning nodig als de buitenunit vanaf de grond gemeten niet hoger is dan 1 meter en de oppervlakte van dit toestel geen 2 vierkante meter bedraagt. Maar er zijn belangrijke uitzonderingen. We stippen eerst kort aan wanneer wel een vergunning of melding vereist is en daarna gaan we dieper in op enkele specifieke gevallen.  

Ook interessant: Haal meer uit je warmtepomp met de juiste instellingen

Vergunning vereist

  • Als de warmtepomp aan de voorgevel wordt bevestigd, dan volgt uit de Omgevingswet en het Besluit Bouwwerken Leefomgeving (BBL) dat deze vergunningsplichtig is. Heb je vragen over deze regelgeving dan kun je altijd contact opnemen met de helpdesk Bouwregelgeving via dit online formulier.

  •  Wanneer de warmtepomp zodanig wordt geplaatst dat de bovenkant 5 meter of hoger uitkomt gemeten vanaf de grond. Wie de warmtepomp dus op een plat dak of een terras op een verdieping plaatst, moet dit dus even nameten.

  • Wanneer de warmtepomp hoger is dan 1 meter en de oppervlakte meer dan 2 vierkante meter bedraagt.

  • Bij een bodemwarmtepomp die gebruikmaakt van een verticale bodemwarmtewisselaar die dieper dan 50 meter wordt geboord. Dat geldt trouwens voor de meeste geothermische warmtepompen, want die gaan dieper.

  •  Wanneer een horizontale of verticale bodemwisselaar wordt toegepast die een warmtedragend medium bevat met gevaarlijke stoffen. De mengeling van water met glycol (antivries), die het meeste wordt toegepast, valt hier niet onder. 

  • Bij een water/waterwarmtepomp waarbij grondwater als warmtepomp wordt gebruikt

  •  Wanneer de buitenunit van de warmtepomp goed zichtbaar is voor de omgeving.

  • Bij monumentale gebouwen of gebouwen die een bijzondere bescherming genieten. Of wanneer je in beschermd stadszicht woont.  

Leestip: Zo houd je het stroomverbruik van je warmtepomp zo laag mogelijk

©Brebca

Meldplicht vereist

De meldplicht hangt af van de lokale regelgeving en het bestemmingsplan van de gemeente. Sommige gemeenten hanteren regels over het uiterlijk van de gebouwen en hoe bepaalde toevoegingen het straatbeeld kunnen beïnvloeden. 

  • Als je de buitenunit vanaf de openbare weg kunt zien, dan moet je dit in principe altijd melden.

  • Wanneer de warmtepomp een totale drijfkracht heeft van meer dan 5 kW.

  • Er wordt gebruikgemaakt van een verticale bodemwarmtewisselaar waarbij maximaal tot 50 meter diep wordt geboord.

DE NIEUWE OMGEVINGSWET

Sinds januari 2024 is de Omgevingswet van kracht, die het doorgaans gemakkelijker maakt om vergunningen te krijgen. Bij discussie over de plaats van de warmtepomp helpt deze wetgeving meestal om eventuele conflicten met de gemeente op te lossen.

In deze nieuwe wet zijn de oude wetten samengevoegd en daarin zijn de nieuwe normen vastgelegd over wat buiten te zien, te ruiken en te horen is. Voor de warmtepompinstallateur wordt het dus eenvoudiger, want dit is een centrale plaats waar alle regels samenkomen voor onder meer het geluid en de plaatsing van de warmtepomp.

Bodemwarmtepomp? Check de WKO-bodemenergietool

Een bodemwarmtepomp moet je altijd melden bij het Omgevingsloket. Controleer dus jouw situatie op het Omgevingsloket. Hier duidt de gemeente de zogenaamde interferentiegebieden aan, want in stedelijke gebieden kunnen bodemsystemen elkaar beïnvloeden. Wanneer in dezelfde buurt verschillende geothermische systemen staan, zullen die elkaar negatief beïnvloeden. Daarom is de regie vanuit de gemeente noodzakelijk.

Wil je in zo’n interferentiegebied een bodemwarmtepomp plaatsen, dan heb je wellicht een eenvoudige vergunning (een OBM-vergunning) nodig. Je kunt dit checken met de WKO-bodemenergietool. Hier lees je door je adres in te geven of je gebruik kun maken van bodemenergie.

💡Wat is bodemenergie?

De term bodemenergie betekent dat je de warmte en/of kou van de bodem gebruikt en in de bodem opslaat. De meest voorkomende toepassingen van bodemenergie zijn warmtepompen met bodemlussen en de verticale bodewarmtewisselaar. De bodemlus bestaat uit een dikwandige kunststof slang waarin een waterglycolmengel wordt gepompt. Het water neemt de warmte van de bodem op en geeft deze door aan de warmtepomp. Een verticale warmtewisselaar is een sonde die diep in de bodem gaat. 

Met de WKO-bodemenergietool lees je of je kunt gebruikmaken van bodemenergie. 

Water/waterwarmtepomp? Let op de registratie en grondwaterheffing

Bij een water/waterwarmtepomp moet je rekening houden met de registratie en de grondwaterheffing. Vraag dan aan de gemeente hoeveel de vergunning kost voor het oppompen van grondwater. Bovendien moet je in dat geval grondwaterheffing betalen, maar hiervoor kun je een volledige of gedeeltelijke vrijstelling krijgen. Zo’n vrijstelling is mogelijk als je een deel van het opgepompte grondwater via de retourput terugvoert naar dezelfde waterdoorvoerende laag. 

De geluidsnormen

De plaats waar je de warmtepomp installeert is belangrijk, want je moet ook aan de geluidsnormen voldoen. De gemeente die eventueel de vergunning aflevert, houdt hier geen rekening mee en neemt hier ook geen verantwoordelijkheid voor.

Sinds april 2021 geldt de landelijke norm dat de geluidsproductie van een nieuwe warmtepomp overdag (van 07:00 tot 19:00 uur) maximaal 45 dB(A) mag bedragen op de erfgrens met de buren. Dit moet je meten bij het maximale vermogen van de warmtepomp. Tijdens de nacht (van 19:00 tot 07:00 uur) moet de geluidsdruk lager zijn, maximaal 40 dB(A). In de nacht wordt de geluidsdruk gemeten als de warmtepomp draait in de stille modus. De komst van deze nieuwe Omgevingswet verandert hier niets aan.

Hoe gaat dit in de praktijk? Je kunt stellen dat een warmtepomp met een geluidslast van 65 dB(A), zonder extra maatregelen zoals een omkasting, bij voorkeur 4 tot 5 meter van de erfgrens moet worden geplaatst. Als je de warmtepomp dichterbij dan 3 meter plaatst, wordt het erg moeilijk om onder de norm van 45 dB(A) te blijven.

Om het geluid tot een minimum te herleiden kun je ook een geluidswerende kap over de warmtepomp plaatsen die het geluid absorbeert. In dit artikel lees je daar meer over. Zo’n omkasting zorgt voor een geluidsreductie van 17 dB(A). Vaak ziet de unit er hierdoor ook nog mooier uit. Het is hoe dan ook verstandig om aan je buren te vertellen dat je een warmtepomp wilt plaatsen.

©Reducd.nl

Het bouwbesluit is streng wat betreft de geluidsnormen van de warmtepomp.

Welke warmtepomp past bij jou?

Doe de check op Kieskeurig.nl en je weet het binnen 5 minuten!
▼ Volgende artikel
Een echte herfstklus: zo maak je je dakgoot schoon
© © 2019, JJ Gouin All Rights Reserved
Huis

Een echte herfstklus: zo maak je je dakgoot schoon

Met de herfst in aantocht dwarrelen de bladeren weer massaal naar beneden – en niet zelden belanden ze in je dakgoot. Samen met ander vuil kan dat de afvoer verstoppen, vooral bij nat weer. Om lekkages en andere problemen te voorkomen, is het verstandig je dakgoot regelmatig schoon te maken. Maar hoe pak je dat aan?

⏱️ Dit artikel in het kort:
  • Gereedschap: dit heb je nodig

  • De dakgoot schoonmaken: hoe vaak en wanneer?

  • Stappenplan dakgoot schoonmaken

  • Dakgoot schoonmaken? Zo doe je het veilig

  • Slimme tips voor een schone dakgoot

Lees ook: 🍂 Herfstklus: zo maak je je tuinmeubilair winterklaar

Gereedschap: wat heb je nodig?

Voor het doorspoelen van je dakgoten is een tuinslang onmisbaar. Monteer hier een dakgootreiniger op: een opzetstuk met borstel en harkje waarmee je vuil verwijdert en de goot grondig schoonmaakt. Met een telescoopsteel kun je zelfs vanaf de grond werken – handig en veilig. Toch is het slim om af en toe de ladder te nemen, zodat je goed kunt zien wat je doet en geen hoeken overslaat.

Lees ook: Zo werk je veilig in de hoogte met een ladder

Handschoenen zijn een must, of het nu tuinhandschoenen of huishoudhandschoenen zijn. Draag daarnaast oude kleding met lange mouwen, want het water dat uit de goot spat is meestal niet schoon.

Zink of kunststof

Dakgoten zijn meestal van zink of kunststof. Bij zinken dakgoten is het extra belangrijk om ze goed schoon te houden, omdat rottende bladeren de beschermende oxidelaag kunnen aantasten.

Een dakgoot heeft altijd een lichte helling, zodat het water naar de regenpijp kan stromen. Met een tuinslang kun je controleren of dit goed werkt. Blijft het water staan, dan moet je de dakgoot repareren. Dit is vooral van belang bij zinken dakgoten vanwege het risico op aantasting van de oxidelaag. Het repareren van een zinken dakgoot is relatief eenvoudig, bijvoorbeeld met rubber seal, reparatietape of vloeibare zink.

Hoe vaak en wanneer schoonmaken?

Eén keer per jaar je dakgoot reinigen is meestal genoeg. Woon je echter tussen veel bomen, dan kun je beter wat vaker aan de slag. Meer blad betekent immers meer kans op verstopping. De beste periode voor de grote schoonmaak is het late najaar: als het niet meer vriest en de meeste bladeren gevallen zijn. Net na een regenbui werkt het schoonmaken makkelijker, omdat het vuil dan losser ligt. Je kunt de goot ook zelf natmaken met de tuinslang.

©bildlove

Stappenplan voor een schone dakgoot

Voordat je begint: veiligheid eerst! Gebruik een stevige ladder die stabiel op een vlakke ondergrond staat. Draag kleding die vies mag worden (bijvoorbeeld een oud shirt met lange mouwen, een stevige broek en rubberen handschoenen) zodat je beschermd bent tegen vuil en scherpe randen.

1 - Verwijder grof vuil

Gebruik een plastic schep, gootschep of oude spatel om bladeren, takjes en ander afval uit de goot te halen. Leg een zeil op de grond of gebruik een emmer of vuilniszak om het netjes te houden. Heb je vooral droog blad in de goot liggen, dan kan een bladblazer met speciaal opzetstuk ook uitkomst bieden.

2 - Spoel alles goed door

Spoel de goot en regenpijp door met een tuinslang, van het ene uiteinde naar het andere. Zo controleer je meteen of het water goed doorstroomt. Blijft er vuil achter, gebruik dan een schuurspons of staalborstel om het te verwijderen.

3 - Controleer op verstoppingen en schade

Kijk tijdens het schoonmaken of er geen blokkades in de afvoerpijp zitten. Gebruik eventueel een ontstoppingsveer. Controleer ook de staat van de goot zelf: scheuren, losse verbindingen of roestige beugels kun je beter direct repareren of vervangen.

4 - Onderhoud op de lange termijn

Een jaarlijkse schoonmaakbeurt houdt je dakgoot in goede conditie. Zo voorkom je dat water blijft staan of in huis doordringt, wat schimmel of vochtproblemen kan veroorzaken.

5 - Maak je dakgoot winterklaar

Voordat de vorst invalt, is een extra controle aan te raden. Blokkades kunnen in de winter leiden tot ijsvorming en schade aan de goot.

❄️ IJsdammen

Een ijsdam ontstaat wanneer smeltwater van sneeuw of ijs op het dak niet goed kan wegstromen door een verstopte dakgoot. Het water bevriest vervolgens aan de randen van het dak, waardoor er een opeenhoping van ijs ontstaat. Dit kan leiden tot ernstige problemen, zoals lekkages, omdat het smeltwater zich onder de dakbedekking kan ophopen en in je huis kan sijpelen. IJsdammen kunnen ook extra gewicht op de dakgoten en het dak veroorzaken, wat schade kan aanrichten.

©Tomasz Zajda


Veilig werken op hoogte

Zorg altijd voor een stevige, stabiele ladder op een vlakke ondergrond. Draag schoenen met grip en overweeg een veiligheidsharnas bij hogere daken. Is de ladder nat, wacht dan tot deze droog is. Laat bij voorkeur iemand in de buurt blijven terwijl je werkt.


Slimme tips voor een blijvend schone goot

Bladvangers helpen, maar houden niet alles tegen. Klein vuil kan alsnog ophopen en zelfs mosgroei veroorzaken. Bevestig tijdens het schoonmaken je emmer of vuilniszak aan de ladder, zodat je beide handen vrij hebt. Laat je het vuil liever op de grond vallen, dan moet je later nog opruimen – extra werk dus.

Een hogedrukreiniger kan handig zijn, maar gebruik een lage stand om schade te voorkomen. Een gewone tuinslang met een goede sproeikop werkt vaak net zo goed.


▼ Volgende artikel
Bouw je eigen dashboard met Homepage: al je webapplicaties overzichtelijk op één plek
Huis

Bouw je eigen dashboard met Homepage: al je webapplicaties overzichtelijk op één plek

Heb je meer dan een handvol webapplicaties op een Linux-server draaien? Dan is een dashboard met links naar deze applicaties een uitkomst. Het project Homepage biedt precies dat, inclusief widgets die allerlei statistieken van je services weergeven. In dit artikel installeren we Homepage en laten we je zien hoe je het integreert met je bestaande services.

Dit gaan we doen

In deze masterclass richten we een persoonlijk dashboard in met Homepage. Je leert hoe je de tool installeert in Docker, services groepeert en uitbreidt met widgets voor statistieken zoals cpu- en geheugengebruik, uptime of weersinformatie. We laten zien hoe je containers automatisch herkent, monitoring toevoegt en ook bladwijzers of alternatieve dashboards gebruikt. Zo krijg je één centrale plek waar je al je webapplicaties en services snel terugvindt en beheert.

Lees ook: Windows gebruiken naast of binnen Linux? Zo krijg je het soepel aan de praat met Docker


⬇️ Code downloaden

In dit artikel staat voorbeelden met YAML-code. Omdat YAML erg gevoelig is voor foute spaties en inspringingen, kun je die code beter downloaden en daarna bekijken of kopiëren. Zie het bestand homecode.txt, beschikbaar via deze link.


Homepage helpt je om diverse webapplicaties in één dashboard te organiseren. Dit is handig als je services in Docker-containers draait of eenvoudig toegang wilt tot de beheerpagina’s van apparaten zoals je modem, router en NAS.

Hoewel dit klinkt als een veredelde bookmark-manager, doet Homepage meer dan alleen links op een pagina verzamelen. Het project ondersteunt widgets voor meer dan honderd services en kan zo bijvoorbeeld het cpu- en geheugenverbruik van je hypervisor of het aantal ongelezen artikels in je RSS-lezer tonen. Je hoeft daardoor vaak zelfs niet op de links te klikken om even snel de status van je services te bekijken.

Docker Compose

We gaan ervan uit dat je een Linux-server hebt waarop je services met behulp van Docker Compose in Docker-containers draait. Homepage draai je dan gewoon in een Docker-container naast je bestaande services, al zijn er ook andere installatie-opties. In ons voorbeeld draaien we Docker op Debian 12. Maak om te beginnen een map waarin de container van Homepage zijn data en configuratie kan opslaan, met deze opdracht:

$ mkdir -p containers/homepage

Zet vervolgens in je bestand docker-compose.yml (het bestand waarin je al je containers definieert) een service voor Homepage:

services:

  homepage:

    image: ghcr.io/gethomepage/homepage:latest

    container_name: homepage

    ports:

      - 3000:3000

    volumes:

      - /home/koan/containers/homepage:/app/config

    environment:

      HOMEPAGE_ALLOWED_HOSTS: debian.home:3000

    restart: unless-stopped

Homepage kun je op diverse manieren installeren.

Homepage opstarten

Wijzig in het gedefinieerde volume de directory vóór de dubbele punt naar het volledige pad van de directory die je voor de container hebt aangemaakt. Stel de waarde van de omgevingsvariabele HOMEPAGE_ALLOWED_HOSTS gelijk aan het domein of het ip-adres van de host, gescheiden door een dubbele punt van het poortnummer. Als je met een reverse proxy werkt, zet je hier het domein waarop de applicatie via die proxy bereikbaar is.

Start de container met:

$ docker-compose up -d

Zodra het image gedownload is en de container draait, open je Homepage in je browser op de url die je in HOMEPAGE_ALLOWED_HOSTS hebt gedefinieerd. Je ziet dan een voorbeeldpagina met van boven naar onder een header, groepen met services en groepen met bladwijzers.

Het standaarddashboard van Homepage vlak na de installatie.

Informatiewidgets

In de header vind je enkele informatiewidgets. Hoewel deze niet de kern van de functionaliteit van Homepage uitmaken, bieden ze nuttige aanvullende informatie. Standaard zie je het cpu-verbruik, het beschikbare geheugen en de vrije schijfruimte van de host. Er is ook een tekstveld om te zoeken via DuckDuckGo. De definitie van deze twee widgets vind je in het bestand widgets.yaml in de directory van de Homepage-container.

In de online documentatie van de informatiewidgets lees je hoe je hun gedrag aanpast. Zo kunnen we de widget Resources ook de uptime van het systeem laten tonen (uptime: true) en met de optie expanded: true meer informatie over de cpu, het geheugen en de schijfruimte laten weergeven. De widget ziet er dan als volgt uit in widgets.yaml:

- resources:

    label: System

    expanded: true

    cpu: true

    memory: true

    uptime: true

    disk: /

Weersomstandigheden

Homepage biedt twee widgets om het weer in de header te tonen: één via Open-Meteo en één via OpenWeatherMap. De eerste vereist geen registratie, dus daarvoor hoef je alleen maar de gps-coördinaten van je locatie in te voeren. In widgets.yaml ziet dat er als volgt uit:

- openmeteo:

    label: Attenrode

    latitude: 50.8773405

    longitude: 4.9213237

    timezone: Europe/Brussels

    units: metric

    cache: 5

    format:

      maximumFractionDigits: 1

Met cache: 5 laten we de widget de weergegevens vijf minuten lang cachen om de servers van Open-Meteo te ontlasten. Verder biedt Homepage nog andere informatiewidgets aan, bijvoorbeeld voor beurskoersen of de datum en tijd.

In de header van Homepage plaats je allerlei informatiewidgets.

Services toevoegen

De kernfunctionaliteit van Homepage ligt uiteraard in het groeperen van services in één dashboard. De standaardconfiguratie voegt drie groepen toe met elk één service. De YAML-code hiervoor vind je in het bestand services.yaml. Vervang die door je eigen groepen. Je kunt bijvoorbeeld een groep Network aanmaken met links naar de beheerinterfaces van je modem/router en accesspoints:

- Network:

  - Proximus:

      href: http://192.168.1.1

      description: Modem

      icon: mdi-web

  - OpenWrt:

      href: http://gl-mt3000.home

      description: Accesspoint

      icon: openwrt

De eigenschap icon kan een absolute url zijn of een naam uit de lijst op de website Dashboard Icons. Begin de naam van een pictogram met mdi- voor een keuze uit Material Design Icons , met si- voor een keuze uit Simple, of met sh- voor een keuze uit Self-Hosted Dashboard Icons.

Ook groepen kunnen een pictogram krijgen. Dat definieer je dan in het bestand settings.yaml:

layout:

  Network:

    icon: mdi-lan-connect

  Infrastructure:

    icon: mdi-server-network

  Services:

    icon: mdi-apps

Services en groepen kun je pictogrammen geven, bijvoorbeeld van de website Self-Hosted Dashboard Icons.

Servicewidgets

Tot nu toe lijkt ons dashboard wat op een veredeld lijstje met bladwijzers. Maar Homepage ondersteunt ook servicewidgets voor meer dan honderd services. Controleer in de lijst of je services ondersteund zijn. Draai je bijvoorbeeld OPNsense op je router, dan krijg je met de volgende widget de processorbelasting, het gebruikte geheugen, en de upload- en downloadhoeveelheden van je WAN-interface te zien:

- OPNsense:

      href: https://opnsense.home

      description: Router

      icon: opnsense

      widget:

        type: opnsense

        url: https://opnsense.home

        username: KEY

        password: SECRET

Voor username en password vul je de API-sleutel en het ‘secret’ in die je in de webinterface van OPNsense aanmaakt via System / Access / Users. De documentatie van Homepage voor de OPNsense-widget legt dit gedetailleerd uit. Wil je slechts een deel van de statistieken zien, dan kan dat door de widget uit te breiden met een regel als:

fields: ["wanDownload", "wanUpload"]

Homepage ondersteunt widgets voor meer dan honderd services.

Meerdere widgets

Je kunt een service ook van meerdere widgets voorzien. Dat is bijvoorbeeld handig bij monitoringtools zoals Uptime Kuma. Voeg aan de OPNsense-service dan de OPNsense-widget toe voor servicespecifieke statistieken en de widget van Uptime Kuma voor beschikbaarheidsstatistieken. In plaats van één object widget bevat de service dan een object widgets met een lijst die beide widgets bevat:

  - OPNsense:

      href: https://opnsense.home

      description: Router

      icon: opnsense

      widgets:

        - type: opnsense

          url: https://opnsense.home

          username: KEY

          password: SECRET

        - type: uptimekuma

          url: https://uptime-kuma.rubus.home

          slug: router

          fields: ["uptime", "incident"]

De widget van Uptime Kuma gebruikt data van een statuspagina. Die moet je dus eerst in Uptime Kuma aanmaken, en de naam van de statuspagina vul je bij slug in de widget in. Als de statuspagina bijvoorbeeld toegankelijk is via https://uptime-kuma.rubus.home/status/router, dan is de slug router.

Homepage kan een statuspagina van Uptime Kuma in een service integreren.

Beschikbaarheid monitoren

Ook zonder speciale monitoringtools kun je met Homepage eenvoudig te zien krijgen of al je services momenteel online zijn. Dat kan met de eigenschap ping of siteMonitor in de service. Voeg bijvoorbeeld aan de service voor OPNsense ping: opnsense.home toe. Homepage stuurt dan regelmatig een ICMP-echopakket (ping) naar de host en toont de beschikbaarheid in de rechterbovenhoek van het kader van de service.

Met siteMonitor: https://opnsense.home daarentegen voert Homepage een HTTP HEAD-verzoek uit naar de url om te controleren of de webpagina beschikbaar is. Zo weet je niet alleen dat de host online is, maar ook dat de webserver tenminste draait en de pagina aanbiedt. Let op dat je hier de volledige url met https:// of http:// dient te gebruiken. De stijl van de getoonde status kun je overigens in settings.yaml aanpassen met bijvoorbeeld statusStyle: dot of statusStyle: basic.

Enkele services met pictogrammen, widgets en statusinformatie.

Docker-containers integreren

Als je services in Docker-containers draait, kan Homepage via de API van de Docker-engine statistieken over die containers opvragen en zelfs automatisch services herkennen. Configureer hiervoor een Docker-instance voor Homepage in docker.yaml. Als je Homepage met de Docker-socket laat verbinden, kan dat met de volgende configuratie:

local-docker:

  socket: /var/run/docker.sock

In je Docker Compose-bestand moet je deze socket als volume in de Homepage-container aankoppelen:

    volumes:

      - /home/koan/containers/homepage:/app/config

      - /var/run/docker.sock:/var/run/docker.sock

Docker Socket Proxy

Een veiliger alternatief om Homepage toegang tot Docker te geven, is via Docker Socket Proxy. Je laat die laatste dan rechtstreeks met de Docker-socket verbinden en de andere containers via een HTTP API beperkte bevoegdheden geven. Voeg daarvoor in je Docker Compose-bestand de volgende service voor Docker Socket Proxy toe:

  docker-socket-proxy:

    image: ghcr.io/tecnativa/docker-socket-proxy:0.3.0

    container_name: docker-socket-proxy

    volumes:

      - /var/run/docker.sock:/var/run/docker.sock:ro

    environment:

      CONTAINERS: 1

    restart: unless-stopped

Standaard geeft Docker Socket Proxy sterk ingeperkte API-toegang tot de Docker-engine, en sowieso alleen-lezen. Met de omgevingsvariabele CONTAINERS: 1 geven we toegang tot informatie over containers, precies wat Homepage nodig heeft.

Wijzig nu in het bestand docker.yaml de definitie van local-docker naar:

local-docker:

  host: docker-socket-proxy

  port: 2375

Omdat de container van Docker Socket Proxy zich in hetzelfde netwerk als Homepage bevindt, is die onder de naam docker-socket-proxy bereikbaar, wat we hier als host invullen.

Maak dan de containers opnieuw aan met de opdrachten:

docker-compose down

docker-compose up -d

Containers monitoren

Containers die in hetzelfde Docker Compose-bestand als Homepage zijn gedefinieerd, kun je nu door die laatste laten monitoren. Je moet dan bij de service in services.yaml de Docker-server en de naam van de container opgeven, bijvoorbeeld:

- Services:

  - FreshRSS:

      href: http://debian.home:8081

      description: Feed aggregator

      icon: freshrss

      server: local-docker

      container: freshrss

De waarde van server is hier de naam van de Docker-instance in docker.yaml, namelijk local-docker. De waarde van container is hier de naam van de container, gedefinieerd in container_name in het Docker Compose-bestand.

Na het herladen van de webpagina van Homepage krijgt de FreshRSS-service de status RUNNING in de rechterbovenhoek of EXITED wanneer de container gestopt is. Klik op de status voor gedetailleerdere statistieken zoals de processorbelasting, het geheugengebruik en netwerkverkeer.

Services automatisch detecteren

Elke keer dat je nu een service toevoegt, moet je de container aan je Docker Compose-bestand toevoegen en een definitie van de service aan het bestand services.yaml van Homepage. Maar Homepage ondersteunt ook het automatisch detecteren van services voor containers met behulp van labels. Met deze aanpak hoef je services.yaml niet meer bij te werken en hoef je slechts één bestand te veranderen. Voor FreshRSS kan dat bijvoorbeeld als volgt:

  freshrss:

    image: docker.io/freshrss/freshrss:1.26.1-alpine

    container_name: freshrss

    ports:

      - 8081:80

    volumes:

      - /home/koan/containers/freshrss/data:/var/www/FreshRSS/data

      - /home/koan/containers/freshrss/extensions:/var/www/FreshRSS/extensions

    environment:

      CRON_MIN: "1,31"

      TZ: Europe/Brussels

    restart: unless-stopped

    labels:

      - homepage.group=Services

      - homepage.name=FreshRSS

      - homepage.href=http://debian.home:8081

      - homepage.description=Feed aggregator

      - homepage.icon=freshrss

In de labels van deze container geef je dus aan dat je in de groep Services een service met de naam FreshRSS toevoegen, met de gegeven link, beschrijving en pictogram. De opties server en container uit de vorige paragraaf zijn met deze aanpak overbodig, omdat Homepage deze automatisch via de API van de geconfigureerde Docker-instance verkrijgt. Na opnieuw het uitvoeren de volgende twee commando’s ontdekt Homepage automatisch de service en voegt deze aan de juiste groep toe:

docker-compose down

docker-compose up -d

Widgets

Op dezelfde manier kun je widgets toevoegen via labels. In het voorbeeld uit de vorige stap voeg je dan de volgende labels toe:

      - homepage.widget.type=freshrss

      - homepage.widget.url=http://freshrss

      - homepage.widget.username=USER

      - homepage.widget.password=PASSWORD

Wil je meerdere widgets aan een container toevoegen, geef dan elk widget een index:

      - homepage.widgets[0].type=freshrss

      - homepage.widgets[0].url=http://freshrss

      - homepage.widgets[0].username=USER

      - homepage.widgets[0].password=PASSWORD

      - homepage.widgets[1].type=uptimekuma

      - homepage.widgets[1].url=https://uptime-kuma.rubus.home

      - homepage.widgets[1].slug=freshrss

Wanneer je nu de container van FreshRSS opnieuw aanmaakt en opstart, detecteert Homepage de widgets en toont ze bij de service.

Alternatieven voor Homepage

Hoewel Homepage een krachtige tool is, zijn er talrijke alternatieven om een dashboard voor al je services te maken, elk met hun eigen benadering. Houd je niet van YAML-configuraties, dan biedt Homarr een gebruiksvriendelijk alternatief om met slepen en neerzetten allerlei services toe te voegen.

Ook populair is Heimdall. Het is minder naar eigen smaak aan te passen dan Homepage of Homarr, maar daardoor eenvoudig om mee aan de slag te gaan.

Bevalt de aanpak met YAML-bestanden je wel, maar ligt Homepage je niet helemaal, kijk dan eens naar Dashy.

Bookmarks

Tot slot kan Homepage ook gewone bladwijzers aan je dashboard toevoegen. Je kunt ze net op dezelfde manier als services groeperen, maar het zijn slechts links zonder extra functionaliteiten zoals widgets en monitoring. Bladwijzers definieer je in het bestand bookmarks.yaml van Homepage, dat er standaard als volgt uitziet:

- Developer:

  - GitHub:

    - abbr: GH

      href: https://github.com

- Social:

  - Reddit:

    - abbr: RE

      href: https://reddit.com

- Entertainment:

  - YouTube:

    - abbr: YT

      href: https://youtube.com

Vervang deze groepen met bladwijzers door jouw eigen keuzes. Dit is bijvoorbeeld handig om alle links naar portaalsites of accounts bij belangrijke diensten op één pagina te verzamelen. Homepage toont dan per groep een lijst met bladwijzers met hun afkorting (de waarde van abbr), naam en het domein van de link.

Wil je in plaats van een afkorting een pictogram bij een bladwijzer tonen, gebruik dan icon in plaats van abbr en geef daar net zoals bij services de naam van een pictogram op. En vul description bij een bladwijzer in om een beschrijving in de plaats van het domein te zien. Ook de groepen van bladwijzers kun je een pictogram geven. Net zoals voor de groepen van services definieer je die pictogrammen in settings.yaml.

Een volledig dashboard van Homepage met header, services en bladwijzers.

En verder

Homepage biedt nog veel meer mogelijkheden dan we hier kunnen behandelen. Vooral in het bestand settings.yaml zijn er nog allerlei aanpassingen mogelijk. Zo kun je een achtergrondafbeelding instellen en daarop allerlei filters toepassen. Ook het thema en het kleurenpalet, die je beide via pictogrammen onderaan de pagina kunt aanpassen, zijn vast in te stellen.

Ook de lay-out van het dashboard is configureerbaar. Zo neemt standaard elke groep een kolom in, waarbij de services onder elkaar komen te staan. Maar met style: row bij een groep laat je de services in die groep naast elkaar in een rij weergeven. Ook het aantal kolommen, de stijl van de header en nog meer zijn in te stellen.

Homepage is tot in de kleinste details aan te passen.

Speciaal voor de jongste Linux-fans

(dit vinden ze zeker leuk!)