Control de acceso
Elige cómo acceden los lectores a tus docs: totalmente públicos, protegidos con contraseña, mixtos público/privado o SSO. Compara opciones.
Jamdesk te ofrece cuatro formas de controlar quién puede leer tus docs. La mayoría de los equipos elige una y se queda con ella; algunos combinan varias.
Elige el enfoque adecuado
| Enfoque | Úsalo cuando | Configuración |
|---|---|---|
| Totalmente público | Documentación de producto orientada al exterior, proyectos de código abierto, cualquier cosa que quieras indexada y compartible. | Predeterminado; no requiere configuración. |
| Contraseña para todo el sitio | Todo es interno: runbooks de ingeniería, docs solo para partners, un producto aún no publicado. Una frase de contraseña compartida protege todo el sitio. | auth.password.enabled: true en docs.json + establece la contraseña en el dashboard. Consulta 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 enumera esas páginas en auth.password.private[]. Consulta 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 con revocación de acceso al eliminar al usuario. | Plan Enterprise. Consulta SSO. |
Puedes cambiar entre enfoques en cualquier momento editando docs.json y haciendo push. Cambiar de todo el sitio a mixto (o viceversa) toma un solo build.
Patrones comunes
Docs internos y externos en un solo proyecto
La mayoría de los equipos quieren docs internos extensos protegidos por inicio de sesión junto con un sitio público más pequeño para los clientes. No necesitas dos proyectos. Usa el modo mixto en un solo proyecto de Jamdesk:
---
title: Incident Runbook
private: true
---Las páginas con private: true quedan protegidas; el resto permanece público. Todo vive en un solo repositorio con un build y un dashboard. La pantalla de desbloqueo solo aparece cuando un lector llega a una página protegida.
Para secciones internas más grandes, enumera 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 junto con esto (eso es el modo de todo el sitio, lo opuesto a lo que quieres 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 totalmente diferentes, dominios personalizados separados, analítica separada o distintos niveles de plan. Ejemplos: 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 de inmediato su acceso a los docs. Consulta SSO para una visión general y cómo iniciar una conversación con ventas.
Editores vs. lectores
A veces se confunden tres conceptos de acceso distintos:
| Rol | Qué hace | Cómo se otorga el acceso |
|---|---|---|
| Editores | Escriben y actualizan contenido MDX. | Los docs se editan haciendo commit de MDX a tu repositorio de GitHub conectado, así que los permisos de tu repositorio de GitHub son los permisos de editor. No existe un rol de editor de Jamdesk independiente superpuesto: 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 a través de tu IdP (SSO). |
| Miembros del equipo del dashboard | Gestionan builds, analítica y configuración del proyecto en el dashboard de Jamdesk. | Se invitan desde Settings → Team en el dashboard. No crean contenido directamente. Consulta Miembros del equipo. |
Un miembro del equipo puede tener cualquier combinación de los tres roles. Son ejes independientes.