Control de Acceso
Elige cómo los lectores acceden a tus docs: totalmente público, protegido por contraseña, mixto o SSO. Compara las opciones y elige la que mejor se adapte.
Jamdesk te ofrece cuatro formas de controlar quién puede leer tu documentación. La mayoría de los equipos elige una y la mantiene; algunos combinan opciones.
Elige el enfoque adecuado
| Enfoque | Úsalo cuando | Configuración |
|---|---|---|
| Totalmente público | Docs de producto orientados al público externo, proyectos de código abierto, cualquier cosa que quieras indexada y compartible. | Por defecto — sin configuración. |
| Contraseña para todo el sitio | Todo es interno: runbooks de ingeniería, docs solo para socios, un producto sin lanzar. Una frase de contraseña compartida protege todo el sitio. | auth.password.enabled: true en docs.json + establece la contraseña en el dashboard. Ver Protección con Contraseña. |
| Mixto (algunas páginas privadas) | La mayoría de los docs son públicos; unas pocas son internas (un runbook, una función beta, una referencia de API interna). | Añade private: true al frontmatter de las páginas internas, o lístalas en auth.password.private[]. Ver Protección con Contraseña. |
| SSO (Enterprise) | Los lectores deben iniciar sesión con tu proveedor de identidad existente — sin contraseñas compartidas, con registro de auditoría y revocación al eliminar el usuario. | Plan Enterprise. Ver SSO. |
Puedes cambiar entre enfoques en cualquier momento editando docs.json y haciendo push. Cambiar de todo el sitio a mixto (o viceversa) requiere un solo build.
Patrones comunes
Docs internas y externas en un solo proyecto
La mayoría de los equipos quiere docs internas extensas protegidas con inicio de sesión, junto con un sitio público más pequeño para clientes. No necesitas dos proyectos. Usa el modo mixto en un único proyecto de Jamdesk:
---
title: Incident Runbook
private: true
---Las páginas con private: true están protegidas; todo lo demás permanece público. Un repositorio, un build, un dashboard. La pantalla de desbloqueo solo aparece cuando un lector accede a una página protegida.
Para secciones internas más grandes, lista las rutas en docs.json en lugar de marcar cada archivo. Nota: auth.password.private[] activa el modo de páginas específicas automáticamente — no añadas enabled: true (ese es el modo de todo el sitio, lo opuesto a lo que necesitas aquí).
{
"auth": {
"password": {
"hint": "Ask the on-call engineer",
"private": ["/internal/**", "/admin/runbook"]
}
}
}Dos proyectos separados
Usa dos proyectos solo cuando las audiencias necesiten marcas completamente diferentes, dominios personalizados separados, analíticas separadas o niveles de plan distintos. Por ejemplo: un sitio de docs público en docs.acme.com y una wiki interna separada en internal.acme.com. El costo de mantenimiento es mayor: dos builds, dos dashboards, dos dominios.
SSO para el sitio de docs
En los planes Enterprise, los lectores inician sesión con tu proveedor de identidad (Okta, Google Workspace, Azure AD, etc.) en lugar de escribir una contraseña compartida. Es la mejor opción cuando necesitas un registro de auditoría de quién leyó qué, o cuando dar de baja a un usuario debe revocar inmediatamente su acceso a los docs. Ver SSO para la descripción general y cómo iniciar una conversación con ventas.
Editores vs. lectores
A veces se confunden tres conceptos de acceso diferentes:
| Rol | Qué hacen | Cómo se otorga el acceso |
|---|---|---|
| Editores | Escriben y actualizan contenido MDX. | Los docs se editan haciendo commit de MDX en tu repositorio de GitHub conectado, por lo que los permisos de tu repositorio de GitHub son los permisos de editor. No hay un rol de editor de Jamdesk separado añadido encima — cualquiera que pueda hacer push a tu rama de docs puede publicar un cambio. |
| Lectores | Ven el sitio de docs publicado. | Todos (público), cualquiera con la contraseña (modo contraseña), o cualquiera autenticado mediante tu IdP (SSO). |
| Miembros del equipo del dashboard | Gestionan builds, analíticas y configuración del proyecto en el dashboard de Jamdesk. | Invitados mediante Configuración → Equipo en el dashboard. No crean contenido directamente. Ver Miembros del Equipo. |
Un compañero de equipo puede tener cualquier combinación de los tres roles. Son ejes independientes.