happyDomain/help
2
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

docs: expand reference pages and fix children shortcode rendering

Browse source 
Enable Goldmark block-level attributes so the relearn `children`
shortcode applies its CSS classes instead of printing them literally
in the table-of-contents pages. Also expand the deploy, plugins,
records, and email reference docs and add the checks pages.
This commit is contained in:
nemunaire 2026-06-11 13:21:16 +09:00
commit 6b6a8c847f
13 changed files with 1457 additions and 501 deletions
Download patch file Download diff file Expand all files Collapse all files

332
content/introduction/deploy/docker.en.md
View file

@ -7,69 +7,335 @@ weight: 15
happyDomain is sponsored by Docker.
You'll find the official container image on [the Docker Hub](https://hub.docker.com/r/happydomain/happydomain/).
This image will run happyDomain as a single process, with a LevelDB database (similarly to sqlite, LevelDB is stored on disk, no need to configure anything).
The image runs happyDomain as a single process with a LevelDB database stored on disk — no extra database to configure.
## Supported tags and architectures
All tags are build for `amd64`, `arm64` and `arm/v7` and are based on alpine.
All tags are built for `amd64`, `arm64` and `arm/v7` and are based on Alpine.
Currently, available tags are:
Currently available tags:
- `latest`: this is a the most up to date version, corresponding to the master branch.
- `latest`: the most up-to-date version, corresponding to the master branch.
## Using this image
### For testing purpose
## Quick start (single container)
You can test happyDomain or use it for your own usage, with the option `HAPPYDOMAIN_NO_AUTH=1`: this will automatically creates a default account, and disable all features related to the user management (signup, login, ...).
For a quick test or personal use, pass `HAPPYDOMAIN_NO_AUTH=1` to skip account management:
```
docker run -e HAPPYDOMAIN_NO_AUTH=1 -p 8081:8081 happydomain/happydomain
```
Data are stored in `/data` directory. If you want to keep your settings from one run to another, you'll need to attach this directory to a Docker managed volume or to a directory on your host:
Data are stored inside the container. To keep them across restarts, attach a volume:
```
docker volume create happydomain_data
docker run -e HAPPYDOMAIN_NO_AUTH=1 -v happydomain_data:/data -p 8081:8081 happydomain/happydomain
```
### In production
happyDomain needs to send e-mail, in order to verify addresses and doing password recovery, so you need basically to configure a SMTP relay.
Use the options `HAPPYDOMAIN_MAIL_SMTP_HOST`, `HAPPYDOMAIN_MAIL_SMTP_PORT` (default 25), `HAPPYDOMAIN_MAIL_SMTP_USERNAME` and `HAPPYDOMAIN_MAIL_SMTP_PASSWORD` for this purpose:
For a production single-container setup that sends e-mail:
```
docker run -e HAPPYDOMAIN_MAIL_SMTP_HOST=smtp.yourcompany.com -e HAPPYDOMAIN_MAIL_SMTP_USERNAME=happydomain -e HAPPYDOMAIN_MAIL_SMTP_PASSWORD=secret -v /var/lib/happydomain:/data -p 8081:8081 happydomain/happydomain
```
If you prefer using a configuration file, you can place it either in `/data/happydomain.conf` to use the volume, or bind your file to `/etc/happydomain.conf`:
```
docker run -v happydomain.conf:/etc/happydomain.conf -p 8081:8081 happydomain/happydomain
```
#### Extend the base image
By default, happyDomain uses `sendmail`, if you prefer, you can create you own image with the package `ssmtp`:
```
FROM happydomain/happydomain
RUN apk --no-cache add ssmtp
COPY my_ssmtp.conf /etc/ssmtp/ssmtp.conf
docker run \
-e HAPPYDOMAIN_MAIL_SMTP_HOST=smtp.yourcompany.com \
-e HAPPYDOMAIN_MAIL_SMTP_USERNAME=happydomain \
-e HAPPYDOMAIN_MAIL_SMTP_PASSWORD=secret \
-v /var/lib/happydomain:/data \
-p 8081:8081 \
happydomain/happydomain
```
## Admin Interface
## Full deployment with all checkers
happyDomain exposes some administration command through a unix socket. The docker container contains a script to access this admin part: `hadmin`.
happyDomain ships every checker built-in, but several of them rely on
external tools (DNSViz, Zonemaster, Matrix federation tester) that are
packaged in their own container images. Running these as separate services
gives you the full checker experience and better isolation.
You can use it this way:
The recommended approach is `docker compose`. Save the following file as
`docker-compose.yml` and run `docker compose up -d`.
```yaml
services:
happydomain:
image: happydomain/happydomain
ports:
- "8080:8081"
environment:
# Uncomment for single-user / testing
# HAPPYDOMAIN_NO_AUTH: "1"
# Mail configuration (required for multi-user production use)
# HAPPYDOMAIN_MAIL_SMTP_HOST: "mailer"
# ── DNS / DNSSEC ─────────────────────────────────────────────────────
HAPPYDOMAIN_CHECKER_DNSVIZ_ENDPOINT: "http://checker-dnsviz:8080"
HAPPYDOMAIN_CHECKER_DNSSEC_ENDPOINT: "http://checker-dnssec:8080"
HAPPYDOMAIN_CHECKER_ZONEMASTER_ENDPOINT: "http://checker-zonemaster:8080"
HAPPYDOMAIN_CHECKER_ZONEMASTER_ZONEMASTERAPIURL: "http://zonemaster:5000"
HAPPYDOMAIN_CHECKER_DELEGATION_ENDPOINT: "http://checker-delegation:8080"
HAPPYDOMAIN_CHECKER_AUTHORITATIVE_CONSISTENCY_ENDPOINT: "http://checker-authoritative-consistency:8080"
HAPPYDOMAIN_CHECKER_ALIAS_ENDPOINT: "http://checker-alias:8080"
HAPPYDOMAIN_CHECKER_LEGACY_RECORDS_ENDPOINT: "http://checker-legacy-records:8080"
HAPPYDOMAIN_CHECKER_NS_RESTRICTIONS_ENDPOINT: "http://checker-ns-restrictions:8080"
HAPPYDOMAIN_CHECKER_RESOLVER_PROPAGATION_ENDPOINT: "http://checker-resolver-propagation:8080"
HAPPYDOMAIN_CHECKER_REVERSE_ZONE_ENDPOINT: "http://checker-reverse-zone:8080"
HAPPYDOMAIN_CHECKER_PTR_ENDPOINT: "http://checker-ptr:8080"
HAPPYDOMAIN_CHECKER_DANGLING_ENDPOINT: "http://checker-dangling:8080"
# ── Security / Certificates ───────────────────────────────────────────
HAPPYDOMAIN_CHECKER_TLS_ENDPOINT: "http://checker-tls:8080"
HAPPYDOMAIN_CHECKER_DANE_ENDPOINT: "http://checker-dane:8080"
HAPPYDOMAIN_CHECKER_CAA_ENDPOINT: "http://checker-caa:8080"
HAPPYDOMAIN_CHECKER_BLACKLIST_ENDPOINT: "http://checker-blacklist:8080"
# ── E-mail ────────────────────────────────────────────────────────────
HAPPYDOMAIN_CHECKER_SMTP_ENDPOINT: "http://checker-smtp:8080"
HAPPYDOMAIN_CHECKER_EMAIL_AUTOCONFIG_ENDPOINT: "http://checker-email-autoconfig:8080"
HAPPYDOMAIN_CHECKER_OPENPGPKEY_SMIMEA_ENDPOINT: "http://checker-email-keys:8080"
# ── Web & Protocols ───────────────────────────────────────────────────
HAPPYDOMAIN_CHECKER_HTTP_ENDPOINT: "http://checker-http:8080"
HAPPYDOMAIN_CHECKER_SSH_ENDPOINT: "http://checker-ssh:8080"
HAPPYDOMAIN_CHECKER_PING_ENDPOINT: "http://checker-ping:8080"
HAPPYDOMAIN_CHECKER_SRV_ENDPOINT: "http://checker-srv:8080"
# ── Collaboration / Messaging ─────────────────────────────────────────
HAPPYDOMAIN_CHECKER_MATRIXIM_ENDPOINT: "http://checker-matrix:8080"
HAPPYDOMAIN_CHECKER_MATRIXIM_FEDERATIONTESTERSERVER: "http://matrixfederationtester:8080/api/report?server_name=%s"
HAPPYDOMAIN_CHECKER_XMPP_ENDPOINT: "http://checker-xmpp:8080"
HAPPYDOMAIN_CHECKER_SIP_ENDPOINT: "http://checker-sip:8080"
# ── Directory & Auth ──────────────────────────────────────────────────
HAPPYDOMAIN_CHECKER_LDAP_ENDPOINT: "http://checker-ldap:8080"
HAPPYDOMAIN_CHECKER_KERBEROS_ENDPOINT: "http://checker-kerberos:8080"
HAPPYDOMAIN_CHECKER_STUNTURN_ENDPOINT: "http://checker-stun-turn:8080"
# ── CalDAV / CardDAV ──────────────────────────────────────────────────
HAPPYDOMAIN_CHECKER_CALDAV_ENDPOINT: "http://checker-caldav:8080"
HAPPYDOMAIN_CHECKER_CARDDAV_ENDPOINT: "http://checker-carddav:8080"
# ── Optional: happyDeliver integration ────────────────────────────────
# HAPPYDOMAIN_CHECKER_HAPPYDELIVER_ENDPOINT: "http://checker-happydeliver:8080"
restart: unless-stopped
volumes:
- storage:/var/lib/happydomain:rw
# ── DNS / DNSSEC checkers ──────────────────────────────────────────────────
checker-dnsviz:
image: happydomain/checker-dnsviz
restart: unless-stopped
checker-dnssec:
image: happydomain/checker-dnssec
restart: unless-stopped
checker-zonemaster:
image: happydomain/checker-zonemaster
restart: unless-stopped
zonemaster:
image: zonemaster/backend
command: full
restart: unless-stopped
checker-delegation:
image: happydomain/checker-delegation
restart: unless-stopped
checker-authoritative-consistency:
image: happydomain/checker-authoritative-consistency
restart: unless-stopped
checker-alias:
image: happydomain/checker-alias
restart: unless-stopped
checker-legacy-records:
image: happydomain/checker-legacy-records
restart: unless-stopped
checker-ns-restrictions:
image: happydomain/checker-ns-restrictions
restart: unless-stopped
checker-resolver-propagation:
image: happydomain/checker-resolver-propagation
restart: unless-stopped
checker-reverse-zone:
image: happydomain/checker-reverse-zone
restart: unless-stopped
checker-ptr:
image: happydomain/checker-ptr
restart: unless-stopped
checker-dangling:
image: happydomain/checker-dangling
restart: unless-stopped
# ── Security / Certificate checkers ───────────────────────────────────────
checker-tls:
image: happydomain/checker-tls
restart: unless-stopped
checker-dane:
image: happydomain/checker-dane
restart: unless-stopped
checker-caa:
image: happydomain/checker-caa
restart: unless-stopped
checker-blacklist:
image: happydomain/checker-blacklist
restart: unless-stopped
# ── E-mail checkers ────────────────────────────────────────────────────────
checker-smtp:
image: happydomain/checker-smtp
restart: unless-stopped
checker-email-autoconfig:
image: happydomain/checker-email-autoconfig
restart: unless-stopped
checker-email-keys:
image: happydomain/checker-email-keys
restart: unless-stopped
# ── Web & Protocol checkers ────────────────────────────────────────────────
checker-http:
image: happydomain/checker-http
restart: unless-stopped
checker-ssh:
image: happydomain/checker-ssh
restart: unless-stopped
checker-ping:
image: happydomain/checker-ping
restart: unless-stopped
cap_add:
- NET_RAW # required for ICMP ping
checker-srv:
image: happydomain/checker-srv
restart: unless-stopped
# ── Collaboration / Messaging checkers ─────────────────────────────────────
checker-matrix:
image: happydomain/checker-matrix
restart: unless-stopped
matrixfederationtester:
image: matrixdotorg/federation-tester-backend
environment:
BIND_ADDRESS: "0.0.0.0:8080"
restart: unless-stopped
checker-xmpp:
image: happydomain/checker-xmpp
restart: unless-stopped
checker-sip:
image: happydomain/checker-sip
restart: unless-stopped
# ── Directory & Auth checkers ──────────────────────────────────────────────
checker-ldap:
image: happydomain/checker-ldap
restart: unless-stopped
checker-kerberos:
image: happydomain/checker-kerberos
restart: unless-stopped
checker-stun-turn:
image: happydomain/checker-stun-turn
restart: unless-stopped
# ── CalDAV / CardDAV checkers ──────────────────────────────────────────────
checker-caldav:
image: happydomain/checker-caldav
restart: unless-stopped
checker-carddav:
image: happydomain/checker-carddav
restart: unless-stopped
volumes:
storage:
```
### How it works
Each checker runs as a standalone HTTP service. happyDomain delegates check
requests to the matching container via the `HAPPYDOMAIN_CHECKER_<ID>_ENDPOINT`
environment variable. When an endpoint is not set, the corresponding checker
runs locally inside the happyDomain process instead.
Two checkers rely on additional third-party backends:
- **Zonemaster** (`checker-zonemaster`) queries the `zonemaster/backend`
service. The `HAPPYDOMAIN_CHECKER_ZONEMASTER_ZONEMASTERAPIURL` variable tells
the checker where that backend listens.
- **Matrix federation tester** (`checker-matrix`) queries the
`matrixdotorg/federation-tester-backend` service. The
`HAPPYDOMAIN_CHECKER_MATRIXIM_FEDERATIONTESTERSERVER` variable points to its
report endpoint.
### Optional: happyDeliver
If you run a [happyDeliver](https://happydeliver.io) instance for mail-flow
monitoring, uncomment the `HAPPYDOMAIN_CHECKER_HAPPYDELIVER_ENDPOINT` line and
add the corresponding service:
```yaml
checker-happydeliver:
image: happydomain/checker-happydeliver
restart: unless-stopped
```
### Optional: blacklist API keys
The `checker-blacklist` service works without API keys (it uses DNS-based
blocklists by default), but you can enable additional sources — Google Safe
Browsing, VirusTotal, abuse.ch URLhaus — by configuring the matching admin
options from the happyDomain administration interface once the stack is running.
## Admin interface
happyDomain exposes administration commands through a Unix socket. The
container includes the `hadmin` wrapper:
```
docker exec my_container hadmin /api/users
docker exec my_container hadmin /api/users/0123456789/send_validation_email -X POST
```
This is in fact a wrapper above `curl`, but you have to start by the URL, and place options after it.
`hadmin` is a thin wrapper around `curl` — start with the URL path, then add
any `curl` options after it.
## Using a configuration file
Instead of environment variables, you can place a configuration file either in
`/data/happydomain.conf` (inside the data volume) or bind-mount it to
`/etc/happydomain.conf`:
```
docker run -v happydomain.conf:/etc/happydomain.conf -p 8081:8081 happydomain/happydomain
```

332
content/introduction/deploy/docker.fr.md
View file

@ -4,78 +4,340 @@ title: Avec Docker
weight: 15
---
happyDomain est sponsorisé Docker.
happyDomain est sponsorisé par Docker.
Vous trouverez notre image officielle sur [le Docker Hub](https://hub.docker.com/r/happydomain/happydomain/).
Cette image exécutera happyDomain en tant que processus unique, avec une base de données LevelDB (similaire à sqlite, LevelDB est une base de données stockée sur le disque, il n'est pas nécessaire de configurer quoi que ce soit d'autre).
L'image exécute happyDomain en tant que processus unique avec une base de données LevelDB stockée sur le disque — aucune base de données supplémentaire à configurer.
## Versions, étiquettes and architectures supportés
## Versions, étiquettes et architectures supportées
Toutes les étiquettes (*tags*) sont construites pour les architectures de processeur les plus courantes (`amd64`, `arm64` et `arm/v7`).
Nous ne construisons des images uniquement basées sur la distribution Alpine Linux, ce qui assure des images de taille minimale.
Toutes les étiquettes (*tags*) sont construites pour `amd64`, `arm64` et `arm/v7` et sont basées sur Alpine.
Actuellement, les étiquettes disponibles sont :
Les étiquettes actuellement disponibles :
- `latest`: il s'agit de la version la plus récente, correspondant à la branche `master` de notre dépôt de sources.
- `latest` : la version la plus récente, correspondant à la branche `master` de notre dépôt.
## Utilisation de l'image
## Démarrage rapide (conteneur unique)
### À des fins de test
Vous pouvez tester happyDomain ou l'utiliser pour votre usage personnel, avec l'option `HAPPYDOMAIN_NO_AUTH=1` : cela créera automatiquement un compte par défaut, et désactivera toutes les fonctionnalités liées à la gestion des utilisateurs (inscription, connexion, ...).
Pour un test rapide ou un usage personnel, utilisez `HAPPYDOMAIN_NO_AUTH=1` pour désactiver la gestion des comptes :
```
docker run -e HAPPYDOMAIN_NO_AUTH=1 -p 8081:8081 happydomain/happydomain
```
Les données sont stockées dans le répertoire `/data`.
Si vous souhaitez conserver vos paramètres d'une exécution à l'autre, vous devrez attacher ce répertoire à un volume géré par Docker ou à un répertoire sur votre hôte :
Les données sont stockées à l'intérieur du conteneur. Pour les conserver entre les redémarrages, attachez un volume :
```
docker volume create happydomain_data
docker run -e HAPPYDOMAIN_NO_AUTH=1 -v happydomain_data:/data -p 8081:8081 happydomain/happydomain
```
### En production
happyDomain a besoin d'envoyer du courrier électronique, afin de vérifier les adresses et d'effectuer la récupération des mots de passe, vous devez donc configurer un relais SMTP.
Utilisez les options `HAPPYDOMAIN_MAIL_SMTP_HOST`, `HAPPYDOMAIN_MAIL_SMTP_PORT` (par défaut 25), `HAPPYDOMAIN_MAIL_SMTP_USERNAME` et `HAPPYDOMAIN_MAIL_SMTP_PASSWORD` à cette fin :
Pour une instance de production avec envoi d'e-mails :
```
docker run -e HAPPYDOMAIN_MAIL_SMTP_HOST=smtp.yourcompany.com -e HAPPYDOMAIN_MAIL_SMTP_USERNAME=happydomain -e HAPPYDOMAIN_MAIL_SMTP_PASSWORD=secret -v /var/lib/happydomain:/data -p 8081:8081 happydomain/happydomain
```
Si vous préférez utiliser un fichier de configuration, vous pouvez le placer soit dans `/data/happydomain.conf` pour utiliser le volume, soit lier votre fichier à `/etc/happydomain.conf` :
```
docker run -v happydomain.conf:/etc/happydomain.conf -p 8081:8081 happydomain/happydomain
docker run \
-e HAPPYDOMAIN_MAIL_SMTP_HOST=smtp.votreentreprise.com \
-e HAPPYDOMAIN_MAIL_SMTP_USERNAME=happydomain \
-e HAPPYDOMAIN_MAIL_SMTP_PASSWORD=secret \
-v /var/lib/happydomain:/data \
-p 8081:8081 \
happydomain/happydomain
```
#### Étendre l'image de base
## Déploiement complet avec tous les vérificateurs
Par défaut, happyDomain utilise `sendmail`, si vous préférez, vous pouvez créer votre propre image avec le paquet `ssmtp` :
happyDomain intègre tous les vérificateurs (*checkers*) en natif, mais certains
d'entre eux s'appuient sur des outils externes (DNSViz, Zonemaster, Matrix
federation tester) distribués dans leurs propres images Docker. Les faire
tourner comme des services séparés vous donne l'expérience complète des
vérificateurs et une meilleure isolation.
L'approche recommandée est `docker compose`. Enregistrez le fichier suivant
sous le nom `docker-compose.yml` et lancez `docker compose up -d`.
```yaml
services:
happydomain:
image: happydomain/happydomain
ports:
- "8080:8081"
environment:
# Décommentez pour un usage mono-utilisateur / test
# HAPPYDOMAIN_NO_AUTH: "1"
# Configuration mail (obligatoire en production multi-utilisateurs)
# HAPPYDOMAIN_MAIL_SMTP_HOST: "mailer"
# ── DNS / DNSSEC ─────────────────────────────────────────────────────
HAPPYDOMAIN_CHECKER_DNSVIZ_ENDPOINT: "http://checker-dnsviz:8080"
HAPPYDOMAIN_CHECKER_DNSSEC_ENDPOINT: "http://checker-dnssec:8080"
HAPPYDOMAIN_CHECKER_ZONEMASTER_ENDPOINT: "http://checker-zonemaster:8080"
HAPPYDOMAIN_CHECKER_ZONEMASTER_ZONEMASTERAPIURL: "http://zonemaster:5000"
HAPPYDOMAIN_CHECKER_DELEGATION_ENDPOINT: "http://checker-delegation:8080"
HAPPYDOMAIN_CHECKER_AUTHORITATIVE_CONSISTENCY_ENDPOINT: "http://checker-authoritative-consistency:8080"
HAPPYDOMAIN_CHECKER_ALIAS_ENDPOINT: "http://checker-alias:8080"
HAPPYDOMAIN_CHECKER_LEGACY_RECORDS_ENDPOINT: "http://checker-legacy-records:8080"
HAPPYDOMAIN_CHECKER_NS_RESTRICTIONS_ENDPOINT: "http://checker-ns-restrictions:8080"
HAPPYDOMAIN_CHECKER_RESOLVER_PROPAGATION_ENDPOINT: "http://checker-resolver-propagation:8080"
HAPPYDOMAIN_CHECKER_REVERSE_ZONE_ENDPOINT: "http://checker-reverse-zone:8080"
HAPPYDOMAIN_CHECKER_PTR_ENDPOINT: "http://checker-ptr:8080"
HAPPYDOMAIN_CHECKER_DANGLING_ENDPOINT: "http://checker-dangling:8080"
# ── Sécurité / Certificats ────────────────────────────────────────────
HAPPYDOMAIN_CHECKER_TLS_ENDPOINT: "http://checker-tls:8080"
HAPPYDOMAIN_CHECKER_DANE_ENDPOINT: "http://checker-dane:8080"
HAPPYDOMAIN_CHECKER_CAA_ENDPOINT: "http://checker-caa:8080"
HAPPYDOMAIN_CHECKER_BLACKLIST_ENDPOINT: "http://checker-blacklist:8080"
# ── E-mail ────────────────────────────────────────────────────────────
HAPPYDOMAIN_CHECKER_SMTP_ENDPOINT: "http://checker-smtp:8080"
HAPPYDOMAIN_CHECKER_EMAIL_AUTOCONFIG_ENDPOINT: "http://checker-email-autoconfig:8080"
HAPPYDOMAIN_CHECKER_OPENPGPKEY_SMIMEA_ENDPOINT: "http://checker-email-keys:8080"
# ── Web & Protocoles ──────────────────────────────────────────────────
HAPPYDOMAIN_CHECKER_HTTP_ENDPOINT: "http://checker-http:8080"
HAPPYDOMAIN_CHECKER_SSH_ENDPOINT: "http://checker-ssh:8080"
HAPPYDOMAIN_CHECKER_PING_ENDPOINT: "http://checker-ping:8080"
HAPPYDOMAIN_CHECKER_SRV_ENDPOINT: "http://checker-srv:8080"
# ── Collaboration / Messagerie ────────────────────────────────────────
HAPPYDOMAIN_CHECKER_MATRIXIM_ENDPOINT: "http://checker-matrix:8080"
HAPPYDOMAIN_CHECKER_MATRIXIM_FEDERATIONTESTERSERVER: "http://matrixfederationtester:8080/api/report?server_name=%s"
HAPPYDOMAIN_CHECKER_XMPP_ENDPOINT: "http://checker-xmpp:8080"
HAPPYDOMAIN_CHECKER_SIP_ENDPOINT: "http://checker-sip:8080"
# ── Annuaire & Authentification ───────────────────────────────────────
HAPPYDOMAIN_CHECKER_LDAP_ENDPOINT: "http://checker-ldap:8080"
HAPPYDOMAIN_CHECKER_KERBEROS_ENDPOINT: "http://checker-kerberos:8080"
HAPPYDOMAIN_CHECKER_STUNTURN_ENDPOINT: "http://checker-stun-turn:8080"
# ── CalDAV / CardDAV ──────────────────────────────────────────────────
HAPPYDOMAIN_CHECKER_CALDAV_ENDPOINT: "http://checker-caldav:8080"
HAPPYDOMAIN_CHECKER_CARDDAV_ENDPOINT: "http://checker-carddav:8080"
# ── Optionnel : intégration happyDeliver ──────────────────────────────
# HAPPYDOMAIN_CHECKER_HAPPYDELIVER_ENDPOINT: "http://checker-happydeliver:8080"
restart: unless-stopped
volumes:
- storage:/var/lib/happydomain:rw
# ── Vérificateurs DNS / DNSSEC ─────────────────────────────────────────────
checker-dnsviz:
image: happydomain/checker-dnsviz
restart: unless-stopped
checker-dnssec:
image: happydomain/checker-dnssec
restart: unless-stopped
checker-zonemaster:
image: happydomain/checker-zonemaster
restart: unless-stopped
zonemaster:
image: zonemaster/backend
command: full
restart: unless-stopped
checker-delegation:
image: happydomain/checker-delegation
restart: unless-stopped
checker-authoritative-consistency:
image: happydomain/checker-authoritative-consistency
restart: unless-stopped
checker-alias:
image: happydomain/checker-alias
restart: unless-stopped
checker-legacy-records:
image: happydomain/checker-legacy-records
restart: unless-stopped
checker-ns-restrictions:
image: happydomain/checker-ns-restrictions
restart: unless-stopped
checker-resolver-propagation:
image: happydomain/checker-resolver-propagation
restart: unless-stopped
checker-reverse-zone:
image: happydomain/checker-reverse-zone
restart: unless-stopped
checker-ptr:
image: happydomain/checker-ptr
restart: unless-stopped
checker-dangling:
image: happydomain/checker-dangling
restart: unless-stopped
# ── Vérificateurs Sécurité / Certificats ───────────────────────────────────
checker-tls:
image: happydomain/checker-tls
restart: unless-stopped
checker-dane:
image: happydomain/checker-dane
restart: unless-stopped
checker-caa:
image: happydomain/checker-caa
restart: unless-stopped
checker-blacklist:
image: happydomain/checker-blacklist
restart: unless-stopped
# ── Vérificateurs e-mail ────────────────────────────────────────────────────
checker-smtp:
image: happydomain/checker-smtp
restart: unless-stopped
checker-email-autoconfig:
image: happydomain/checker-email-autoconfig
restart: unless-stopped
checker-email-keys:
image: happydomain/checker-email-keys
restart: unless-stopped
# ── Vérificateurs Web & Protocoles ─────────────────────────────────────────
checker-http:
image: happydomain/checker-http
restart: unless-stopped
checker-ssh:
image: happydomain/checker-ssh
restart: unless-stopped
checker-ping:
image: happydomain/checker-ping
restart: unless-stopped
cap_add:
- NET_RAW # requis pour l'ICMP
checker-srv:
image: happydomain/checker-srv
restart: unless-stopped
# ── Vérificateurs Collaboration / Messagerie ────────────────────────────────
checker-matrix:
image: happydomain/checker-matrix
restart: unless-stopped
matrixfederationtester:
image: matrixdotorg/federation-tester-backend
environment:
BIND_ADDRESS: "0.0.0.0:8080"
restart: unless-stopped
checker-xmpp:
image: happydomain/checker-xmpp
restart: unless-stopped
checker-sip:
image: happydomain/checker-sip
restart: unless-stopped
# ── Vérificateurs Annuaire & Authentification ───────────────────────────────
checker-ldap:
image: happydomain/checker-ldap
restart: unless-stopped
checker-kerberos:
image: happydomain/checker-kerberos
restart: unless-stopped
checker-stun-turn:
image: happydomain/checker-stun-turn
restart: unless-stopped
# ── Vérificateurs CalDAV / CardDAV ─────────────────────────────────────────
checker-caldav:
image: happydomain/checker-caldav
restart: unless-stopped
checker-carddav:
image: happydomain/checker-carddav
restart: unless-stopped
volumes:
storage:
```
FROM happydomain/happydomain
RUN apk --no-cache add ssmtp
COPY my_ssmtp.conf /etc/ssmtp/ssmtp.conf
### Comment ça fonctionne
Chaque vérificateur tourne comme un service HTTP autonome. happyDomain lui délègue
les demandes de vérification via la variable d'environnement
`HAPPYDOMAIN_CHECKER_<ID>_ENDPOINT`. Si aucun point d'accès n'est configuré, le
vérificateur correspondant s'exécute localement dans le processus happyDomain.
Deux vérificateurs s'appuient sur des services tiers supplémentaires :
- **Zonemaster** (`checker-zonemaster`) interroge le service `zonemaster/backend`.
La variable `HAPPYDOMAIN_CHECKER_ZONEMASTER_ZONEMASTERAPIURL` indique au
vérificateur l'adresse de ce service.
- **Matrix federation tester** (`checker-matrix`) interroge le service
`matrixdotorg/federation-tester-backend`. La variable
`HAPPYDOMAIN_CHECKER_MATRIXIM_FEDERATIONTESTERSERVER` pointe vers son point
d'accès de rapport.
### Optionnel : happyDeliver
Si vous exploitez une instance [happyDeliver](https://happydeliver.io) pour
surveiller les flux e-mail, décommentez la ligne
`HAPPYDOMAIN_CHECKER_HAPPYDELIVER_ENDPOINT` et ajoutez le service correspondant :
```yaml
checker-happydeliver:
image: happydomain/checker-happydeliver
restart: unless-stopped
```
### Optionnel : clés API pour checker-blacklist
Le service `checker-blacklist` fonctionne sans clé API (il utilise des listes
de blocage DNS par défaut), mais vous pouvez activer des sources supplémentaires
— Google Safe Browsing, VirusTotal, abuse.ch URLhaus — en configurant les
options d'administration correspondantes depuis l'interface d'administration de
happyDomain une fois la pile démarrée.
## Interface d'administration
happyDomain expose certaines commandes d'administration à travers un socket unix.
Le conteneur docker contient un script pour accéder à cette partie d'administration : `hadmin`.
Vous pouvez l'utiliser de cette manière :
happyDomain expose des commandes d'administration à travers un socket Unix.
Le conteneur inclut l'utilitaire `hadmin` :
```
docker exec my_container hadmin /api/users
docker exec my_container hadmin /api/users/0123456789/send_validation_email -X POST
```
Il s'agit en fait d'une surcouche au-dessus de `curl`, mais vous devez commencer par l'URL, et placer les options après.
`hadmin` est une surcouche légère autour de `curl` — commencez par le chemin
d'URL, puis ajoutez les options `curl` après.
## Utilisation d'un fichier de configuration
Plutôt que des variables d'environnement, vous pouvez placer un fichier de
configuration dans `/data/happydomain.conf` (dans le volume de données) ou le
monter directement sur `/etc/happydomain.conf` :
```
docker run -v happydomain.conf:/etc/happydomain.conf -p 8081:8081 happydomain/happydomain
```