セルフホストサイトへのプラグインのインストール

[Discourse]

このガイドは、セルフホスト型の標準インストールを前提としています。ここでは標準のインストール方法のみをサポートしているため、これらの手順は標準インストールを想定しています。

このガイドはセルフホスト型のDiscourseインスタンスにのみ適用されます。マネージドホスティングサービスを使用している場合、利用可能なプラグインはホスティングプロバイダーによって制御されます。例えば、当社のホスティングでは、ホスティング階層によってこれらの特定のプラグインが利用可能です。

このチュートリアルでは、Discourse Solved プラグインをインストールします。

このチュートリアルを理解するには、GitHubリポジトリの使用方法、特にgit clone URLの取得またはコピー方法と、nanoを使用してYAML (*.yml) ファイルをターミナルで編集する方法、特にnanoでの保存と終了の方法についての理解が必要です。YAMLファイルはインデントに厳密に従うため、Discourseインスタンスに必要な*.ymlをコピー＆ペーストして編集する際には、これらを尊重するようにしてください。.ymlファイルでは、タブではなく必ずスペースを使用してください。

• プラグインのGitHub git clone URLをコピーします。

• コンテナのapp.ymlファイルにアクセスします（/var/discourse/にあります）

  cd /var/discourse
  nano containers/app.yml
  

• プラグインのリポジトリURLをコンテナのapp.ymlファイルに追加します。

  hooks:
    after_code:
      - exec:
          cd: $home/plugins
          cmd:
            - sudo -E -u discourse git clone https://github.com/discourse/docker_manager.git
            - sudo -E -u discourse git clone https://github.com/discourse/discourse-solved.git
  

  git clone https://github.com/discourse/docker_manager.gitを含む行のすぐ下にプラグインのgit clone URLを追加します)

  docker_manager.git行の既存の形式に従ってください。もし- sudo -E -u discourseが含まれていない場合は、- git clone https://github.com/discourse/discourse-solved.gitを挿入してください。

• コンテナを再構築します。

  cd /var/discourse
  ./launcher rebuild app
  

  これで、DiscourseインスタンスへのDiscourse Solved プラグインのインストールが正常に完了しました！

---

プライベートリポジトリにプラグインがホストされている場合

OAuthトークンを使用する必要があります。

Managing your personal access tokens - GitHub Docs

OAuthトークンを使用すると、パブリックリポジトリと同じ方法でプラグインをインストールでき、SSHキーを作成する必要はありません。

hooks:
  after_code:
    - exec:
        cd: $home/plugins
        cmd:
              - sudo -E -u discourse 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 "カスタムコマンドの開始"
  
  - 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
           .... その他 ....
        -----END RSA PRIVATE KEY-----
  - file:
      path: /user/.ssh/id_rsa.pub
      chmod: 600
      contents: ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAklOUpkDHrfHY17SbrmTIpNLTGK9Tj .... その他 .... 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 "カスタムコマンドの終了"

• コンテナを再構築します。

cd /var/discourse
./launcher rebuild app

プライベートプラグインがDiscourseインスタンスにインストールされているはずです。

プラグインのアンインストール方法

プラグインを削除するには、app.ymlファイルから- git clone https://github.com/...の行を削除し、以下のコマンドでサイトを再構築するだけです。

cd /var/discourse
./launcher rebuild app

[bloomexperiment (Tracey)]

ガイドを更新し、Discourse Spoiler Alert の代わりに別のプラグインを使用するようにしました。これはコアにバンドルされています。

Discourse Solved を使用しましたが、別のものが良い場合はお知らせください。

[SohaibKhaliq]

Digital OceanでDiscourseをホストしていましたが、そのフォーマットを使用した際にこのエラーが表示されました。

FAILED
--------------------
Pups::ExecError: cd /var/www/discourse/plugins && sudo -E -u discourse git clone https://github.com/discourse/docker_manager.git - sudo -E -u discourse git clone https://github.com/discourse/discourse-solved.git failed with return #<Process::Status: pid 252 exit 129>
Location of failure: /usr/local/lib/ruby/gems/3.2.0/gems/pups-1.2.1/lib/pups/exec_command.rb:132:in `spawn'
exec failed with the params {"cd"=>"$home/plugins", "cmd"=>["sudo -E -u discourse git clone https://github.com/discourse/docker_manager.git - sudo -E -u discourse git clone https://github.com/discourse/discourse-solved.git"]}
bootstrap failed with exit code 129
** FAILED TO BOOTSTRAP ** please scroll up and look for earlier error messages, there may be more than one.
./discourse-doctor may help diagnose the problem.
2a49220a4ff35feac3c1a9a4a9c1cad1094bde4c9ba321975ebc9ae7ead2bbee

その後、このフォーマットを使用しました。

hooks:
  after_code:
    - exec:
        cd: $home/plugins
        cmd:
          - sudo -E -u discourse git clone https://github.com/discourse/docker_manager.git && sudo -E -u discourse git clone https://github.com/discourse/discourse-solved.git

代わりに

hooks:
  after_code:
    - exec:
        cd: $home/plugins
        cmd:
          - sudo -E -u discourse git clone https://github.com/discourse/docker_manager.git
          - sudo -E -u discourse git clone https://github.com/discourse/discourse-solved.git

[wal]

くだらない質問ですみませんが、git clone ステートメントに sudo -E -u discourse を含める必要があるかどうかは、どのように判断すればよいですか？

[Moin]

docker_manager の行はどのようになっていますか？

@Discourse

• docker_manager.git の既存のフォーマットに従ってください。sudo -E -u discourse が含まれていない場合は、- git clone https://github.com/discourse/discourse-solved.git を挿入してください。

[wal]

私のアプリの app.yml の他のエントリには sudo の部分はなかったので、それを省略しました。今のところうまくいっています。

[Overgrow]

@Discourse

app.yml ファイルを以下の例のように変更します。

- exec: echo "Host github.com\n\tStrictHostKeyChecking no\n" >> /user/.ssh/config

この方法はもう機能していないようです。

sh: 1: /user/.ssh/config: ディレクトリが存在しません

セルフホストされたGITリポジトリで、SSHキーを本当に使用したいです。

[pfaffman (Jay Pfaffman)]

コンテナ内にsshキーは必要ありません。これを削除してください。

@Overgrow

- exec: echo "Host github.com\n\tStrictHostKeyChecking no\n" >> /user/.ssh/config

[Overgrow]

すみません、よく理解できませんでした。

私のリポジトリはSSH経由でアクセスできます。SSHキーなしでプラグインをクローンするにはどうすればよいですか？

[pfaffman (Jay Pfaffman)]

ああ。もしかしたら私が間違っているのかもしれません。それなら、適切な権限でそのディレクトリを作成する必要があるのかもしれません。

[Overgrow]

紛らわしいのは、例の中のコマンドの一部は root として実行され、一部はユーザー 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

実行中のコンテナのシェルで調べてみます。

[nwnuyhs (Yang Hongsheng)]

このプラグインのインストールは少し複雑です。テーマのインストールと同じようにできれば素晴らしいのですが。

[pfaffman (Jay Pfaffman)]

Dashboard.literatecomputing.com は数回のクリックでプラグインをインストールできます。無料トライアルグループに参加することで、無料で利用できます。

[Overgrow]

@Discourse

SSHキーのプライベートインストール手順

@Discourse, ガイドを更新したい場合は、こちらが動作するコードです。

プライベートリポジトリにアクセスするために独自のSSHキーを使用するには、次の手順に従ってください。

1. プライベートSSHキーを/var/discourse/shared/standalone/identity/id_rsa（またはコンテナからアクセス可能な別の場所）に配置します（別の場所を選択した場合は、以下のテンプレートのパスを適宜更新することを忘れないでください）。

2. 次のテンプレートを使用してプラグインを追加します。

hooks:
  after_code:
    - exec:
        cd: $home/plugins
        cmd:
          # プライベートリポジトリへのアクセスを設定
          - chown $(whoami) /shared/identity/id_rsa && chmod 600 /shared/identity/id_rsa
          - git config --global core.sshCommand "ssh -o StrictHostKeyChecking=no -o IdentitiesOnly=yes -i /shared/identity/id_rsa"

          # プライベートプラグイン
          - git clone git@example.com:repo/private-discourse-plugin.git

          # アクセスを解除
          - git config --global --unset core.sshCommand

[Jagster (Jakke Flemming)]

必要ないものに感謝します。しかし、私はシンプルなオリジナルで暮らしています。

なぜ私たちの例を使用すべきなのか説明していただけますか？それはこれのせいですか？

プライベートリポジトリにアクセスするために、独自のSSHキーを使用する

[merefield (Robert)]

URLにトークンを使用するのはなぜですか？

[Jagster (Jakke Flemming)]

@Jagster

あなたの例を使用する理由を説明してもらえますか？

さて、この謎を解くためのツールがあります😜

コンテナ設定スニペットの有用性を理解する AI

Jagster:

container/app.yml でこのスニペットを使用したいと思うのはなぜでしょうか？

gpt-4o:

ご質問に効果的に回答するには、container/app.yml の特定のスニペットのコンテキストを理解する必要があります。具体的なスニペットを提供していただけますか？そうすれば、正確で役立つ説明をすることができます。

Jagster:

すみません、このコンポーザーが必要でした。

これがスニペットです：

”””

hooks:
  after_code:
    - exec:
        cd: $home/plugins
        cmd:
          # プライベートリポジトリへのアクセスを設定する
          - chown $(whoami) /shared/identity/id_rsa && chmod 600 /shared/identity/id_rsa
          - git config --global core.sshCommand "ssh -o StrictHostKeyChecking=no -o IdentitiesOnly=yes -i /shared/identity/id_rsa"

          # 私のプライベートプラグイン
          - git clone git@example.com:repo/private-discourse-plugin.git

          # アクセスを解除する
          - git config --global --unset core.sshCommand

”””

gpt-4o:

スニペットをご提供いただきありがとうございます。この YAML スニペットは、Discourse インスタンスの container/app.yml 設定ファイルに含まれることを意図しています。その内容を以下に示します。

hooks:
  after_code:
    - exec:
        cd: $home/plugins
        cmd:
          # プライベートリポジトリへのアクセスを設定する
          - chown $(whoami) /shared/identity/id_rsa && chmod 600 /shared/identity/id_rsa
          - git config --global core.sshCommand "ssh -o StrictHostKeyChecking=no -o IdentitiesOnly=yes -i /shared/identity/id_rsa"

          # 私のプライベートプラグイン
          - git clone git@example.com:repo/private-discourse-plugin.git

          # アクセスを解除する
          - git config --global --unset core.sshCommand

説明

1. ディレクトリの設定:

   cd: $home/plugins
   

   これは、プラグインが配置されているディレクトリ ($home/plugins) に作業ディレクトリを変更します。

2. プライベートリポジトリへのアクセス設定:

   - chown $(whoami) /shared/identity/id_rsa && chmod 600 /shared/identity/id_rsa
   - git config --global core.sshCommand "ssh -o StrictHostKeyChecking=no -o IdentitiesOnly=yes -i /shared/identity/id_rsa"
   

   • SSH 秘密鍵 (id_rsa) の所有権を現在のユーザーに変更し、その権限を 600 に設定します。
   • Git がカスタム SSH コマンドを使用するように設定します。このコマンドは、指定された秘密鍵を使用し、厳格なホストキーチェックを無効にします。

3. プライベートリポジトリのクローン:

   - git clone git@example.com:repo/private-discourse-plugin.git
   

   Discourse プラグインを含むプライベート Git リポジトリをクローンします。

4. SSH コマンドの解除:

   - git config --global --unset core.sshCommand
   

   Git SSH コマンドの設定をデフォルトの状態にリセットします。

このスニペットを使用する時期と理由

1. プライベートリポジトリ: 公開アクセスできず、SSH キーベースの認証が必要なプライベート Discourse プラグインリポジトリがある場合。

2. 自動化: このスクリプトは、プライベートリポジトリへのアクセスを設定し、クローンし、その後環境がリセットされるようにするプロセスを自動化するのに役立ちます。これは、継続的デプロイメントのセットアップや自動サーバープロビジョニングに便利です。

3. セキュリティ管理: 自動化されたデプロイメント中のセキュリティ体制を維持するために不可欠な、SSH キーを安全に処理します（ファイル権限の設定、その後カスタム SSH コマンドの解除）。

重要な考慮事項

• プライベート SSH キー (id_rsa) が安全に管理され、公開されていないことを確認してください。
• セキュリティポリシーに対して、所有権と権限が正しく設定されていることを確認してください。

Discourse の app.yml およびフックに関する詳細情報やコンテキストについては、関連する Discourse ドキュメント を参照してください。

設定に関するさらなる質問や追加の詳細が必要な場合は、お気軽にお尋ねください！

[rrodrigueznt (Ricardo Rodríguez)]

@pfaffman

数回のクリックでプラグインをインストールできます

こんにちは！素晴らしいですね！しかし、無料トライアルグループに参加した後、どのように進めばよいかわかりません！@pfaffmanさん、助けていただけますか？SAMLプラグインをインストールしたいのですが。Literate Computingをテストしてインストールし、実行できると素晴らしいです！

ありがとうございます！

[Overgrow]

@merefield

URLにトークンを使用するのはなぜですか？

私のテンプレートスニペットは、SSHキー以外にGitリポジトリにアクセスする手段がない場合（たとえば、SSH経由でセルフホストされたGitリポジトリの場合）に使用します。