Modos de solo lectura en Discourse

Documentación Gestión del sitio
, ,
1

:bookmark: Esta guía explica los diversos modos de solo lectura disponibles en Discourse, cómo habilitarlos y deshabilitarlos, y los escenarios en los que podría desear usar cada modo.

:person_raising_hand: Nivel de usuario requerido: Administrador

Administrar una comunidad en línea vibrante en Discourse requiere ocasionalmente que los administradores limiten temporalmente las actividades de los usuarios. Estas situaciones pueden variar desde realizar mantenimiento del servidor, facilitar copias de seguridad o migrar servidores. Durante tales momentos, es crucial restringir las actividades del foro sin cerrar completamente el acceso de los usuarios.

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

Esta guía explora estos modos, centrándose específicamente en cómo habilitarlos y deshabilitarlos, incluida la gestión de situaciones en las que ciertos modos se cruzan.

Comprensión de los Modos de Solo Lectura

Discourse admite dos niveles diferentes de modos de Solo Lectura adaptados para satisfacer 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 se “congele” esencialmente 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 nuevos inicios de sesión en el foro.

  2. Modo Solo Escritura para el Personal

    • Restringe a los usuarios estándar las operaciones de escritura en el foro, como publicar, comentar o dar “me gusta”. Los usuarios estándar se limitan a operaciones de solo lectura y no podrán iniciar sesión en sus cuentas una vez que este modo esté habilitado.
    • Permite que las actividades de los administradores y moderadores continúen normalmente. 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 garantizan flexibilidad en la gestión de la operabilidad del foro durante períodos administrativos críticos.

Cómo Habilitar/Deshabilitar Modos de Solo Lectura

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

Modo de Solo Lectura Completo

A través de la Consola 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 rails con rails c:

Discourse.enable_readonly_mode(Discourse::USER_READONLY_MODE_KEY)

A través del 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 habilitar el modo de solo lectura.

image
image1971×298 22.3 KB

Para deshabilitar el Modo de Solo Lectura, ejecute el siguiente comando 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.

image
image1956×381 30.5 KB

Modo Solo Escritura para el Personal

:discourse: El modo Solo Escritura para el Personal solo se puede habilitar / deshabilitar desde la consola rails de Discourse. Si su sitio está alojado por Discourse, comuníquese con team@discourse.org si desea habilitar o deshabilitar cualquiera de estos modos.

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

Discourse.enable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY)

Para deshabilitar:

Discourse.disable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY)

Mejores Prácticas

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

Preguntas Frecuentes

  • ¿Cuánto tiempo se tarda en habilitar/deshabilitar 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 de mi sitio debido al modo de solo lectura. ¿Qué puedo hacer para acceder a mi sitio nuevamente?

  • 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 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.
    • 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 que expira, ya que la activación de solo lectura por parte de un usuario debe sobrevivir a los reinicios del contenedor. Otras claves se establecen con un TTL de 60 segundos y tenemos un hilo para extender la expiración cada 30 segundos para garantizar que una aplicación nunca se quede atascada en modo de solo lectura.
    • PG_READONLY_MODE_KEY y PG_FORCE_READONLY_MODE_KEY se utilizan para el failover de PG. El primero se establece como una clave que expira, mientras que el segundo no expira.
9 Me gusta
2

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

1 me gusta
3

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. :slightly_smiling_face:

1 me gusta
4

Pero, ¿qué hace discourse enable_readonly?

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

¿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
6

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.
2 Me gusta
7

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

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.

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

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

¡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.

2 Me gusta
8

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!

3 Me gusta
9

¿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?

10

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