Jamdesk Documentation logo

Domaines personnalisés

Déployez votre documentation depuis votre propre domaine plutôt que depuis le sous-domaine par défaut *.jamdesk.app. Configuration DNS pour les sous-domaines et domaines apex, SSL et vérification.

Déployez votre documentation depuis votre propre domaine plutôt que depuis le sous-domaine par défaut *.jamdesk.app.

Aperçu de la configuration

1
Ajouter le domaine dans le dashboard

Allez dans les Paramètres de votre projet → Domaine et saisissez votre domaine (par ex., docs.example.com ou example.com).

2
Configurer le DNS

Ajoutez les enregistrements DNS affichés dans le dashboard auprès de votre fournisseur DNS. Les enregistrements dépendent du type de domaine (voir ci-dessous).

3
Vérifier et patienter

Jamdesk vérifie la propriété et provisionne automatiquement un certificat SSL.

Options d'hébergement

Lors de l'ajout d'un domaine, choisissez votre mode d'hébergement :

Domaine standard

Votre documentation est déployée directement depuis Jamdesk sur votre domaine personnalisé :

docs.example.com → acme.jamdesk.app

Le DNS pointe vers Jamdesk et les certificats SSL sont gérés automatiquement.

Hébergement à /docs (basé sur un proxy)

Votre documentation est déployée sous un sous-chemin de votre site existant :

example.com/docs → acme.jamdesk.app/docs

Vous configurez un proxy (Cloudflare, Vercel, nginx, etc.) pour transférer les requêtes /docs/* vers Jamdesk. Consultez Hébergement sous-chemin pour les guides de configuration.

Activer/désactiver « Héberger à /docs » déclenche un rebuild automatique car la structure des URL change.

Configuration DNS

Les enregistrements nécessaires dépendent de l'utilisation d'un sous-domaine ou d'un domaine apex (racine).

Sous-domaines (par ex., docs.example.com)

TypeNomValeur
CNAMEdocscname.jamdesk.com
TXT_jamdesk.docs(affiché dans le dashboard)

Le champ « Nom » correspond uniquement à la partie sous-domaine. Pour docs.example.com, saisissez docs.

Domaines apex (par ex., example.com)

TypeNomValeur
A@76.76.21.21
TXT_jamdesk(affiché dans le dashboard)

Les domaines apex utilisent un enregistrement A plutôt qu'un CNAME, car les standards DNS (RFC 1034) interdisent les enregistrements CNAME à l'apex de zone.

Les modifications DNS peuvent prendre jusqu'à 48 heures à se propager, bien que la plupart soient effectives en quelques minutes. Vérifiez le statut sur whatsmydns.net.

Vérification

Après l'ajout des enregistrements DNS, Jamdesk effectue automatiquement :

  1. La détection de vos enregistrements DNS (CNAME ou enregistrement A, plus TXT)
  2. La vérification de la propriété du domaine via l'enregistrement TXT
  3. Le provisionnement d'un certificat SSL via Let's Encrypt
  4. Le routage du trafic vers votre documentation

Vérifiez le statut de vérification dans ParamètresDomaine. Le statut affiché est :

  • En attente - En attente de la propagation DNS
  • Actif - Domaine vérifié et trafic en cours
  • Attention requise - Incohérence ou conflit de configuration (vérifiez la notification par e-mail)
  • Erreur - Problème de configuration (voir les détails dans le dashboard)

Cliquez sur Actualiser dans le dashboard pour vérifier manuellement le statut de vérification.

Certificats SSL

Les certificats SSL sont provisionnés automatiquement et renouvelés avant expiration. HTTPS est obligatoire, les requêtes HTTP sont redirigées vers HTTPS.

Aucune configuration manuelle de certificat n'est nécessaire.

Domaines racine

Les domaines racine (apex) tels que example.com sont entièrement pris en charge. Le dashboard affiche automatiquement les enregistrements corrects : un enregistrement A pointant vers 76.76.21.21 au lieu d'un CNAME, car les standards DNS interdisent les enregistrements CNAME à l'apex de zone.

Si vous préférez un sous-domaine comme docs.example.com, cela fonctionne également.

Domaines multiples

Chaque projet prend en charge un seul domaine personnalisé. Pour plusieurs domaines pointant vers la même documentation :

  1. Configurez votre domaine principal dans Jamdesk
  2. Configurez les domaines supplémentaires pour rediriger vers le domaine principal au niveau DNS/CDN

Suppression d'un domaine

Pour déconnecter un domaine personnalisé :

  1. Allez dans ParamètresDomaine
  2. Cliquez sur Supprimer le domaine
  3. Votre documentation reste accessible via le sous-domaine *.jamdesk.app

La suppression d'un domaine pour lequel « Héberger à /docs » était activé déclenchera un rebuild pour mettre à jour les chemins d'URL.

Utilisateurs Cloudflare

Si vous utilisez Cloudflare comme fournisseur DNS :

  1. Définissez le statut du proxy sur DNS uniquement (icône nuage gris) pendant la vérification du domaine
  2. Laissez Vercel gérer le SSL : désactivez « Toujours utiliser HTTPS » de Cloudflare pour le sous-domaine docs
  3. Une fois la vérification terminée, vous pouvez réactiver le proxy (nuage orange)

Vous utilisez un Cloudflare Worker ? L'enregistrement DNS doit être proxifié (nuage orange) pour que le Worker s'exécute. Utilisez le nuage gris uniquement pendant la vérification, puis rebasculez. Consultez la configuration Cloudflare Workers pour plus de détails.

Dépannage

ProblèmeSolution
Domaine bloqué sur « En attente »Vérifiez les enregistrements DNS avec dig (CNAME pour les sous-domaines, A pour l'apex)
Erreurs de certificat SSLAssurez-vous qu'aucun enregistrement CAA ne bloque Let's Encrypt
Boucles de redirectionSi vous utilisez Cloudflare, définissez le nuage gris pendant la vérification (voir Utilisateurs Cloudflare ci-dessus)
CNAME non résoluVérifiez l'enregistrement auprès du fournisseur DNS, attendez la propagation
Domaine déjà utiliséLe domaine est enregistré dans Vercel depuis une configuration précédente ; la vérification se complète généralement automatiquement

Vérifier le DNS avec dig

# Check CNAME record (subdomains)
dig CNAME docs.example.com

# Check A record (apex domains)
dig A example.com

# Check TXT record
dig TXT _jamdesk.example.com

Pour des diagnostics détaillés, consultez Dépannage DNS.

Et ensuite ?

Sous-domaines

Configurer les paramètres spécifiques aux sous-domaines

Hébergement sous-chemin

Héberger la documentation à example.com/docs

Dépannage DNS

Diagnostiquer les problèmes de configuration DNS