Jamdesk Documentation logo

Resumen del despliegue

Aloja tu documentación: subdominio de Jamdesk, dominio personalizado con SSL, o subruta /docs detrás de tu sitio con un proxy inverso.

Jamdesk despliega tu documentación automáticamente en un subdominio *.jamdesk.app. Cuando estés listo para salir a producción con tu propio dominio, puedes elegir un subdominio personalizado (como docs.example.com) o alojar la documentación en una subruta de tu sitio principal: /docs de forma predeterminada, o cualquier segmento personalizado que elijas.

Opciones de despliegue

OpciónIdeal paraComplejidad de configuración
Subdominio Jamdesk (your-project.jamdesk.app)Lanzamiento más rápido, sin configuración DNSBaja
Subdominio personalizado (docs.example.com)Documentación de producción con tu marcaMedia
Alojamiento en subruta (example.com/docs, personalizable)Mantener la documentación en el dominio principalAlta

Alojamiento predeterminado (sin configuración)

Cada proyecto se publica en un subdominio de Jamdesk en cuanto conectas un repositorio. Es la opción más simple para documentación interna, preview, o lanzamientos tempranos.

Dominio personalizado (subdominio)

Usa tu propio subdominio (por ejemplo, docs.example.com) para una URL pública con tu marca. Añadirás registros DNS y verificarás la propiedad desde el dashboard de Jamdesk.

La verificación de DNS y el SSL se gestionan automáticamente una vez que los registros están configurados. Consulta Dominios personalizados para la configuración.

Alojamiento en subruta

Aloja la documentación en una subruta de tu dominio redirigiendo el tráfico hacia Jamdesk mediante un proxy: example.com/docs de forma predeterminada, o un segmento personalizado como example.com/help. Usa esta opción cuando quieras que la documentación esté bajo tu dominio de marketing principal.

El alojamiento en subruta requiere una capa de proxy o CDN para reenviar las solicitudes y definir el encabezado X-Jamdesk-Forwarded-Host. Consulta Alojamiento en subruta.

Ejemplo de fragmento de proxy (nginx)

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

location /_next/ {
    proxy_pass https://YOUR_SLUG.jamdesk.app;
}

location /_jd/ {
    proxy_pass https://YOUR_SLUG.jamdesk.app;
}

Para obtener una configuración completa con SSL, encabezados y orientación específica del proveedor, consulta la guía Alojamiento en subruta.

Guías de proveedores

Elige tu infraestructura para implementar el alojamiento en subruta:

Cloudflare

Usa Cloudflare Workers como proxy para el tráfico /docs

AWS

Configura CloudFront con Route 53

Vercel

Añade rewrites o middleware de edge

Proxy inverso

nginx, Apache, u otros servidores proxy

¿Qué sigue?

Ciclo de build y despliegue

Cómo se activan y despliegan los builds

Alojamiento en subruta

Aloja la documentación en /docs de tu dominio principal

Dominios personalizados

Configura docs.yourdomain.com

Solución de problemas de DNS

Soluciona problemas de propagación y verificación de DNS