Modalità di Sola Lettura in Discourse

Documentazione Gestione del sito
, ,
1

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

:person_raising_hand: Livello utente richiesto: Amministratore

La gestione di una vivace community online su Discourse richiede occasionalmente agli amministratori di limitare temporaneamente le attività degli utenti. Queste situazioni possono variare dall’esecuzione della manutenzione del server, alla facilitazione dei backup o alla transizione dei server. Durante tali periodi, è fondamentale limitare le attività del forum senza chiudere completamente l’accesso agli utenti.

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

Questa guida esplora queste modalità, concentrandosi in particolare su come abilitarle e disabilitarle, inclusa la gestione delle situazioni in cui determinate modalità si intersecano.

Comprensione delle Modalità di Sola Lettura

Discourse supporta due diversi livelli di modalità di Sola Lettura adattati per soddisfare varie esigenze amministrative. Queste sono:

  1. Modalità di Sola Lettura Completa

    • Restringe tutte le operazioni di scrittura nel forum, impedendo a qualsiasi utente di creare o modificare contenuti, come postare, 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 attraverso i contenuti esistenti senza influire sul database.
    • Disabilita la modifica di qualsiasi impostazione del sito Admin o personalizzazione del sito in modo che lo stato attuale del database venga preservato.
    • Disabilita nuovi accessi al forum.

  2. Modalità Solo Scrittura Staff

    • Restringe gli utenti standard dalle operazioni di scrittura nel forum, come postare, commentare o mettere “mi piace”. Gli utenti standard sono limitati alle operazioni di sola lettura e non potranno accedere ai propri account una volta abilitata questa modalità.
    • Consente alle attività di Admin e Moderatore di continuare normalmente. Gli Admin possono modificare le impostazioni del sito e gli utenti staff possono eseguire operazioni di scrittura come postare, mettere “mi piace” o modificare profili.

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

Come Abilitare/Disabilitare le Modalità di Sola Lettura

:warning: Gli Admin dovrebbero gestire attentamente la transizione tra le diverse modalità di sola lettura. Prima di abilitare qualsiasi modalità di sola lettura, assicurati che una precedentemente attivata sia disabilitata.

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 container Docker con ./launcher enter app e poi nella console rails con rails c:

Discourse.enable_readonly_mode(Discourse::USER_READONLY_MODE_KEY)

Tramite Pannello Admin

Se hai accesso amministrativo tramite l’interfaccia web, puoi navigare su Admin > Backups > Enable Read-Only Mode per abilitare la modalità di sola lettura.

image
image1971×298 22.3 KB

Per disabilitare la Modalità di Sola Lettura, esegui il seguente comando rails:

Discourse.disable_readonly_mode(Discourse::USER_READONLY_MODE_KEY)

Oppure, utilizza il pannello admin navigando su Admin > Backups > Disable Read-Only Mode.

image
image1956×381 30.5 KB

Modalità Solo Scrittura Staff

:discourse: La modalità Staff Writes Only può essere abilitata/disabilitata solo dalla console rails di Discourse. Se il tuo sito è ospitato da Discourse, contatta team@discourse.org se desideri abilitare o disabilitare una di queste modalità.

Per abilitare la Modalità Solo Scrittura Staff, utilizza il seguente comando della console rails:

Discourse.enable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY)

Per disabilitare:

Discourse.disable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY)

Best Practices

  • Comunicazione Tempestiva: Informa la tua community in anticipo sui periodi di sola lettura programmati per impostare aspettative adeguate.
  • Test: Prima di implementare queste modalità durante operazioni critiche, conduci test durante periodi di basso traffico per comprendere il loro impatto.
  • Documentazione: Tieni registri dettagliati di quando e perché ogni modalità è stata abilitata o disabilitata per assistere nella futura pianificazione operativa.

FAQ

  • Quanto tempo ci vuole per abilitare/disabilitare la Modalità di Sola Lettura?

    • La modifica è immediata. Tuttavia, l’esperienza utente può variare leggermente a seconda delle loro 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 di nuovo al mio sito?

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

    • READONLY_MODE_KEY viene utilizzato principalmente per il processo di backup e ripristino ed è attivato dall’applicazione stessa. 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 sopravviverà a un riavvio del container.
    • USER_READONLY_MODE_KEY viene utilizzato quando un admin fa clic sul pulsante di sola lettura nell’interfaccia admin. La cosa speciale di questa chiave è che non la impostiamo come chiave in scadenza poiché la sola lettura abilitata da un utente deve sopravvivere ai riavvii del container. Altre chiavi sono impostate con una TTL di 60 secondi e abbiamo un thread per estendere la scadenza ogni 30 secondi per garantire che un’app non rimanga mai bloccata in modalità di sola lettura.
    • PG_READONLY_MODE_KEY e PG_FORCE_READONLY_MODE_KEY vengono utilizzati per il failover PG. Il primo è impostato come chiave in scadenza mentre il secondo non scade.
9 Mi Piace
2

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

1 Mi Piace
3

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

1 Mi Piace
4

Ma cosa fa discourse enable_readonly?

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

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
6

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
2 Mi Piace
7

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

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

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

Forse. Non mi è chiaro chi lo userebbe.

Sarebbe fantastico!

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

2 Mi Piace
8

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!

3 Mi Piace
9

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?

10

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