ID.nl logo
Calibre via Docker: boekenplank op je server
© Paolese - stock.adobe.com
Huis

Calibre via Docker: boekenplank op je server

Verzamel je je e-books het liefst centraal op een server? Dan ligt het voor de hand om die verzameling daar ook te beheren. Een van de beste beheerprogramma’s is Calibre. Hoewel dit vaak onder Windows wordt gebruikt, kun je het ook via Docker installeren en gebruiken. Daarna beheer je alles via een browser. We laten zien hoe dat werkt.

Na het lezen van dit artikel weet je hoe je e-books via Calibre Web kunt beheren. Daarvoor ondernemen we de volgende stappen:

  • Docker installeren
  • Calibre instellen
    • Database maken
    • E-books toevoegen
  • Calibre Web configureren
  • Draadloos synchroniseren met Kobo-e-readers

Lees ook: Bladeren in stijl: Hoe kies je de perfecte e-reader?

Code downloaden

In dit artikel staat een voorbeeld van wat YAML-code (en diverse andere commando’s). Omdat YAML erg gevoelig is voor foute spaties, kun je die code beter downloaden en daarna bekijken of kopiëren. Zie het bestand code-calweb.txt.

Calibre is een populair en voor velen vertrouwd programma voor het beheren van e-books, dat al heel lang mee gaat (zie het kader ‘Calibre vereenvoudigt je e-bookbeheer’). De meeste mensen gebruiken het op een pc, maar daar kleven wel wat nadelen aan. Een installatie op een server is praktischer. Een centrale installatie zorgt ervoor dat je gemakkelijker toegang tot Calibre hebt, vanaf verschillende apparaten en met verschillende gebruikers.

Ook de regelmatige software-updates zijn eenvoudiger te installeren, desgewenst zelfs automatisch. Het maken van back-ups is eveneens makkelijker. Op een pc vergeten mensen dat vaak, waardoor bij een crash of herinstallatie van Windows de zorgvuldig opgebouwde verzameling verloren gaat.

In dit artikel gaan we Calibre via Docker draaien. Je kunt de software daarna via een browser gebruiken, met dezelfde vertrouwde gebruikersinterface. We combineren het met Calibre Web. Daarmee kun je, ook weer via de browser, comfortabel je e-books lezen.

Ook de communicatie met e-readers komt aan bod. We laten zien hoe je via Calibre Web rechtstreeks synchroniseert met een Kobo e-reader. En vanuit Calibre gaan we e-books naar een Kindle sturen.

Calibre vereenvoudigt je e-bookbeheer

Calibre is een populair programma voor het beheren van je verzameling e-books. Het is beschikbaar voor Windows, macOS en Linux. Calibre kan op basis van metadata alle relevante informatie over e-books voor je ophalen, zoals beschrijvingen en een omslagafbeelding.

Je kunt de details ook handmatig aanpassen, per bestand of op groepsniveau. Ook converteer je e-books direct in Calibre om ze compatibel te maken met jouw e-reader. Bovendien zijn er de nodige extra’s, zoals het omzetten van nieuwsartikelen naar een e-book op basis van rss-feeds.

De eerste versie van Calibre verscheen in oktober 2006. Dat was kort na de release van de Sony PRS-500, een van de eerste op e-ink gebaseerde e-readers. Aanvankelijk lag de kracht bij de conversie van e-books tussen verschillende formaten. Tegenwoordig staan vooral de beheerfuncties centraal, en de uitgebreide zoek- en sorteeropties. De software is gratis, opensource en vrij aanpasbaar.

Calibre is veruit het bekendste programma voor het beheren van e-books.

1 Calibre (Web) en Docker (Compose)

We gaan in dit artikel Calibre en Calibre Web installeren op een server. Hierbij maken we gebruik van Docker en Docker Compose. Hiervoor gebruiken we een Linux-server met Ubuntu 24.04 LTS. Voor het werken met Docker installeren we Docker CE (Community Edition). Daar zijn installatiegidsen voor. Hierna kun je zowel Docker als Docker Compose gebruiken.

Zorg dat het systeem dat je gaat gebruiken genoeg geheugen heeft. Er is geen schokkende hoeveelheid voor nodig, maar 2 GB is geen overbodige luxe. Dit heeft vooral te maken met de ‘remote desktop’-opzet: op de achtergrond wordt een VNC-verbinding opgezet om de gebruikersinterface van Calibre weer te geven. Gebruik je een container in Proxmox VE, dan is 4 GB een veilige bovengrens. Meestal ligt het geheugengebruik rond 500 MB, maar tijdens het gebruik loopt dat snel op naar 1 GB met wat uitschieters naar boven.

Alle e-books staan bij onze opzet op een NAS. Daarom koppelen (‘mounten’) we die map aan het systeem, op de locatie /mnt/nas/boeken. Die locatie gaan we (in de volgende paragraaf) als volume toevoegen aan Calibre. Het voordeel is dat je vanuit Calibre gemakkelijk door die map kunt bladeren om e-books toe te voegen aan de bibliotheek in Calibre zelf.

Zorg dat je op het systeem over Docker en Docker Compose beschikt.

2 Docker Compose

Op het systeem maken we een mapje voor Calibre en plaatsen daarin een bestand docker-compose.yml met de onderstaande inhoud. We kiezen voor zowel Calibre als Calibre Web het Docker-image van het bekende LinuxServer.io.

Mogelijk zijn voor jouw situatie wat aanpassingen nodig. De belangrijkste opties nemen we in de volgende twee paragrafen met je door. Bij twijfel kun je ook de documentatie voor de genoemde Docker-images raadplegen. Bij de uitleg maken we onderscheid tussen de host en de container. De host is daarbij uiteraard jouw server met Docker.

Met de hulp van Docker Compose beheren we de instellingen voor beide containers.

3 Volumes koppelen

Volumes zorgen feitelijk voor de mogelijkheid bestanden uit te wisselen tussen de host en container. Voor Calibre maken we onder volumes: een koppeling tussen de map ./config op de host en /config in de container. Hier bewaart Calibre de configuratie en straks ook de Calibre-bibliotheek.

Verder koppelen we de gemounte map /mnt/nas/boeken met daarin alle ongesorteerde e-books aan /media. Binnen Calibre kun je straks door de map /media bladeren om eenvoudig e-books aan je bibliotheek toe te voegen.

Optioneel kun je een map, zoals de hier voorgestelde map /mnt/nas/boeken/Toevoegen, koppelen aan de container onder bijvoorbeeld /toevoegen. We laten in paragraaf 7 zien hoe je met een kleine aanpassing de e-books in die map automatisch aan Calibre kunt toevoegen. Bij de container voor Calibre Web zie je onder volumes: alleen de koppeling met de lokale map ./config. Daar staat straks de bibliotheek van Calibre, die we bij de configuratie van Calibre Web alleen nog hoeven aan te wijzen. Controleer voor beide containers onder environment: de waardes bij PUID en PGID. Dat is de ID van respectievelijk de eigenaar en groep van de gekoppelde volumes. Deze waardes kun je nagaan met de opdracht id gebruiker. Dit voorkomt problemen met rechten bij bestandstoegang.

In een onderliggende map worden de configuratie en bibliotheek bewaard.

Back-up maken van Calibre

Het is raadzaam om af en toe een back-up te maken van Calibre en Calibre Web. Het gaat hierbij om het bestand docker-compose.yml en de onderliggende map config. In de map met het bestand docker-compose.yml kun je daarvoor de onderstaande opdracht geven. Bewaar vervolgens het bestand calibre.tar op een veilige plek. Gebruik deze opdracht:

tar --exclude=config/.cache -cvf calibre.tar docker-compose.yml config/

Hierbij sluiten we overigens de folder .cache die in de map config te vinden is uit.

4 Poorten configureren

Er zijn voor beide containers poorten gekoppeld. Dit zie je onder ports:. Het poortnummer links is steeds de poort op de host. Die mag je eventueel veranderen, bijvoorbeeld omdat een poort (zoals de populaire poort 8080) al in gebruik is. Het poortnummer rechts is de poort in de container. Die mag je niet veranderen. We houden hier dezelfde poortnummers aan. Bij de container voor Calibre geeft poort 8080 toegang tot Calibre zelf en poort 8081 dient voor de ingebouwde contentserver (zie paragraaf 8 en het kader ‘Inhoudsserver van Calibre gebruiken’). Calibre Web maken we via poort 8083 toegankelijk.

Poort 8083 geeft toegang tot Calibre Web, waarmee je e-books via een browser kunt lezen.

5 Beheer van de containers

Als je alle gewenste aanpassingen hebt gemaakt en de configuratie hebt bewaard, kun je beide containers starten met één opdracht:

docker compose up -d

Om de containers te stoppen, geef je deze opdracht:

docker compose down

Merk op dat er regelmatig updates verschijnen voor Calibre, waar je ook een melding van zult krijgen. Je hoeft dan in Calibre zelf niets te doen. Enkele commando’s vanaf de opdrachtregel volstaan. Stop als eerste de containers met:

docker compose down

Haal dan de nieuwe images op waarop de containers zijn gebaseerd. Dit kan in één keer met:

docker compose pull

Daarna kun je de containers opnieuw starten met:

docker compose up -d

Daarbij zullen de containers op basis van de nieuwe images worden opgebouwd. Controleer eventueel de status met:

docker ps

Dit laat zien welke containers actief zijn en welke poorten ze gebruiken.

Via enkele eenvoudige commando’s kun je de Docker-containers beheren.

6 Eerste stappen in Calibre

We gaan nu verder in de browser en beginnen met het instellen van Calibre. Log in op het ip-adres van het systeem waarop Calibre staat en poort 8080, zoals http://ipadres:8080. Kies in het eerste scherm Nederlands als taal. Kies daarna de locatie voor de bibliotheek voor Calibre. Hier worden alle toegevoegde boeken naartoe gekopieerd. We accepteren de standaardlocatie /config/Calibre Bibliotheek.

In het volgende scherm kies je je type e-reader. We kiezen voor een model van Kobo. Klik op Volgende om verder te gaan en dan Voltooien. Je komt nu direct in Calibre. Als je eerder met deze software hebt gewerkt, zal de gebruikersinterface vertrouwd zijn. Je ziet nog maar één boek in je Calibre-bibliotheek: de snelstartgids voor het werken met Calibre. Tijd dus voor wat extra leesvoer!

Bij het eerste gebruik moet je enkele instellingen aanpassen.

7 Boeken toevoegen

Om een e-book toe te voegen aan Calibre ga je naar Boeken toevoegen. Blader via de bestandsbeheerder vervolgens naar /media. Hier zie je de gemounte map met alle e-books. Wil je ook automatisch boeken aan Calibre kunnen toevoegen? Dit kun je instellen onder Voorkeuren. Kies onder Importeren/Exporteren de optie Boeken toevoegen. Op het tabje Automatisch toevoegen kun je naar de map bladeren waar de automatisch toe te voegen e-books staan. In ons voorbeeld is dat /toevoegen. Alle boeken die je in die map zet, zullen automatisch aan Calibre worden toegevoegd en daarna uit die map worden verwijderd. Kies na deze wijziging voor het herstarten van Calibre.

Boeken in deze speciale map worden automatisch aan Calibre toegevoegd.

8 Calibre Web

Met Calibre Web kun je een Calibre-database via een browser toegankelijk maken, zodat je door je verzameling e-books kunt bladeren en deze kunt lezen of downloaden. Het geeft je meer mogelijkheden dan de contentserver van Calibre (zie kader ‘Inhoudsserver van Calibre gebruiken’). Zo kun je in Calibre Web boekenplanken maken en beheren. Deze kun je vervolgens synchroniseren met een Kobo e-reader.

Open om te beginnen Calibre Web op poort 8083, zoals http://ipadres:8083. Hier log je in met het initiële gebruikersaccount (gebruikersnaam admin en wachtwoord admin123). Eerst wordt gevraagd naar de locatie van de database van Calibre. Blader hiervoor naar /config/Calibre Bibliotheek en kies Select. Bewaar de instelling met Save. Als je naar Books gaat, zie je nu ook de eerdergenoemde gids voor Calibre en de boeken die je mogelijk zelf al had toegevoegd.

Voeg je in het vervolg in Calibre een boek toe, dan verschijnt deze ook direct in Calibre Web, omdat ze de database delen. Het is raadzaam om de taal van de gebruikersinterface op Nederlands te zetten. Klik daarvoor op je naam (admin) om je profiel te openen. Bij Language kies je Nederlands. Klik daarna op Save.

In Calibre Web verwijzen we naar de bibliotheek van Calibre.

Inhoudsserver van Calibre gebruiken

Calibre heeft een ingebouwde contentserver ofwel inhoudsserver. Schakel je deze in, dan kun je met een browser door je bibliotheek bladeren, en e-books te lezen of downloaden. Er is wat functionaliteit betreft wat overlap met Calibre Web. Je kunt ze eventueel naast elkaar gebruiken.

Voor de inhoudsserver hebben we poort 8081 op de host gekoppeld met poort 8081 in de container. Om de inhoudsserver te starten, ga je in Calibre naar Verbinden/delen en kies je Inhoudsserver starten. Open je browser en bezoek het ip-adres met poort 8081. Hier kun je je Calibre-bibliotheek bekijken. Dat kan ook direct vanaf de browser van een e-reader.

Er zijn ook andere, handigere methodes om e-books over te zetten. In dit artikel komt een directe synchronisatie met Kobo aan bod (paragrafen 9 en 10) en het versturen naar een Kindle vanuit Calibre (paragraaf 11).

De inhoudsserver maakt je bibliotheek beschikbaar via een browser.

9 Boekenplanken maken

Calibre Web kent het principe van boekenplanken, waarvan het beheer overigens los staat van Calibre. Begin hiervoor in het menu aan de linkerkant met Boekenplank maken. Open je vervolgens een e-book, dan kun je deze toevoegen aan een of meerdere boekenplanken. Handig aan de e-reader van Kobo is dat hij je boekenplanken met inhoud weergeeft in je bibliotheek als je naar het tabje Verzamelingen gaat. Hiervoor moet je de e-reader synchroniseren met Calibre Web. Je zou bijvoorbeeld een boekenplank kunnen maken voor boeken die je binnenkort wilt lezen. Of een boekplank voor elk genre. Ook kun je voor een specifieke e-reader een boekenplank maken. In de volgende paragrafen leggen we uit hoe je boekenplanken met je Kobo-e-reader kunt synchroniseren.

Je kunt boekenplanken maken voor synchronisatie met je e-reader.

10 Synchronisatie

Je kunt een e-reader van Kobo draadloos synchroniseren met Calibre Web. Hiervoor ga je naar het menu Beheer. Kies onder Instellingen de optie Bewerk basisconfiguratie. Onder het kopje Geavanceerde opties zet je vinkjes bij Zet Kobo sync aan en Proxy onbekende verzoeken naar Kobo winkel. Met die laatste optie zul je op je e-reader bij synchronisatie ook nog steeds boeken ontvangen die je bijvoorbeeld via bol.com hebt gekocht.

Op zoek naar leesvoer?

Koop een e-book bij bol

Controleer of de correcte poort is ingesteld voor Calibre Web (wij gebruiken de standaardpoort 8083). Als je een ander poortnummer hebt gekozen, moet je dat hier wijzigen. Kies daarna Opslaan. Open nu je profiel door op je gebruikersnaam te klikken (standaard is dat admin). Klik bij Kobo Sync Token op Aanmaken/Bekijken. Kopieer nu de regel die er als volgt uitziet:

api_endpoint=http://10.0.10.37:8083/kobo/faa613c4e5d334a3d82210b157bb0e

Sluit je Kobo e-reader aan op de pc. Blader naar de map .kobo/Kobo en open het bestand Kobo eReader.conf. Zoek naar de regel met api_endpoint. De standaardconfiguratie ziet er meestal als volgt uit:

api_endpoint=https://storeapi.kobo.com

Verander deze regel naar de voorgestelde configuratie van Calibre Web. Als de bewuste regel (nog) niet bestaat, moet je deze aanmaken onder de groep [OneStoreServices].

We maken een aanpassing aan de configuratie van Calibre Web.

Selectief boekenplanken synchroniseren

Standaard worden met een Kobo-e-reader alle boekenplanken gesynchroniseerd. Wil je alleen één of enkele boekenplanken synchroniseren? Ga dan naar je profiel (veelal admin). Zet een vinkje bij Synchroniseer alleen boeken op geselecteerde boekenplanken met Kobo en kies Opslaan. Open daarna een boekenplank en kies Bewerk boekenplank eigenschappen. Met een vinkje kun je kiezen of die boekenplank met een boekenplank met een Kobo-apparaat moet worden gesynchroniseerd.

Naar voorkeur kun je ook één of enkele boekenplanken synchroniseren.

11 Kindle-e-reader

De Kindle van Amazon is een populair alternatief voor Kobo, dat wel werkt met een eigen ecosysteem. Heb je e-books in een afwijkend formaat, bijvoorbeeld drm-vrije epub-bestanden, dan kun je deze per e-mail naar een Kindle sturen. Dit gaat via de servers van Amazon, waar ze worden geconverteerd naar een geschikt formaat. Het e-mailadres waar je boeken naar kunt sturen kun je achterhalen door op je Kindle de instellingen te openen. Je ziet het @kindle.com-adres onder E-mail voor versturen naar Kindle. Je kunt hier direct vanuit Calibre e-books naar sturen.

Ga daarvoor in Calibre naar Voorkeuren. Kies onder Delen de optie Deel boeken via e-mail. Vul onder E-mail het e-mailadres van de Kindle in. Vul ook je e-mailadres als afzenderadres in onder Afzender e-mail. Je kunt eventueel een server instellen voor het versturen, maar het werkt meestal ook zonder.

Klik nu in Calibre met rechts op een e-book. Het menu Verbinden/delen geeft de optie voor het versturen per er-mail. Je e-book verschijnt hierna vanzelf op je Kindle. Mislukt de conversie, dan ontvang je een e-mailbericht van Amazon. Het is vrijwel altijd op te lossen met een trucje: converteer het e-book binnen Calibre naar het formaat .mobi. Converteer het daarna terug van .mobi naar .epub. Probeer vervolgens opnieuw het e-book naar je Kindle te sturen.

Je kunt per e-mail boeken delen met bijvoorbeeld een Kindle-e-reader.

Inspiratie voor extra leesvoer

Hebban is een leuke website om inspiratie voor nieuwe boeken op te doen. Je vindt er een enorme catalogus met Nederlandstalige boeken, voorzien van meer dan 5,6 miljoen beoordelingen en recensies. Er zijn ook veel lijstjes, zoals de tiplijst met boeken van de laatste dertig dagen, de Hebban Rank met de duizend populairste boeken van dit moment en een lijst met de duizend mooiste boeken aller tijden. Die laatste lijst wordt samengesteld op basis van de persoonlijke tiplijsten van duizenden leden. Je kunt op de website ook zelf een lijstje bijhouden met boeken die je interessant vindt. De meeste boeken zijn uiteraard ook als e-book verkrijgbaar. Een internationaal alternatief is Goodreads.

▼ Volgende artikel
Pushnotificaties vanaf je thuisserver: zo werkt ntfy
© ID.nl
Huis

Pushnotificaties vanaf je thuisserver: zo werkt ntfy

Als je services op je eigen thuisserver draait, wil je daar ook eenvoudig meldingen van kunnen ontvangen. Ntfy stelt je in staat om eenvoudig pushnotificaties naar je telefoon of computer te sturen. Bovendien kun je ntfy op je eigen thuisserver draaien, zodat je alles in eigen handen hebt. In dit artikel gaan we ermee aan de slag.

Dit gaan we doen

In dit artikel zetten we een ntfy-server op die je zelf beheert. We regelen eerst de randvoorwaarden: hoe je server van buitenaf bereikbaar wordt (bijvoorbeeld via vpn of portforwarding) en hoe je https netjes afhandelt met een reverse proxy en een certificaat van Let's Encrypt. Daarna bouwen we de basis: configuratiebestand, opslagmappen en een draaiende container met Docker.

Vervolgens maken we gebruikers en rechten aan, zodat niet iedereen zomaar kan publiceren of meelezen. Je test met de webinterface en met de mobiele app, zodat je zeker weet dat meldingen ook echt binnenkomen. Tot slot koppel je ntfy aan je eigen tools: eerst met een simpele curl-oproep vanuit een shellscript, daarna met extra's zoals titel, prioriteit en tags. Als je wilt, breid je dat uit naar meldingen met bijlagen, acties (doorklikken naar een url) en integratie vanuit Python. 

Lees ook: Je oude Windows-pc als thuisserver: zo zet je Jellyfin en Syncthing op

Netwerkmonitoringsoftware, een programma dat je Docker-containers bijwerkt, een smarthomecontroller, back-upsoftware, ze hebben allemaal één ding gemeen: ze moeten je meldingen kunnen sturen als er iets gebeurt. Dat kan op verschillende manieren: via e-mail, instant messaging of pushnotificaties naar je telefoon. Dat laatste verloopt doorgaans via een gecentraliseerde dienst zoals Firebase Cloud Messaging (voorheen Google Cloud Messaging) of Apple Push Notification service.

Pushnotificaties zijn handig omdat ze bijna onmiddellijk aankomen en omdat zowel Android als iOS toestaan om in te stellen hoe je ervan op de hoogte wordt gebracht. Wil je pushnotificaties kunnen ontvangen zonder een server onder controle van een partij zoals Google of Apple, dan moet je ook hiervoor je eigen service installeren. Een opensource-project dat dit implementeert, is ntfy.

Werking van ntfy

Je ntfy-server ontvangt meldingen van je programma's via http over een REST-API en zet deze om in pushnotificaties voor de bijbehorende Android- of iOS-app of voor een webpagina op je computer. De API is in de documentatie van het project beschreven, zodat je ook je eigen software met ntfy kunt laten praten. Het project heeft ook een command-line-interface, zodat je bijvoorbeeld shellscripts op je Linux-server eenvoudig pushnotificaties kunt laten verzenden.

Ntfy gebruikt het bekende publish/subscribe-patroon. Een zender publiceert notificaties op een specifiek onderwerp door data te sturen naar een url via een http POST- of PUT-aanvraag. Het onderwerp wordt gedefinieerd door een segment van de url dat volgt op de domeinnaam. Een ontvanger kan zich dan abonneren op dit onderwerp. Elke keer dat de zender daarna een notificatie op dit onderwerp publiceert, stuurt ntfy de data naar alle ontvangers die zich op dit onderwerp hebben geabonneerd. Door ntfy op je eigen server te installeren, heb je de volledige controle over deze notificaties.

Met ntfy kun je services pushnotificaties laten verzenden naar je telefoon of computer.

Serververeisten

De mobiele app van ntfy moet met je server kunnen communiceren om te vragen of er notificaties zijn. Als je ntfy op een server in je lokale netwerk installeert, moet die dus van buitenaf bereikbaar zijn. Dat kun je met portforwarding in je modem regelen of door je telefoon buitenshuis automatisch met een VPN-server op je lokale netwerk te laten verbinden. Heeft je internetaansluiting thuis geen vast ip-adres, dan moet je ook een DynDNS-updater te draaien.

Een andere optie is om ntfy op een VPS (Virtual Private Server) te installeren. Hierop draai je dan ook een reverse proxy voor https-toegang, die een TLS-certificaat van Let's Encrypt opvraagt. Je hebt dan een domein nodig, waarvoor je een DNS A-record naar het ip-adres van je server laat verwijzen. In de rest van dit artikel gaan we uit van een installatie van ntfy op een lokale server met Debian 13 ("trixie") met behulp van Docker Compose.

Basisconfiguratie

Creëer eerst enkele directory's voor ntfy:

$ mkdir -p containers/ntfy/{cache,etc,lib}

Creëer dan het bestand containers/ntfy/etc/server.yml met de volgende configuratie voor ntfy:

base-url: "https://ntfy.example.com"

cache-file: "/var/cache/ntfy/cache.db"

attachment-cache-dir: "/var/cache/ntfy/attachments"

auth-file: "/var/lib/ntfy/user.db"

auth-default-access: "deny-all"

Vervang het domein achter base-url door het domein waarop je ntfy-server draait. Als je gebruikmaakt van een reverse proxy, dan moet dit de url zijn die door de proxy naar ntfy wordt doorgestuurd. Bovendien moet je dan ook een regel behind-proxy: true toevoegen. In de documentatie van ntfy staan voorbeeldconfiguraties voor nginx, Apache2 en Caddy.

Met auth-default-access: "deny-all" tot slot heeft standaard niemand toegang tot onderwerpen. Elke toegang moet dus expliciet worden toegestaan.

Account bij ntfy.sh

De ontwikkelaar van ntfy draait een publiek beschikbare ntfy-server op ntfy.sh. De webinterface daarvan is bereikbaar op https://ntfy.sh/app. Die kun je gratis gebruiken, bijvoorbeeld om ntfy uit te proberen, maar dat komt met beperkingen. Zo kun je geen onderwerpen reserveren en is er een maximum van 250 notificaties per dag en 2 MB per bijlage. Verder is er geen enkele vorm van authenticatie. De enige manier van beveiliging ligt dus in het geheimhouden van je onderwerpen. Die beperkingen heb je niet als je ntfy zelf installeert. Maar als je liever niet zelf een installatie onderhoudt, kun je een betaald plan nemen. Daarmee ondersteun je ook de ontwikkeling van het opensource-project. Dat begint met een Supporter-plan van 5 dollar per maand (circa 5 euro), waarmee je drie onderwerpen kunt reserveren en 2.500 notificaties mag sturen met maximum 25 MB per bijlage.

Betaal voor gebruik van de publieke ntfy-server en ondersteuning van het opensource-project.

Docker Compose

Definieer nu de container in het bestand docker-compose.yaml:

services:

  ntfy:

    image: binwiederhier/ntfy

    container_name: ntfy

    command: serve

    restart: always

    environment:

      - TZ=Europe/Amsterdam

    volumes:

      - ./containers/ntfy/cache:/var/cache/ntfy

      - ./containers/ntfy/etc:/etc/ntfy

      - ./containers/ntfy/lib:/var/lib/ntfy

    ports:

      - 80:80

Ga je voor de aanpak met een reverse proxy, dan definieer je in ditzelfde bestand ook een container voor die reverse proxy.

Start daarna de container met:

$ docker-compose up -d

Als alles goed gaat, is de webinterface van ntfy daarna bereikbaar op het ingestelde domein of ip-adres. Bovenaan links zie je een melding Notifications are disabled. Klik op Grant now om notificaties in je webbrowser toe te staan, en bevestig dit daarna in het dialoogvenster dat je webbrowser toont.

Sta notificaties in je webbrowser toe.

Lees ook: Docker op je NAS: zo draai je Plex, Home Assistant en meer

Notificaties testen

Omdat je ntfy zo geconfigureerd hebt dat alle toegang standaard wordt geblokkeerd, kun je nog niets doen in de webinterface. Je dient dus eerst gebruikers aan te maken en die de toelating te geven om op specifieke onderwerpen te publiceren of zich te abonneren. Open daarvoor een shell in de container van ntfy met de opdracht docker exec -ti ntfy /bin/sh. Als je daarna ntfy user list intypt, krijg je te zien dat anonieme, niet geauthenticeerde gebruikers geen enkele permissies hebben. Met de opdracht ntfy user add --role=admin admin voeg je dan een admin-gebruiker met de naam admin toe. Gebruikers met de rol admin kunnen op alle onderwerpen publiceren en zich erop abonneren. Geef de gebruiker een wachtwoord en bevestig.

Klik nu in de webinterface van ntfy links op Settings en dan onder Manage users op Add user. Vul de url van je ntfy-server in, de gebruikersnaam admin en het wachtwoord dat je zojuist hebt ingesteld. Klik dan links op Subscribe to topic. Kies een naam of klik op Generate name om ntfy een willekeurige naam te laten kiezen en abonneer je dan op het onderwerp met Subscribe. Klik dan op Publish notification en vul hetzelfde onderwerp in. Voer ook een titel en een bericht voor je notificatie in en klik op Send. Als alles goed gaat, verschijnt je testbericht nu in een 'conversatie' met de naam van het onderwerp, en wijst je webbrowser je op een notificatie.

Publiceer notificaties in je webbrowser.

Gebruikersrechten

De webapplicatie is leuk voor een test, maar een mobiele app is vaak handiger. De app van Ntfy voor Android en iOS stelt je in staat om op je telefoon je te abonneren op onderwerpen (publiceren is niet mogelijk) en daarvoor notificaties te ontvangen. Als je de Android-app via F-Droid installeert, is dat zonder ondersteuning voor Firebase; de versie op Google Play gebruikt wél de servers van Google. Je maakt voor je app bij voorkeur een gebruiker aan die alle onderwerpen alleen kan lezen. Dat doe je weer in de shell van de container van ntfy met ntfy user add android om de gebruiker android aan te maken (voer een wachtwoord in) en dan ntfy access android "*" read-only voor de leesrechten.

Open daarna de Android-app en tik op de drie stippen rechtsboven. Kies Settings en stel dan Default server in op het domein van je ntfy-server. Tik daarna op Manage users en Add new user en vul de url van je ntfy-server in, de gebruikersnaam android en het bijbehorende wachtwoord. Tik dan op Add user. Keer dan terug naar het hoofdscherm van de app en klik op het plusicoontje rechtsonder. Voer het onderwerp in dat je tijdens de test in stap 5 hebt gebruikt en tik op Subscribe om je erop te abonneren. Vanaf nu zal de app voor elk ontvangen bericht op dit onderwerp een notificatie tonen. Je krijgt zelfs de al verzonden berichten te zien. Overigens toont de app twee waarschuwingen. Voor betrouwbare notificaties volg je de suggesties om batterijoptimalisaties uit te schakelen en naar WebSockets over te schakelen in plaats van een http-stream.

De Android-app ontvangt een notificatie voor elk bericht dat op een geabonneerd onderwerp wordt verstuurd.

Shellscripts

Nu je hebt getest dat je ntfy-server werkt, is het tijd om je eigen services notificaties te laten uitsturen. Hoe je dat precies configureert, hangt van de service af. Maar je zult altijd eerst een gebruiker met schrijfpermissies voor een specifiek onderwerp moeten aanmaken. Voor een back-upproces dat je op de hoogte moet houden van de status van je back-ups, maak je bijvoorbeeld een gebruiker aan met de opdracht ntfy user add backup in de container van ntfy. Geef die dan schrijfrechten op het onderwerp backup met ntfy access backup backup write-only.

Het publiceren van een bericht op een specifiek onderwerp behelst niet meer dan het sturen van een http POST-aanvraag naar de webserver. Dat kan bijvoorbeeld in een shellscript op je Linux-server met de opdracht curl:

curl -u backup:password -d "Backup successful" ntfy.example.com/backup

Als je in de ntfy-app op je telefoon je op dit onderwerp abonneert, ontvang je deze notificatie nadat het back-upscript is uitgevoerd. Op deze manier is het heel eenvoudig om je eigen shellscripts notificaties te laten verzenden.

Berichten met extra's

Ntfy ondersteunt talloze extra functies om je berichten te laten opvallen of om hun gedrag aan te passen. Je gebruikt deze allemaal door een http-header aan je aanvraag toe te voegen. Zo kun je aan de notificaties van je back-upscript een titel, prioriteit en tags toevoegen. De tags worden als pictogrammen getoond door de mobiele app. Een voorbeeld:

curl -u backup:password -H "Title: Backup failure" -H "Priority: urgent" -H "Tags: warning,skull" -d "Backup unsuccessful" ntfy.example.com/backup

Als de Android-app een bericht met standaardprioriteit ontvangt, doet ze je telefoon kort vibreren en speelt ze een kort geluidje af. Door de prioriteit op urgent te zetten, wordt het standaardnotificatiegeluidje vergezeld van een langer getril van je telefoon, waardoor je onmiddellijk merkt dat dit dringend je aandacht vereist.

Een ntfy-bericht met een titel, prioriteit en pictogrammen.

Plaatjes en lay-out

Ntfy kan ook plaatjes sturen, bijvoorbeeld een foto van een ip-camera die beweging detecteert, maar niet in combinatie met een tekstbericht. Om een bestand naar ntfy te uploaden met curl in een http PUT-aanvraag gebruik je de optie -T en de bestandsnaam. Met de header Filename voeg je de bestandsnaam toe die de ntfy-app je moet tonen. Dat ziet er dan als volgt uit:

curl -u admin:password -T foto.jpg -H "Filename: beweging.jpg" -H "Title: Beweging voordeur" -H "Tags: boom" ntfy.example.com/beweging

Als je een tekstbericht als Markdown opmaakt, kun je wel plaatjes in een tekst opnemen, maar dan moet je naar het bestand linken. Alleen ntfy's webinterface ondersteunt dit; de mobiele app toont gewoon de Markdown-brontekst. Een Markdown-bericht stuur je door de header Markdown: yes of Content-Type: text/markdown aan je http POST-aanvraag toe te voegen. Ntfy ondersteunt overigens alleen beperkte Markdown-functies, zoals vette en schuine tekst, lijsten, links en afbeeldingen.

Je services kunnen ook plaatjes naar ntfy sturen.

Acties

Je ontvangt de notificaties van ntfy in de app in een 'conversatie' per onderwerp. Wanneer je op een notificatie tikt, kopieert dit standaard gewoon de tekst van het bericht naar het klembord. Als je de header Click: URL toevoegt, opent de app die url wanneer je op de notificatie tikt. Zo kun je in een notificatie van je back-upscript bijvoorbeeld een link naar de webinterface van je back-upserver opnemen om het gemelde probleem snel te onderzoeken.

Je kunt ook tot drie 'actieknoppen' definiëren, die dan onderaan een notificatie verschijnen. Door op een van die knoppen te tikken, open je een website of app, activeer je een Android broadcast intent waarop andere apps dan weer kunnen reageren, of zend je een http POST-, PUT- of GET-aanvraag. De manier om dit alles te definiëren is wat omslachtig, maar wordt volledig in de documentatie van ntfy uitgelegd.

Klik op een van de knoppen van het bericht in ntfy om een actie uit te voeren.

Python-code

Curl is natuurlijk niet de enige tool waarmee je notificaties naar je ntfy-server kunt sturen. Sommige tools bieden rechtstreeks ondersteuning voor notificaties via ntfy. Dan hoef je alleen maar het domein van je server, het onderwerp, de gebruikersnaam en het bijbehorende wachtwoord in te vullen. Maar ook in je eigen Python-scripts kun je eenvoudig ondersteuning voor ntfy inbouwen. Dat gaat via het pakket Requests, waarmee je http POST-aanvragen naar de server stuurt. Een eenvoudig voorbeeld ziet er als volgt uit:

import requests

requests.post("http://ntfy.example.com/backup",

    data="Backup unsuccessful",

    headers={

        "Authorization": "Basic Z2VicnVpa2Vyc25hYW06d2FjaHR3b29yZA==",

        "Title": "Backup failure",

        "Priority": "urgent",

        "Tags": "warning,skull"

    })

Met de header Authorization stel je http Basic-authenticatie in. De tekenreeks die na Basic komt, is een Base64-codering van de gebruikersnaam en het wachtwoord met een dubbele punt ertussen. Je creëert die codering op je Linux-systeem met de opdracht echo "Basic $(echo -n 'gebruikersnaam:wachtwoord' | base64)".

Sssssssssschattig

Speciaal voor de kleinste Python-fans

En verder

Ntfy biedt een betrouwbare manier om notificaties van allerlei services te centraliseren, terwijl je zelf de volledige controle behoudt. Het programma blinkt uit in flexibiliteit om het overal in te integreren. Als een service bijvoorbeeld geen http POST-aanvragen ondersteunt, kun je ook http GET-aanvragen doen. En als een service je niet de mogelijkheid geeft om de headers aan te passen, laat ntfy je toe om de berichten inclusief headers in JSON-formaat door te sturen. En als een service webhooks ondersteunt maar daarvoor zijn eigen JSON-formaat gebruikt, kan ntfy die met berichtsjablonen omzetten naar leesbare berichten.

Ook via e-mail is ntfy te integreren. Je kunt bijvoorbeeld berichten die op je ntfy-server aankomen automatisch laten doorsturen naar een SMTP-server om ze ook als e-mail te ontvangen. Maar ook de andere richting is voorzien: ntfy kan dan zelf een ingebouwde SMTP-server draaien, handig voor services die alleen maar notificaties via e-mail ondersteunen. Elk onderwerp op de ntfy-server heeft dan een bijbehorend e-mailadres op je domein. De service hoeft dan alleen maar een e-mail naar dat adres te sturen om berichten op dat onderwerp te publiceren op je ntfy-server. Deze en andere geavanceerde functies zijn uitgebreid gedocumenteerd op de website van ntfy.

De documentatie van ntfy is uitgebreid en praktisch. 

▼ Volgende artikel
Nieuwe FromSoftware-game The Duskbloods komt echt alleen naar Switch 2
Huis

Nieuwe FromSoftware-game The Duskbloods komt echt alleen naar Switch 2

The Duskbloods, de nieuwe game van Elden Ring- en Dark Souls-ontwikkelaar FromSoftware, zal echt alleen op Nintendo Switch 2 uitkomen.

Dat heeft de ontwikkelaar benadrukt bij het bekendmaken van zijn kwartaalcijfers (via VGC). Daarbij werd ook nog eens benadrukt dat The Duskbloods nog altijd gepland staat om ergens dit jaar uit te komen, net zoals de Switch 2-versie van Elden Ring.

Over de exclusieve Switch 2-release van The Duskbloods: "Het wordt verkocht via een samenwerking met Nintendo, met verkoopverantwoordelijkheden verdeeld per regio. De game komt alleen voor Nintendo Switch 2 beschikbaar." Daarmee is dus duidelijk gemaakt dat Nintendo een nauwe samenwerking met FromSoftware is aangegaan voor de game en dat het spel niet zomaar op andere platforms uit zal komen.

Over The Duskbloods

The Duskbloods werd begin vorig jaar aangekondigd in een speciale Nintendo Direct waarin de eerste Switch 2-games werden getoond, maar sindsdien zijn er geen nieuwe beelden van het spel uitgebracht. Zoals gezegd is de game ontwikkeld door FromSoftware, het Japanse bedrijf dat naam voor zichzelf heeft gemaakt met enorm uitdagende spellen, waaronder de Dark Souls-serie en Bloodborne. Met de openwereldgame Elden Ring scoorde de ontwikkelaar enkele jaren geleden nog een megahit.

Watch on YouTube

The Duskbloods wordt een PvPvE-game, waarbij spelers het dus tegen elkaar en tegen computergestuurde vijanden opnemen. Maximaal acht spelers doen aan potjes mee. Na het kiezen van een personage in een hub-gebied wordt men naar een gebied getransporteerd waar er met andere spelers en vijanden gevochten wordt, al kan men soms ook samenwerken om vijanden te verslaan.

Spelers besturen een 'Bloodsworn', wezens die dankzij een speciaal bloed dat in hun lichaam zit meer krachten tot hun beschikking hebben dan reguliere mensen. Ondertussen is het einde van de mensheid nabij, en bestaat de wereld uit verschillende tijdperken, wat voor een mengelmoes van stijlen zorgt.