在自托管网站上安装插件

[Discourse]

本指南假设您已进行了自托管标准安装。我们仅在此处支持标准的安装方法，因此这些说明假定您已完成标准安装。

本指南仅适用于自托管 Discourse 实例。如果您使用的是托管服务，可用插件由您的托管服务提供商控制。例如，在我们的托管服务上，这些特定的插件按托管层级提供。

截至 2025 年中期，许多流行的官方插件已捆绑到 Discourse 核心中。这些插件（包括 Solved、Data Explorer、AI、Assign、Reactions 等）不再需要单独安装——它们随 Discourse 一起提供，可以通过站点设置启用。如果您尝试使用仍位于 app.yml 中的捆绑插件进行重建，您将看到一条 HINT 消息提示您将其删除。本指南适用于未与核心捆绑的插件。

在本教程中，我们将安装 Discourse Shared Edits 插件。

本教程要求了解如何使用 GitHub 仓库，特别是如何获取或复制 git clone URL 以及如何使用 nano 通过终端编辑 YAML (*.yml) 文件，特别是如何在 nano 中保存和退出。YAML 文件非常注重缩进，因此在复制、粘贴和编辑 Discourse 实例所需的 *.yml 文件时，请务必注意这一点。在 .yml 文件中始终使用空格进行缩进，不要使用制表符。

• 复制插件的 GitHub git clone URL。

• 访问容器的 app.yml 文件（位于 /var/discourse/containers/）

  cd /var/discourse
  nano containers/app.yml
  

• 将插件的存储库 URL 添加到容器的 app.yml 文件中：

  hooks:
    after_code:
      - exec:
          cd: $home/plugins
          cmd:
            - git clone https://github.com/discourse/docker_manager.git
            - git clone https://github.com/discourse/discourse-shared-edits.git
  

  将插件的 git clone URL 添加到包含 git clone https://github.com/discourse/docker_manager.git 的行的正下方）

  遵循 docker_manager.git 行的现有格式；如果它包含 sudo -E -u discourse，则在新行中也包含该前缀。

• 重建容器：

  cd /var/discourse
  ./launcher rebuild app
  

  大功告成，您已在 Discourse 实例上成功安装了 Discourse Shared Edits 插件！

---

私有仓库中的插件

如果您托管在私有仓库中，则必须使用 OAuth 令牌：

Managing your personal access tokens - GitHub Docs

使用 OAuth 令牌，您可以以与公共仓库相同的方式安装插件，并且无需创建 SSH 密钥。

hooks:
  after_code:
    - exec:
        cd: $home/plugins
        cmd:
              - git clone https://<token>@github.com/owner/repo.git

我们强烈建议您对私有仓库中的插件使用 OAuth 令牌。但是，如果您无法使用，请参阅下文。

SSH 密钥私有安装步骤

• 假设您的私有 git 仓库托管在 GitHub 上，您需要将服务器的用户公有 SSH 密钥添加到 GitHub 仓库的部署密钥（https://github.com/SecretOrg/secret-plugin/settings/keys）。

• 如下例所示修改 app.yml 文件：

run:
  - exec: echo "Beginning of custom commands"
  
  - exec: cd /var/www/discourse && sudo -u discourse bundle install --deployment --without test --without development
  - exec: echo "Host github.com\n\tStrictHostKeyChecking no\n" >> /user/.ssh/config
  - file:
      path: /user/.ssh/id_rsa
      chmod: 600
      contents: |
        -----BEGIN RSA PRIVATE KEY-----
        MIIEogIBAAKCAQEArCQG213utzqE5YVjTVF5exGRCkE9OuM7LCp/FOuPdoHrFUXk
           .... etc ....
        -----END RSA PRIVATE KEY-----
  - file:
      path: /user/.ssh/id_rsa.pub
      chmod: 600
      contents: ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAklOUpkDHrfHY17SbrmTIpNLTGK9Tj .... etc .... user@discourse
  - exec: cd $home/plugins && git clone git@github.com:SecretOrg/secret-plugin.git
  - exec: cd $home && sudo -E -u discourse bundle exec rake db:migrate
  - exec: cd $home && rm -fr tmp/cache
  - exec: cd $home &&  sudo -E -u discourse bundle exec rake assets:precompile
  - exec: rm /user/.ssh/id_rsa
  - exec: rm /user/.ssh/id_rsa.pub

  - exec: echo "End of custom commands"

• 重建容器：

cd /var/discourse
./launcher rebuild app

您的私有插件应该已安装在您的 Discourse 实例上。

如何卸载插件

要删除插件，只需从 app.yml 文件中删除 - git clone https://github.com/... 行，然后通过以下命令重建您的站点：

cd /var/discourse
./launcher rebuild app