Jamdesk Documentation logo

Aperçu du déploiement

Options d'hébergement pour votre documentation — sous-domaine Jamdesk, domaine personnalisé avec SSL, ou sous-chemin /docs derrière votre site existant via un reverse proxy.

Jamdesk déploie automatiquement votre documentation sur un sous-domaine *.jamdesk.app. Lorsque vous êtes prêt à déployer sur votre propre domaine, vous pouvez choisir un sous-domaine personnalisé (comme docs.example.com) ou héberger sur un sous-chemin /docs de votre site principal.

Options de déploiement

OptionIdéal pourComplexité de configuration
Sous-domaine Jamdesk (your-project.jamdesk.app)Lancement rapide, aucun travail DNSFaible
Sous-domaine personnalisé (docs.example.com)Documentation de production avec votre marqueMoyenne
Hébergement sur sous-chemin (example.com/docs)Garder la documentation sur le domaine principalÉlevée

Hébergement par défaut (sans configuration)

Chaque projet est mis en ligne sur un sous-domaine Jamdesk dès que vous connectez un dépôt. C'est l'option la plus simple pour la documentation interne, les previews ou les lancements anticipés.

Domaine personnalisé (sous-domaine)

Utilisez votre propre sous-domaine (par exemple, docs.example.com) pour une URL publique à votre image de marque. Vous devrez ajouter des enregistrements DNS et vérifier la propriété dans le dashboard Jamdesk.

La vérification DNS et SSL sont gérées automatiquement une fois les enregistrements en place. Voir Domaines personnalisés pour la configuration.

Hébergement sur sous-chemin (/docs)

Hébergez la documentation sur example.com/docs en proxyfiant le trafic vers Jamdesk. C'est idéal lorsque vous souhaitez que la documentation soit accessible depuis votre domaine marketing principal.

L'hébergement sur sous-chemin nécessite un proxy ou une couche CDN pour transférer les requêtes et définir l'en-tête X-Jamdesk-Forwarded-Host. Voir Hébergement sur sous-chemin.

Exemple de configuration proxy (nginx)

nginx.conf
location /docs {
    proxy_pass https://YOUR_SLUG.jamdesk.app;
    proxy_set_header X-Jamdesk-Forwarded-Host $host;
}

Pour une configuration complète avec SSL, en-têtes et instructions spécifiques au fournisseur, consultez le guide Hébergement sur sous-chemin.

Guides par fournisseur

Choisissez votre infrastructure pour mettre en place l'hébergement sur sous-chemin :

Cloudflare

Utiliser Cloudflare Workers pour proxyfier le trafic /docs

AWS

Configurer CloudFront avec Route 53

Vercel

Ajouter des rewrites ou un middleware edge

Reverse Proxy

nginx, Apache ou d'autres serveurs proxy

Et ensuite ?

Cycle de build et déploiement

Comment les builds sont déclenchés et déployés

Hébergement sur sous-chemin

Héberger la documentation sur /docs de votre domaine principal

Domaines personnalisés

Configurer docs.votredomaine.com

Dépannage DNS

Résoudre les problèmes de propagation et de vérification DNS