Jamdesk Documentation logo

Domaines personnalisés

Diffusez votre documentation depuis votre propre domaine au lieu du sous-domaine *.jamdesk.app par défaut. Configuration DNS, SSL et vérification.

Diffusez votre documentation depuis votre propre domaine au lieu du sous-domaine *.jamdesk.app par défaut.

Aperçu de la configuration

1
Ajouter le domaine dans le dashboard

Allez dans SettingsDomain de votre projet et saisissez votre domaine (par exemple, docs.example.com ou example.com).

2
Configurer le DNS

Ajoutez les enregistrements DNS affichés dans le dashboard chez 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 un certificat SSL automatiquement.

Options d'hébergement

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

Domaine standard

Votre documentation est diffusé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éberger sur /docs (basé sur un proxy)

Votre documentation est diffusée sur un sous-chemin de votre site web 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 Subpath Hosting pour les guides de configuration.

Activer « Host at /docs » déploie automatiquement une nouvelle version car la structure des URL change.

Configuration DNS

Les enregistrements dont vous avez besoin dépendent du fait que vous utilisiez un sous-domaine ou un domaine apex (racine).

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

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

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

Domaines apex (par exemple, example.com)

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

Les domaines apex utilisent un enregistrement A au lieu d'un CNAME car les standards DNS (RFC 1034) interdisent les enregistrements CNAME à la racine de la zone.

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

Vérification

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

  1. Détecte vos enregistrements DNS (CNAME ou enregistrement A, plus TXT)
  2. Vérifie la propriété du domaine via l'enregistrement TXT
  3. Provisionne un certificat SSL via Let's Encrypt
  4. Route le trafic vers votre documentation

Vérifiez le statut de vérification dans SettingsDomain. Le statut s'affiche comme suit :

  • Pending - En attente de propagation DNS
  • Active - Domaine vérifié et diffusant le trafic
  • Needs Attention - Incohérence de configuration ou conflit (vérifiez la notification par e-mail)
  • Error - Problème de configuration (voir les détails dans le dashboard)

Cliquez sur Refresh 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 leur expiration. HTTPS est requis, donc les requêtes HTTP redirigent vers HTTPS.

Vous n'avez pas besoin de configurer les certificats manuellement.

Domaines racine

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

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

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

Supprimer un domaine

Pour déconnecter un domaine personnalisé :

  1. Allez dans SettingsDomain
  2. Cliquez sur Remove Domain
  3. Votre documentation reste accessible sur le sous-domaine *.jamdesk.app

La suppression d'un domaine ayant « Host at /docs » activé déploiera automatiquement une nouvelle version pour mettre à jour les chemins d'URL.

Utilisateurs de Cloudflare

Si vous utilisez Cloudflare comme fournisseur DNS :

  1. Définissez le statut du proxy sur DNS only (icône nuage gris) pendant la vérification du domaine
  2. Laissez Vercel gérer le SSL : désactivez « Always Use HTTPS » de Cloudflare pour le sous-domaine de documentation
  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 fonctionne. Utilisez le nuage gris uniquement pendant la vérification, puis repassez au nuage orange. Consultez Cloudflare Workers setup pour plus de détails.

Dépannage

ProblèmeSolution
Domaine bloqué sur « Pending »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, passez au nuage gris pendant la vérification (voir Utilisateurs de Cloudflare ci-dessus)
CNAME ne se résout pasVérifiez l'enregistrement chez votre 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 termine 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 DNS Troubleshooting.

Le sous-domaine jamdesk.app entre-t-il en concurrence avec mon domaine dans les résultats de recherche ?

Non. Une fois votre domaine personnalisé actif, les pages diffusées directement depuis votre sous-domaine [slug].jamdesk.app incluent un lien canonique pointant vers votre domaine, de sorte que les moteurs de recherche considèrent votre domaine comme la source de référence unique et y consolident tous les signaux de classement.

Et ensuite ?

Sous-domaines

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

Hébergement en sous-chemin

Héberger la documentation sur example.com/docs

Dépannage DNS

Diagnostiquer les problèmes de configuration DNS