ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

このバージョンの GitHub Enterprise はこの日付をもって終了となりました: 2021-03-02. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの改善、新機能のためには、最新バージョンのGitHub Enterpriseにアップグレードしてください。 アップグレードに関する支援については、GitHub Enterprise supportに連絡してください。

GitHub Appのインストール

アプリケーションがパブリックなら、インストールURLを通じて、誰でも自分のリポジトリにそのアプリケーションをインストールできます。 アプリケーションがプライベートの場合は、あなたが所有するリポジトリにあなただけがそのアプリケーションをインストールできます。

ここには以下の内容があります:

ノート: GitHub Appは、誰かがアプリケーションを選択したリポジトリにだけインストールした場合でも、アプリケーションが作成するすべてのリポジトリにアクセスできます。

プライベートなGitHub Appのリポジトリへのインストール

プライベートなGitHub Appを作成した場合、自分のOrganizationあるいはユーザリポジトリにそれをインストールできます。 詳しい情報については「プライベートインストールのフロー」を参照してください。

  1. GitHub Appsの設定ページから、アプリケーションを選択してください。
  2. 左のサイドバーで、Install App(アプリケーションのインストール)をクリックしてください。
  3. 適切なリポジトリを含むOrganizationもしくはユーザアカウントの隣の Install(インストール)をクリックしてください。
  4. すべてのリポジトリ、もしくは選択したリポジトリにアプリケーションをインストールしてください。
    アプリケーションのインストール権限
  5. インストールが終わると、選択したアカウントでアプリケーションの設定オプションが表示されます。 ここで変更をすることも、あるいは先のステップを繰り返して他のアカウントへアプリケーションをインストールすることもできます。

ユーザがパブリックなアプリケーションをリポジトリにインストールできるようにする

アプリケーションのホームページのような場所にインストールURLを提供して、パブリックなアプリケーションをユーザがインストールできるようにすることができます。 そして、GitHub上のランディングページからアプリケーションのホームページを指すようにできます。

OAuth AppからGitHub Appに移行しているなら、GitHub Appをインストールする際にリポジトリとアカウントを事前選択するよう、クエリパラメータを利用できます。 詳細については「OAuth AppからGitHub Appへの移行」を参照してください。

以下のステップでは、GitHub Appを構築済みであるものとしています。

  1. GitHub Appの設定ページから、他のユーザがインストールできるように設定したいパブリックなアプリケーションを選択してください。
  2. "Homepage URL(ホームページのURL)"にアプリケーションのホームページのURLを入力し、Save changes(変更を保存)をクリックしてください。
    ホームページのURL
  3. GitHubは、アプリケーションの「ホームページURL」へのリンクを含むアプリケーションのためのランディングページを提供します。 GitHub上のランディングページにアクセスするには、「Public link(公開リンク)」からURLをコピーし、ブラウザに貼り付けてください。
    公開リンク
  4. http(s)://[hostname]/apps/<app name>/installations/newというアプリケーションのインストールURLを含む、アプリケーションのためのホームページを作成してください。

インストール中のユーザの認可

認可のプロセスは、アプリケーションのインストール中に完了させることでシンプルにできます。 そのためには、GitHub上でアプリケーションを作成もしくは変更する際にRequest user authorization (OAuth) during installation(インストール中にユーザの認可(OAuth)をリクエスト)を選択してください。 詳細については「GitHub Appの作成を参照してください。

誰かがアプリケーションをインストールしたら、そのユーザのアクセストークンを取得する必要があります。 詳細については「サイトでのユーザの特定」のステップ2と3を参照してください。

インストール中のアプリケーションの状態の保持

アプリケーションのインストールURLにstateパラメータを提供して、アプリケーションページの状態を保持して、インストールや認可、GitHub Appの更新を受け付けた後にその状態に戻れるようにできます。 たとえば、stateを使ってインストールをユーザあるいはアカウントと関連づけることができます。

状態を保持するには、インストールURLに追加します。

http(s)://[hostname]/apps/<app name>/installations/new?state=AB12t