Modos de somente leitura no Discourse

Documentação Gerenciamento do Site
, ,
1

:bookmark: Este guia explica os vários modos de somente leitura disponíveis no Discourse, como habilitá-los e desabilitá-los, e os cenários em que você pode querer usar cada modo.

:person_raising_hand: Nível de usuário necessário: Administrador

Gerenciar uma comunidade online vibrante no Discourse ocasionalmente exige que os administradores limitem temporariamente as atividades dos usuários. Essas situações podem variar desde a execução de manutenção no servidor, facilitando backups ou migrando servidores. Durante esses períodos, é crucial restringir as atividades do fórum sem desligar completamente o acesso dos usuários.

O Discourse oferece vários Modos de Somente Leitura que os administradores podem ativar para congelar temporariamente diferentes tipos de interações dentro de um site.

Este guia explora esses modos, focando especificamente em como habilitá-los e desabilitá-los, incluindo o tratamento de situações em que certos modos se sobrepõem.

Entendendo os Modos de Somente Leitura

O Discourse suporta dois níveis diferentes de modos de somente leitura, adaptados para atender a diversas necessidades administrativas. Eles são:

  1. Modo de Somente Leitura Total
  • Restringe todas as operações de escrita no fórum, impedindo que qualquer usuário crie ou modifique conteúdo, como postar, comentar ou curtir.
  • Permite que o fórum seja essencialmente “congelado” em seu estado atual, permitindo que os usuários ainda leiam e naveguem pelo conteúdo existente sem impactar o banco de dados.
  • Desabilita a alteração de quaisquer configurações do site de administrador ou personalizações do site, para que o estado atual do banco de dados seja preservado.
  • Desabilita novos logins no fórum para usuários comuns. Os administradores ainda podem fazer login usando o fluxo de login por e-mail de administrador (/u/admin-login).
  • Chamadas de API podem ler (GET), mas não podem escrever (POST/PUT/DELETE).
  • Webhooks de saída em fila serão entregues, mas nenhum novo webhook será acionado, pois as ações que os acionariam serão bloqueadas.
  • Webhooks de entrada (bounce de e-mail) serão bloqueados com uma resposta 503. Os provedores de e-mail tentarão novamente de acordo com seus próprios cronogramas de backoff.
  1. Modo de Escrita Apenas para Equipe
  • Restringe usuários padrão de operações de escrita no fórum, como postar, comentar ou curtir. Usuários não pertencentes à equipe são limitados a operações de somente leitura, mas ainda podem fazer login em suas contas.
  • Permite que as atividades de Administrador e Moderador continuem normalmente. Os administradores podem alterar as configurações do site, e os usuários da equipe podem realizar operações de escrita, como postar, curtir ou modificar perfis.
  • Chamadas de API podem ler (GET). Apenas chaves de API de equipe podem escrever (POST/PUT/DELETE).
  • Webhooks de saída em fila serão entregues. Ações da equipe podem acionar novos webhooks de saída, que também serão bem-sucedidos, mas nenhuma ação de usuário não pertencente à equipe acionará webhooks.
  • Webhooks de entrada (bounce de e-mail) serão bloqueados com uma resposta 503. Os provedores de e-mail tentarão novamente de acordo com seus próprios cronogramas de backoff.

Esses modos garantem flexibilidade na gestão da operabilidade do fórum durante períodos administrativos críticos.

Como Habilitar/Desabilitar Modos de Somente Leitura

:warning: Os administradores devem gerenciar cuidadosamente a transição entre diferentes modos de somente leitura. Antes de habilitar qualquer modo de somente leitura, certifique-se de que qualquer um ativado anteriormente foi desabilitado.

Modo de Somente Leitura Total

Via Rails Console

Se você tiver acesso à sua instalação do Discourse, use a interface de linha de comando do Discourse Rails para executar o seguinte comando após entrar no seu contêiner Docker com ./launcher enter app e, em seguida, o console Rails com rails c:

Discourse.enable_readonly_mode(Discourse::USER_READONLY_MODE_KEY)

Via Painel Administrativo

Se você tiver acesso administrativo através da interface web, pode navegar para Admin > Backups > Enable Read-Only Mode para habilitar o modo de somente leitura.

image
image1971×298 22.3 KB

Para desabilitar o Modo de Somente Leitura, execute o seguinte comando do Rails:

Discourse.disable_readonly_mode(Discourse::USER_READONLY_MODE_KEY)

Ou, use o painel administrativo navegando para Admin > Backups > Disable Read-Only Mode.

image
image1956×381 30.5 KB

Modo de Escrita Apenas para Equipe

:discourse: O modo de Escrita Apenas para Equipe só pode ser habilitado/desabilitado a partir do console Rails do Discourse. Se seu site for hospedado pelo Discourse, entre em contato com team@discourse.org se desejar habilitar ou desabilitar qualquer um desses modos.

Para habilitar o Modo de Escrita Apenas para Equipe, use o seguinte comando do console Rails:

Discourse.enable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY)

Para desabilitar:

Discourse.disable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY)

Melhores Práticas

  • Comunicação Pontual: Informe sua comunidade sobre períodos de somente leitura agendados com antecedência para definir expectativas adequadas.
  • Testes: Antes de implementar esses modos durante operações críticas, realize testes em períodos de baixo tráfego para entender seu impacto.
  • Documentação: Mantenha registros detalhados de quando e por que cada modo foi habilitado ou desabilitado para auxiliar no planejamento operacional futuro.

FAQs

  • Quanto tempo leva para habilitar/desabilitar o Modo de Somente Leitura?

    • A mudança é imediata. No entanto, a experiência do usuário pode variar ligeiramente dependendo de suas ações durante o período de transição.

  • Ajuda! Estou bloqueado fora do meu site por causa do modo de somente leitura - o que posso fazer para acessar meu site novamente?

  • Notei que existem outros modos READ-ONLY listados em discourse/lib/discourse.rb, o que esses modos fazem?

    • READONLY_MODE_KEY é usado principalmente para o processo de backup e restauração e é acionado pelo próprio aplicativo. Este modo também pode ser habilitado ou desabilitado a partir da interface de linha de comando do Discourse com discourse enable_readonly e discourse disable_readonly. No entanto, essa chave não sobreviverá a uma reinicialização do contêiner.
    • USER_READONLY_MODE_KEY é usado quando um administrador clica no botão de somente leitura na interface administrativa. O especial sobre essa chave é que não a definimos como uma chave expirável, pois o modo de somente leitura habilitado por um usuário precisa sobreviver a reinicializações do contêiner. Outras chaves são definidas com um TTL (60 segundos para READONLY_MODE_KEY, 300 segundos para PG_READONLY_MODE_KEY) e temos uma thread para estender o vencimento a cada 30 segundos para garantir que um aplicativo nunca fique preso no modo de somente leitura.
    • PG_READONLY_MODE_KEY e PG_FORCE_READONLY_MODE_KEY são usados para failover do PG. O primeiro é definido como uma chave expirável, enquanto o último é não expirável.
9 curtidas
How to turn off forum except for staff
This site is in read only mode
Read Only mode occurring when not scheduled by admin
Limit login to staff only?
Login disabled in read only mode
Create, download, and restore a backup of your Discourse database
Spam: Retroactively get AI to review recent posts and then delete the ones marked as spam
How to turn off forum except for staff
Maintenance mode for administrative members
How to turn off forum except for staff
Trial plan to Purchasing Plan Question
Site automatically exits read-only mode when enabled by 'discourse enable_readonly'
Forum stuck in readonly mode
Admin-Settable Global Read-Only mode
2

Não consigo ver uma diferença! Essas descrições poderiam ser ajustadas de acordo, se de fato houver uma diferença?

1 curtida
3

Atualizei o guia para fornecer mais clareza aqui, por favor, nos informe se você ainda tiver alguma dúvida sobre algum dos modos somente leitura. :slightly_smiling_face:

1 curtida
4

Mas o que faz o comando discourse enable_readonly?

Ele usa READONLY_MODE_KEY, que define o ttl para 60, então ele desativa em algum momento. Agora eu vejo que

Existe alguma razão para este ser o comportamento padrão para este comando? Levei quase uma década para aprender que este comando é totalmente diferente do modo somente leitura da interface web, mesmo depois de ter sido prejudicado várias vezes. E agora me lembro que alguém tentou me contar sobre essas chaves uma vez e eu não consegui entender sua importância.

Na minha opinião, uma coisa muito mais sensata para discourse enable_readonly fazer seria executar Discourse.enable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY). Quem me dera ter notado isso há muitos anos!

Eu poderia enviar um PR algo como isto:

  desc "enable_readonly", "Habilita o modo somente leitura, permitindo escritas de staff"
  def staff_writes_only
    load_rails

    Discourse.enable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY)
    puts 'O site agora está em modo somente leitura com permissão de escritas de staff.'
  end
6

Não estou muito familiarizado com isso, mas acho que seria confuso para enable_readonly_mode definir o site para um staff_writes_only_mode. São modos diferentes, ao realizar certas operações, você não gostaria que os funcionários tivessem permissão para escrever no banco de dados (durante uma restauração, por exemplo, eles serão removidos).

Talvez possamos fazer algumas outras coisas aqui:

  1. esclarecer que o modo somente leitura define um TTL na descrição dessa tarefa
  2. adicionar uma tarefa que invoca keep_readonly_mode para que possa ser estendida para mais de 60 minutos
  3. adicionar tarefas enable_staff_writes_only e disable_staff_writes_only
2 curtidas
7

Concordaria, mas seria muito menos confuso do que “definir modo somente leitura por um tempo”.

Tenho quase certeza de que o script de restauração define o modo somente leitura por si só, portanto, não é afetado por este comando.

Eu preferiria que proclamasse que está definido para X minutos quando for definido. Não é tão fácil encontrar a descrição.

Talvez. Não está claro para mim quem o usaria.

Isso seria ótimo!

Além disso, precisamos deixar claro que não estamos confundindo as tarefas rake com os comandos disponíveis através do comando discourse.

2 curtidas
8

Faz sentido. Há alguma chance de você enviar isso como um PR? O mesmo para os comandos enable_staff_writes_only e disable_staff_writes_only, se possível. Obrigado!

3 curtidas
9

Estou curioso para saber quais clocks param depois de iniciar o modo somente leitura? Os tópicos serão atualizados depois de definir o modo somente leitura?

10

também parece que as atualizações não funcionam se o modo somente leitura for definido pela interface do usuário da web

11

Parece que a interface foi atualizada, então não vejo a opção para desativar o modo somente leitura na seção de Backups do Administrador. Como posso desativá-lo pela interface?

12

Isso é estranho. Vejo os botões Habilitar e Desabilitar, e eles funcionam bem. Você poderia enviar uma captura de tela do que está vendo?

13

Olá @Lucian_Chung,

Por favor, indique também se o seu site é auto-hospedado ou hospedado pelo Discourse e, neste último caso, em qual plano. Desativar o modo somente leitura a partir da interface não é uma opção em algumas condições em um site hospedado.