Modos de solo lectura en Discourse

[Discourse]

Esta guía explica los diversos modos de solo lectura disponibles en Discourse, cómo activarlos y desactivarlos, y los escenarios en los que podrías querer utilizar cada uno.

Nivel de usuario requerido: Administrador

Gestionar una comunidad en línea vibrante en Discourse a veces requiere que los administradores limiten temporalmente las actividades de los usuarios. Estas situaciones pueden ir desde realizar mantenimiento del servidor, facilitar copias de seguridad o realizar la transición de servidores. Durante estos momentos, es crucial restringir las actividades del foro sin cerrar por completo el acceso de los usuarios.

Discourse ofrece varios Modos de Solo Lectura que los administradores pueden activar para congelar temporalmente diferentes tipos de interacciones dentro de un sitio.

Esta guía explora estos modos, centrándose específicamente en cómo activarlos y desactivarlos, incluyendo el manejo de situaciones donde ciertos modos se superponen.

Comprender los Modos de Solo Lectura

Discourse admite dos niveles diferentes de modos de solo lectura adaptados a diversas necesidades administrativas. Estos son:

1. Modo de Solo Lectura Completo

• Restringe todas las operaciones de escritura en el foro, impidiendo que cualquier usuario cree o modifique contenido, como publicar, comentar o dar “me gusta”.
• Permite que el foro esté esencialmente “congelado” en su estado actual, de modo que los usuarios aún puedan leer y navegar por el contenido existente sin afectar la base de datos.
• Deshabilita el cambio de cualquier configuración del sitio de administración o personalizaciones del sitio para preservar el estado actual de la base de datos.
• Deshabilita los nuevos inicios de sesión en el foro para usuarios regulares. Los administradores aún pueden iniciar sesión utilizando el flujo de inicio de sesión con correo electrónico de administrador (/u/admin-login).

2. Modo Solo Escritura para Personal

• Restringe las operaciones de escritura en el foro para usuarios estándar, como publicar, comentar o dar “me gusta”. Los usuarios estándar están limitados a operaciones de solo lectura, pero aún pueden iniciar sesión en sus cuentas.
• Permite que las actividades de administración y moderación continúen con normalidad. Los administradores pueden cambiar la configuración del sitio, y los usuarios del personal pueden realizar operaciones de escritura como publicar, dar “me gusta” o modificar perfiles.

Estos modos aseguran flexibilidad en la gestión de la operatividad del foro durante períodos administrativos críticos.

Cómo Activar/Desactivar Modos de Solo Lectura

Los administradores deben gestionar cuidadosamente la transición entre los diferentes modos de solo lectura. Antes de activar cualquier modo de solo lectura, asegúrese de que cualquier modo previamente activado esté desactivado.

Modo de Solo Lectura Completo

Vía Consola de Rails

Si tiene acceso a su instalación de Discourse, utilice la interfaz de línea de comandos de Discourse rails para ejecutar el siguiente comando después de ingresar a su contenedor Docker con ./launcher enter app y luego a la consola de rails con rails c:

Discourse.enable_readonly_mode(Discourse::USER_READONLY_MODE_KEY)

Vía Panel de Administración

Si tiene acceso administrativo a través de la interfaz web, puede navegar a Admin > Backups > Enable Read-Only Mode para activar el modo de solo lectura.

Para desactivar el Modo de Solo Lectura, ejecute el siguiente comando de rails:

Discourse.disable_readonly_mode(Discourse::USER_READONLY_MODE_KEY)

O, utilice el panel de administración navegando a Admin > Backups > Disable Read-Only Mode.

Modo Solo Escritura para Personal

El modo Solo Escritura para Personal solo se puede activar/desactivar desde la consola de rails de Discourse. Si su sitio está alojado por Discourse, póngase en contacto con team@discourse.org si desea activar o desactivar cualquiera de estos modos.

Para activar el Modo Solo Escritura para Personal, utilice el siguiente comando de consola de rails:

Discourse.enable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY)

Para desactivar:

Discourse.disable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY)

Mejores Prácticas

• Comunicación Oportuna: Informa a tu comunidad sobre los períodos de solo lectura programados con anticipación para establecer expectativas adecuadas.
• Pruebas: Antes de implementar estos modos durante operaciones críticas, realiza pruebas durante períodos de bajo tráfico para comprender su impacto.
• Documentación: Mantén registros detallados de cuándo y por qué se activó o desactivó cada modo para ayudar en la planificación operativa futura.

Preguntas Frecuentes (FAQ)

• ¿Cuánto tiempo tarda en activarse/desactivarse el Modo de Solo Lectura?

  • El cambio es inmediato. Sin embargo, la experiencia del usuario puede variar ligeramente dependiendo de sus acciones durante el período de transición.

• ¡Ayuda! Estoy bloqueado fuera de mi sitio debido al modo de solo lectura, ¿qué puedo hacer para acceder a mi sitio nuevamente?

  • Ver: Volver a iniciar sesión como administrador después de bloquearte a ti mismo con el modo de solo lectura o una configuración SSO inválida

• Noté que hay otros modos READ-ONLY listados en discourse/lib/discourse.rb, ¿qué hacen estos modos?

  • READONLY_MODE_KEY se utiliza principalmente para el proceso de copia de seguridad y restauración y es activado por la propia aplicación. Este modo también se puede activar o desactivar desde la interfaz de línea de comandos de Discourse con discourse enable_readonly y discourse disable_readonly. Sin embargo, esta clave no sobrevivirá a un reinicio del contenedor.
  • USER_READONLY_MODE_KEY se utiliza cuando un administrador hace clic en el botón de solo lectura en la interfaz de administración. Lo especial de esta clave es que no la establecemos como una clave con fecha de caducidad, ya que el modo de solo lectura activado por un usuario debe sobrevivir a los reinicios del contenedor. Otras claves se establecen con un TTL (60 segundos para READONLY_MODE_KEY, 300 segundos para PG_READONLY_MODE_KEY) y tenemos un hilo para extender la caducidad cada 30 segundos para asegurar que una aplicación nunca quede atrapada en modo de solo lectura.
  • PG_READONLY_MODE_KEY y PG_FORCE_READONLY_MODE_KEY se utilizan para la conmutación por error de PG. La primera se establece como una clave con fecha de caducidad, mientras que la segunda no caduca.

[Ed_S]

@SaraDev

2. Modo de solo lectura para el usuario

• Restringe a los usuarios estándar de realizar operaciones de escritura como publicar, dar “me gusta” o modificar perfiles.
• Permite que las actividades de Administrador y Moderador continúen con normalidad.

3. Modo de solo escritura para el personal

• Permite que solo los miembros del personal (Administradores y Moderadores) escriban en el foro.
• Los usuarios estándar se limitan a operaciones de lectura.

¡No veo ninguna diferencia! ¿Podrían ajustarse estas descripciones en consecuencia, si es que existe alguna diferencia?

[SaraDev (Sara Devlaeminck)]

@Ed_S

¡No veo ninguna diferencia! ¿Podrían ajustarse estas descripciones en consecuencia, si es que hay alguna diferencia?

He actualizado la guía para proporcionar más claridad aquí, por favor, háganos saber si todavía tiene alguna pregunta sobre alguno de los modos de solo lectura.

[pfaffman (Jay Pfaffman)]

Pero, ¿qué hace discourse enable_readonly?

script/discourse

Utiliza READONLY_MODE_KEY, que establece que ttl sea 60, por lo que se desactiva en algún momento. Ahora veo que

@SaraDev

Este modo también se puede habilitar o deshabilitar desde la interfaz de línea de comandos de Discourse con discourse enable_readonly y discourse disable_readonly. Sin embargo, esta clave no sobrevivirá a un reinicio del contenedor.

¿Hay alguna razón por la que este sea el comportamiento predeterminado de este comando? Me ha llevado casi una década aprender que este comando es totalmente diferente del modo de solo lectura de la interfaz web, incluso después de haberme equivocado un montón de veces. Y ahora recuerdo que alguien intentó hablarme de estas claves una vez y no logré comprender su importancia.

En mi opinión, algo mucho más sensato que haría discourse enable_readonly sería hacer un Discourse.enable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY). ¡Ojalá me hubiera dado cuenta de eso hace muchos años!

¿Podría enviar una PR algo como esto?

  desc "enable_readonly", "Habilita el modo de solo lectura, permitiendo escrituras del personal"
  def staff_writes_only
    load_rails

    Discourse.enable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY)
    puts 'El sitio ahora está en modo de solo lectura con escrituras permitidas para el personal.'
  end

[pmusaraj (Penar Musaraj)]

@pfaffman

En mi opinión, algo mucho más sensato para discourse enable_readonly sería hacer un Discourse.enable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY). ¡Ojalá me hubiera dado cuenta hace muchos años!

No estoy muy familiarizado con esto, pero creo que sería confuso que enable_readonly_mode configurara el sitio en un staff_writes_only_mode. Son modos diferentes, cuando se realizan ciertas operaciones, no se permitirían escrituras a la base de datos para el personal (durante una restauración, por ejemplo, se eliminarán).

Quizás en su lugar podamos hacer algunas otras cosas aquí:

1. Aclarar que el modo de solo lectura establece una TTL en la descripción de esa tarea.
2. Añadir una tarea que invoque keep_readonly_mode para que pueda extenderse a más de 60 minutos.
3. Añadir tareas enable_staff_writes_only y disable_staff_writes_only.

[pfaffman (Jay Pfaffman)]

@pmusaraj

No estoy muy familiarizado con esto, pero creo que sería confuso que enable_readonly_mode pusiera el sitio en un staff_writes_only_mode.

Estaría de acuerdo, pero sería mucho menos confuso que “establecer modo de solo lectura por un tiempo”.

@pmusaraj

querrías que al personal no se le permitieran escrituras en la base de datos (durante una restauración, por ejemplo, se eliminarán).

Estoy bastante seguro de que el script de restauración establece el modo de solo lectura por sí mismo, por lo que no se ve afectado por este comando.

@pmusaraj

• aclarar que el modo de solo lectura establece un TTL en la descripción de esa tarea

Preferiría que proclamara que se establece por X minutos cuando se establece. No es tan fácil encontrar la descripción.

@pmusaraj

• agregar una tarea que invoque keep_readonly_mode para que pueda extenderse a más de 60 minutos

Quizás. No tengo claro quién lo usaría.

@pmusaraj

1. agregar tareas enable_staff_writes_only y disable_staff_writes_only

¡Eso sería genial!

Además, debemos dejar claro que no estamos confundiendo las tareas de rake con los comandos disponibles a través del comando discourse.

[pmusaraj (Penar Musaraj)]

@pfaffman

Preferiría que anunciara que está configurado para X minutos cuando está configurado. No es tan fácil encontrar la descripción.

Tiene sentido. ¿Hay alguna posibilidad de que puedas enviar esto como un PR? Lo mismo para los comandos enable_staff_writes_only y disable_staff_writes_only, si es posible. ¡Gracias!

[Ethsim2 (Ethan)]

¿Tengo curiosidad de qué relojes se detienen después de iniciar el modo de solo lectura? ¿Se producirán cambios en los temas después de configurar el modo de solo lectura?

[Ethsim2 (Ethan)]

también parece que las actualizaciones no funcionan si el modo de solo lectura está configurado por la interfaz de usuario web