ノート: GitHub Appは、誰かがアプリケーションを選択したリポジトリに� けインストールした� �合でも、アプリケーションが作成するすべてのリポジトリにアクセスできます。
プライベートなGitHub Appのリポジトリへのインストール
プライベートなGitHub Appを作成した� �合、自分のOrganizationあるいはユーザリポジトリにそれをインストールできます。 詳しい情� �については「プライベートインストールのフロー」を参照してく� さい。
- GitHub Appsの設定ページから、アプリケーションを選択してく� さい。
- 左のサイドバーで、Install App(アプリケーションのインストール)をクリックしてく� さい。
- Click Install next to the organization or personal account containing the correct repository.
- すべてのリポジトリ、もしくは選択したリポジトリにアプリケーションをインストールしてく� さい。
- インストールが終わると、選択したアカウントでアプリケーションの設定オプションが表示されます。 ここで変更をすることも、あるいは先のステップを繰り返して他のアカウントへアプリケーションをインストールすることもできます。
ユーザがパブリックなアプリケーションをリポジトリにインストールできるようにする
アプリケーションのホー� ページのような� �所にインストールURLを提供して、パブリックなアプリケーションをユーザがインストールできるようにすることができます。 そして、GitHub上のランディングページからアプリケーションのホー� ページを指すようにできます。
OAuth AppからGitHub Appに移行しているなら、GitHub Appをインストールする際にリポジトリとアカウントを事前選択するよう、クエリパラメータを利用できます。 詳細については「OAuth AppからGitHub Appへの移行」を参照してく� さい。
以下のステップでは、GitHub Appを構築済みであるものとしています。
- GitHub Appの設定ページから、他のユーザがインストールできるように設定したいパブリックなアプリケーションを選択してく� さい。
- "Homepage URL(ホー� ページのURL)"にアプリケーションのホー� ページのURLを入力し、Save changes(変更を保存)をクリックしてく� さい。
- GitHubは、アプリケーションの「ホー� ページURL」へのリンクを含むアプリケーションのためのランディングページを提供します。 GitHub上のランディングページにアクセスするには、「Public link(公開リンク)」からURLをコピーし、ブラウザに貼り付けてく� さい。
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