Modalità di sola lettura in Discourse

[Discourse]

Questa guida spiega le varie modalità di sola lettura disponibili in Discourse, come attivarle e disattivarle e gli scenari in cui potresti voler utilizzare ciascuna modalità.

Livello utente richiesto: Amministratore

La gestione di una comunità online vivace su Discourse richiede occasionalmente agli amministratori di limitare temporaneamente le attività degli utenti. Queste situazioni possono spaziare dall’esecuzione della manutenzione del server, facilitare i backup o il trasferimento dei server. Durante questi periodi, è fondamentale limitare le attività del forum senza disattivare completamente l’accesso degli utenti.

Discourse offre varie Modalità di Sola Lettura che gli amministratori possono attivare per congelare temporaneamente diversi tipi di interazioni all’interno di un sito.

Questa guida esplora queste modalità, concentrandosi in particolare su come attivarle e disattivarle, inclusa la gestione di situazioni in cui alcune modalità si intersecano.

Comprendere le Modalità di Sola Lettura

Discourse supporta due diversi livelli di modalità di sola lettura, adattati alle diverse esigenze amministrative. Questi sono:

1. Modalità di Sola Lettura Completa

• Limita tutte le operazioni di scrittura nel forum, impedendo a qualsiasi utente di creare o modificare contenuti, come pubblicare, commentare o mettere “mi piace”.
• Consente al forum di essere essenzialmente “congelato” nel suo stato attuale, in modo che gli utenti possano ancora leggere e navigare tra i contenuti esistenti senza impattare il database.
• Disabilita la modifica di qualsiasi impostazione del sito Admin o personalizzazione del sito, in modo da preservare lo stato corrente del database.
• Disabilita i nuovi accessi al forum per gli utenti regolari. Gli amministratori possono ancora accedere utilizzando il flusso di accesso con email admin (/u/admin-login).

2. Modalità Scritture Solo per lo Staff

• Limita gli utenti standard alle operazioni di scrittura nel forum, come pubblicare, commentare o mettere “mi piace”. Gli utenti standard sono limitati alle operazioni di sola lettura, ma possono ancora accedere ai propri account.
• Consente alle attività di Amministratore e Moderatore di continuare normalmente. Gli amministratori possono modificare le impostazioni del sito e gli utenti dello staff possono eseguire operazioni di scrittura come pubblicare, mettere “mi piace” o modificare i profili.

Queste modalità garantiscono flessibilità nella gestione dell’operatività del forum durante i periodi amministrativi critici.

Come Attivare/Disattivare le Modalità di Sola Lettura

Gli amministratori dovrebbero gestire attentamente la transizione tra le diverse modalità di sola lettura. Prima di attivare qualsiasi modalità di sola lettura, assicurati che quella precedentemente attivata sia disattivata.

Modalità di Sola Lettura Completa

Tramite Console Rails

Se hai accesso alla tua installazione di Discourse, utilizza l’interfaccia a riga di comando di Discourse Rails per eseguire il seguente comando dopo essere entrato nel tuo contenitore Docker con ./launcher enter app e poi nella console Rails con rails c:

Discourse.enable_readonly_mode(Discourse::USER_READONLY_MODE_KEY)

Tramite Pannello di Amministrazione

Se hai accesso amministrativo tramite l’interfaccia web, puoi navigare in Admin > Backup > Attiva Modalità di Sola Lettura per attivare la modalità di sola lettura.

Per disattivare la Modalità di Sola Lettura, esegui il seguente comando Rails:

Discourse.disable_readonly_mode(Discourse::USER_READONLY_MODE_KEY)

Oppure, utilizza il pannello di amministrazione navigando in Admin > Backup > Disattiva Modalità di Sola Lettura.

Modalità Scritture Solo per lo Staff

La modalità Scritture Solo per lo Staff può essere attivata/disattivata solo dalla console Rails di Discourse. Se il tuo sito è ospitato da Discourse, contatta team@discourse.org se desideri attivare o disattivare una di queste modalità.

Per attivare la Modalità Scritture Solo per lo Staff, utilizza il seguente comando della console Rails:

Discourse.enable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY)

Per disattivare:

Discourse.disable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY)

Best Practice

• Comunicazione Tempestiva: Informa la tua comunità sui periodi di sola lettura programmati in anticipo per impostare aspettative adeguate.
• Test: Prima di implementare queste modalità durante operazioni critiche, effettua test durante periodi di basso traffico per comprenderne l’impatto.
• Documentazione: Tieni registri dettagliati di quando e perché ogni modalità è stata attivata o disattivata per assistere nella pianificazione operativa futura.

Domande Frequenti (FAQ)

• Quanto tempo richiede l’attivazione/disattivazione della Modalità di Sola Lettura?

  • La modifica è immediata. Tuttavia, l’esperienza dell’utente può variare leggermente a seconda delle sue azioni durante il periodo di transizione.

• Aiuto! Sono bloccato fuori dal mio sito a causa della modalità di sola lettura: cosa posso fare per accedere nuovamente al mio sito?

  • Vedi: Riaccedi come amministratore dopo esserti bloccato fuori con la modalità di sola lettura o una configurazione SSO non valida

• Ho notato che ci sono altre modalità READ-ONLY elencate in discourse/lib/discourse.rb, cosa fanno queste modalità?

  • READONLY_MODE_KEY è utilizzato principalmente per il processo di backup e ripristino ed è attivato dall’applicazione stessa. Questa modalità può anche essere attivata o disattivata dall’interfaccia a riga di comando di Discourse con discourse enable_readonly e discourse disable_readonly. Tuttavia, questa chiave non sopravviverà a un riavvio del contenitore.
  • USER_READONLY_MODE_KEY viene utilizzato quando un amministratore fa clic sul pulsante di sola lettura nell’interfaccia di amministrazione. La particolarità di questa chiave è che non la impostiamo come una chiave con scadenza, poiché la sola lettura attivata da un utente deve sopravvivere ai riavvii del contenitore. Altre chiavi sono impostate con un TTL (60 secondi per READONLY_MODE_KEY, 300 secondi per PG_READONLY_MODE_KEY) e abbiamo un thread per estendere la scadenza ogni 30 secondi per garantire che un’app non rimanga bloccata in modalità di sola lettura.
  • PG_READONLY_MODE_KEY e PG_FORCE_READONLY_MODE_KEY sono utilizzati per il failover di PG. La prima è impostata come una chiave con scadenza, mentre la seconda non ha scadenza.

[Ed_S]

@SaraDev

2. Modalità di sola lettura per l’utente

• Limita gli utenti standard dall’eseguire operazioni di scrittura come pubblicare, mettere “mi piace” o modificare i profili.
• Consente alle attività di amministratori e moderatori di continuare normalmente.

3. Modalità di sola scrittura per lo staff

• Consente solo ai membri dello staff (amministratori e moderatori) di scrivere sul forum.
• Gli utenti standard sono limitati alle operazioni di lettura.

Non vedo una differenza! Queste descrizioni potrebbero essere modificate di conseguenza, se effettivamente c’è una differenza?

[SaraDev (Sara Devlaeminck)]

@Ed_S

Non vedo alcuna differenza! Queste descrizioni potrebbero essere modificate di conseguenza, se effettivamente c’è una differenza?

Ho aggiornato la guida per fornire maggiore chiarezza in merito, fateci sapere se avete ancora domande su una qualsiasi delle modalità di sola lettura.

[pfaffman (Jay Pfaffman)]

Ma cosa fa discourse enable_readonly?

script/discourse

Utilizza READONLY_MODE_KEY, che imposta ttl a 60, quindi si disattiva a un certo punto. Ora vedo che

@SaraDev

Questa modalità può anche essere abilitata o disabilitata dall’interfaccia a riga di comando di Discourse con discourse enable_readonly e discourse disable_readonly. Tuttavia, questa chiave non sopravvive a un riavvio del container.

C’è qualche motivo per cui questo è il comportamento predefinito per questo comando? Mi ci sono voluti quasi dieci anni per imparare che questo comando è totalmente diverso dalla modalità di sola lettura dell’interfaccia web, anche dopo essermi bruciato un bel po’ di volte. E ora ricordo che qualcuno ha cercato di parlarmi di queste chiavi una volta e non sono riuscito a capirne il significato.

IMHO una cosa molto più sensata da fare per discourse enable_readonly sarebbe eseguire Discourse.enable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY). Vorrei averlo notato molti anni fa!

Potrei inviare una PR qualcosa del genere:

  desc "enable_readonly", "Abilita la modalità di sola lettura, consentendo la scrittura da parte dello staff"
  def staff_writes_only
    load_rails

    Discourse.enable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY)
    puts 'Il sito è ora in modalità di sola lettura con scrittura consentita allo staff.'
  end

[pmusaraj (Penar Musaraj)]

@pfaffman

IMHO una cosa molto più sensata da fare per discourse enable_readonly sarebbe fare un Discourse.enable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY). Vorrei averlo notato tanti anni fa!

Non ho molta familiarità con questo, ma penso che sarebbe confusionario per enable_readonly_mode impostare il sito su una staff_writes_only_mode. Sono modalità diverse, quando si eseguono determinate operazioni, si vorrebbe che allo staff non fosse consentita la scrittura nel DB (durante un ripristino, ad esempio, verranno rimossi).

Forse invece possiamo fare alcune altre cose qui:

1. chiarire che la modalità di sola lettura imposta una TTL nella descrizione di quel task
2. aggiungere un task che invochi keep_readonly_mode in modo che possa essere esteso a più di 60 minuti
3. aggiungere i task enable_staff_writes_only e disable_staff_writes_only

[pfaffman (Jay Pfaffman)]

@pmusaraj

Non ho molta familiarità con questo, ma penso che sarebbe confusionario per enable_readonly_mode impostare il sito su una staff_writes_only_mode.

Sarei d’accordo, ma sarebbe molto meno confusionario di “imposta la modalità di sola lettura per un po’”.

@pmusaraj

• vorresti che allo staff non fosse consentita la scrittura nel DB (durante un ripristino, ad esempio, verranno rimossi).

Sono abbastanza sicuro che lo script di ripristino imposti la modalità di sola lettura da solo, quindi non è influenzato da questo comando.

@pmusaraj

• chiarisce che la modalità di sola lettura imposta un TTL nella descrizione di quel task

Preferirei che proclamasse che è impostata per X minuti quando viene impostata. Non è così facile trovare la descrizione.

@pmusaraj

• aggiunge un task che invoca keep_readonly_mode in modo che possa essere esteso a più di 60 minuti

Forse. Non mi è chiaro chi lo userebbe.

@pmusaraj

1. aggiunge i task enable_staff_writes_only e disable_staff_writes_only

Sarebbe fantastico!

Inoltre, dobbiamo essere chiari sul fatto che non stiamo confondendo i rake task con i comandi disponibili tramite il comando discourse.

[pmusaraj (Penar Musaraj)]

@pfaffman

Preferirei che dichiarasse che è impostato per X minuti quando è impostato. Non è così facile trovare la descrizione.

Ha senso. C’è la possibilità che tu possa inviare questo come PR? Lo stesso per i comandi enable_staff_writes_only e disable_staff_writes_only, se possibile. Grazie!

[Ethsim2 (Ethan)]

Sono curioso di sapere quali orologi si fermano dopo aver iniziato la modalità di sola lettura? Gli incrementi degli argomenti avverranno dopo aver impostato la modalità di sola lettura?

[Ethsim2 (Ethan)]

sembra anche che gli aggiornamenti non funzionino se la modalità di sola lettura è impostata dall’interfaccia utente web