Discourse中的只读模式

文档 网站管理
, ,
1

:bookmark: 本指南将介绍 Discourse 中可用的各种只读模式，如何启用和禁用它们，以及您可能希望使用每种模式的场景。

:person_raising_hand: 所需用户级别：管理员

在 Discourse 上管理一个充满活力的在线社区，有时需要管理员暂时限制用户活动。这些情况可能包括执行服务器维护、进行备份或迁移服务器。在这些时候，至关重要的是限制论坛活动，而无需完全关闭用户访问。

Discourse 提供各种只读模式供管理员启用，以暂时冻结站点内的不同类型的交互。

本指南将探讨这些模式，重点介绍如何启用和禁用它们，包括处理某些模式相互重叠的情况。

了解只读模式

Discourse 支持两种不同级别的只读模式，以适应各种管理需求。它们是：

  1. 完全只读模式

    • 限制论坛中的所有写入操作，防止任何用户创建或修改内容，例如发帖、评论或点赞。
    • 允许论坛基本上“冻结”在其当前状态，使用户仍然可以阅读和浏览现有内容，而不会影响数据库。
    • 禁用更改任何管理员站点设置或站点自定义，以保留数据库的当前状态。
    • 禁用新的论坛登录。

  2. 仅限员工写入模式

    • 限制标准用户在论坛中的写入操作，例如发帖、评论或点赞。标准用户仅限于只读操作，并且在此模式启用后将无法登录其帐户。
    • 允许管理员和版主正常进行活动。管理员可以更改站点设置，员工用户可以执行写入操作，如发帖、点赞或修改个人资料。

这些模式确保在关键管理期间管理论坛可操作性的灵活性。

如何启用/禁用只读模式

:warning: 管理员应谨慎管理不同只读模式之间的转换。在启用任何只读模式之前，请确保已禁用任何先前激活的模式。

完全只读模式

通过 Rails 控制台

如果您可以访问您的 Discourse 安装，请在通过 ./launcher enter app 进入 Docker 容器后，然后通过 rails c 进入 rails 控制台，使用 Discourse rails 命令行界面执行以下命令：

Discourse.enable_readonly_mode(Discourse::USER_READONLY_MODE_KEY)

通过管理面板

如果您可以通过 Web 界面进行管理访问，可以导航到 Admin > Backups > Enable Read-Only Mode 来启用只读模式。

image
image1971×298 22.3 KB

要禁用只读模式，请执行以下 rails 命令：

Discourse.disable_readonly_mode(Discourse::USER_READONLY_MODE_KEY)

或者，使用管理面板导航到 Admin > Backups > Disable Read-Only Mode。

image
image1956×381 30.5 KB

仅限员工写入模式

:discourse: 仅限员工写入模式只能通过 Discourse rails 控制台启用/禁用。如果您的站点由 Discourse 托管，如果您想启用或禁用此模式中的任何一种，请联系 team@discourse.org。

要启用仅限员工写入模式，请使用以下 rails 控制台命令：

Discourse.enable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY)

要禁用：

Discourse.disable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY)

最佳实践

  • 及时沟通：提前告知您的社区计划的只读时段，以设定适当的预期。
  • 测试：在关键操作期间实施这些模式之前，请在低流量时段进行测试，以了解其影响。
  • 文档记录：详细记录何时以及为何启用或禁用每种模式，以协助未来的运营规划。

常见问题解答

  • 启用/禁用只读模式需要多长时间？

    • 更改是即时的。但是，用户体验可能会因他们在过渡期间的操作而略有不同。

  • 救命！我因为只读模式被锁在我的站点之外，我该如何再次访问我的站点？

  • 我注意到 discourse/lib/discourse.rb 中列出了其他 READ-ONLY 模式，这些模式有什么作用？

    • READONLY_MODE_KEY 主要用于备份和恢复过程，并由应用程序本身触发。此模式也可以通过 Discourse 命令行界面使用 discourse enable_readonly 和 discourse disable_readonly 来启用或禁用。但是，此密钥在容器重启后将不会保留。
    • USER_READONLY_MODE_KEY 在管理员单击管理界面中的只读按钮时使用。此密钥的特殊之处在于我们不将其设置为过期密钥，因为用户启用的只读模式需要能够承受容器重启。其他密钥设置为 TTL 为 60 秒，我们有一个线程每 30 秒扩展一次过期时间，以确保应用程序永远不会卡在只读模式。
    • PG_READONLY_MODE_KEY 和 PG_FORCE_READONLY_MODE_KEY 用于 PG 故障转移。前者设置为过期密钥，而后者是非过期密钥。
9 个赞
2

我看不出有什么区别！如果确实有区别，这些描述可以相应地调整一下吗？

1 个赞
3

我已更新指南以提供更多说明，如果您对任何只读模式仍有疑问，请告知我们。 :slightly_smiling_face:

1 个赞
4

但是 discourse enable_readonly
有什么作用？

它使用了 READONLY_MODE_KEY，它将 ttl 设置为 60，因此它会在某个时候关闭。现在我看到

这个命令有默认行为的原因是什么？即使被坑了几次，我也花了将近十年才了解到这个命令与 Web 界面的只读模式完全不同。我现在还记得有人曾经试图告诉我关于这些密钥的事情，但我没能理解它们的意义。
在我看来，discourse enable_readonly 更明智的做法是执行 Discourse.enable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY)。真希望我多年前就注意到了！
我能提交一个类似这样的 PR 吗？

  desc "enable_readonly", "启用只读模式，允许管理员写入"
  def staff_writes_only
    load_rails

    Discourse.enable_readonly_mode(Discourse::STAFF_WRITES_ONLY_MODE_KEY)
    puts '站点现在处于只读模式，允许管理员写入。'
  end
6

我对这个不太熟悉，但我觉得让 enable_readonly_mode 将站点设置为 staff_writes_only_mode 会令人困惑。它们是不同的模式，在执行某些操作时，您会希望不允许员工写入数据库（例如，在恢复期间，他们将被移除）。

也许我们可以在这里做一些其他事情：

  1. 澄清只读模式在该任务的描述中设置了 TTL
  2. 添加一个调用 keep_readonly_mode 的任务，以便它可以扩展到 60 分钟以上
  3. 添加 enable_staff_writes_only 和 disable_staff_writes_only 任务
2 个赞
7

我同意，但这比“暂时设置为只读模式”要不那么令人困惑。

我很确定恢复脚本本身会设置只读模式，所以它不受此命令的影响。

我宁愿它在设置时声明它是为 X 分钟设置的。描述并不容易找到。

也许吧。我不清楚谁会使用它。

那太好了！

此外，我们需要清楚我们没有将 rake 任务与 discourse 命令提供的命令混淆。

2 个赞
8

说得有道理。您有机会为此提交一个 PR 吗？如果可能的话，enable_staff_writes_only 和 disable_staff_writes_only 命令也一样。谢谢！

3 个赞
9

我想知道哪些时钟会在启动只读模式后停止？设置只读模式后会发生主题顶起（topic bumps）吗？

10

看起来如果通过 Web UI 设置了只读模式，更新也无法工作