Skip to main content

Enterprise Server 3.20 은(는) 현재 릴리스 후보로 제공됩니다.

GitHub 앱 등록

GitHub App은 개인 계정뿐만 아니라 소유하고 있는 조직이나 enterprise에도 등록이 가능합니다.

GitHub Apps

등록에 대한 정보

GitHub App은(는) 몇 가지 방법으로 등록할 수 있습니다.

  •         **개인 계정**에서.
    
  • 귀하가 소유한 조직 아래에서.
  • 모든 앱을 관리할 수 있는 권한을 부여받은 조직에서. 조직에서 GitHub 앱 관리자 추가 및 제거 항목을 참조하세요.
  •         **엔터프라이즈**에 속하지만, 해당 엔터프라이즈와 엔터프라이즈 내의 조직에만 설치할 수 있습니다.
    

GitHub App을(를) 등록하는 방법

  1. GitHub의 페이지 오른쪽 위 모서리에서 프로필 사진을 클릭합니다.

  2. 계정 설정으로 이동합니다.

    • 개인 계정 소유한 앱의 경우 설정을 클릭합니다.
    • 조직이 소유한 앱의 경우:
      1. 사용자의 조직을 클릭합니다.
      2. 조직 오른쪽에서 설정을 클릭합니다.
    • 엔터프라이즈가 소유한 앱의 경우:
      1. 엔터프라이즈 설정을 클릭합니다.
  3. GitHub App 설정으로 이동합니다.

    • 개인 계정 또는 조직이 소유한 앱의 경우:
      1. 왼쪽 사이드바에서 개발자 설정을 클릭하고 GitHub Apps 를 클릭합니다.
    • 엔터프라이즈가 소유한 앱의 경우:
      1. 왼쪽 사이드바의 설정을 클릭한 다음 GitHub Apps 을(를) 클릭합니다.
  4.        **새 GitHub App** 을 클릭합니다.
    
  5. "GitHub App 이름"에 앱의 이름을 입력합니다. 명확하고 짧은 이름을 선택해야 합니다. 이름은 34자를 초과할 수 없습니다. 앱의 이름(소문자로 변환되고 공백이 -으로 대체되고 특수 문자가 바뀐 경우)은 앱이 작업을 수행할 때 사용자 인터페이스에 표시됩니다. 예를 들어 My APp Nämemy-app-name와 같이 표시됩니다.

    이름은 GitHub에서 고유해야 합니다. 고유의 사용자 이름 또는 조직 이름이 아니면 기존 GitHub 계정과 동일한 이름을 사용할 수 없습니다.

  6. 필요에 따라 "설명"에서 앱에 대한 설명을 입력합니다. 사용자는 앱을 설치할 때 이 설명을 보게 됩니다.

  7. "홈페이지 URL"에서 앱 웹 사이트의 전체 URL을 입력합니다. 전용 URL이 없고 앱의 코드가 퍼블릭 리포지토리에 저장된 경우 해당 리포지토리 URL을 사용할 수 있습니다. 또는 앱을 소유한 계정의 URL을 사용할 수 있습니다.

  8. 필요에 따라 "콜백 URL"에서 사용자가 설치 권한을 부여한 후 리디렉션할 전체 URL을 입력합니다.

    최대 10개의 콜백 URL을 입력할 수 있습니다. 콜백 URL을 추가하려면 콜백 URL 추가를 클릭합니다.

    앱이 사용자를 대신하여 작업할 필요가 없는 경우(사용자 액세스 토큰을 생성할 필요가 없음) 이 필드는 무시됩니다. 앱이 웹 애플리케이션 흐름 대신 디바이스 흐름을 사용하여 사용자 액세스 토큰을 생성하는 경우 이 필드는 무시됩니다.

    콜백 URL에 대한 자세한 내용은 사용자 인증 콜백 URL에 대한 정보 항목을 참조하세요. 사용자를 대신하여 작동하도록 사용자 액세스 토큰을 생성하는 방법에 대한 자세한 내용은 사용자를 대신하여 GitHub 앱으로 인증GitHub 앱에 대한 사용자 액세스 토큰 생성 항목을 참조하세요.

  9. 필요에 따라 사용자 액세스 토큰이 만료되지 않도록 하려면 사용자 권한 부여 토큰 만료를 선택 취소 합니다. GitHub은(는) 이 옵션을 선택한 상태로 두는 것이 좋습니다. 만료된 토큰 새로 고침 및 만료되는 사용자 액세스 토큰의 이점에 대한 자세한 내용은 사용자 액세스 토큰 새로 고침 항목을 참조하세요. 앱에서 사용자 액세스 토큰을 생성할 필요가 없는 경우 이 필드는 무시됩니다.

  10. 필요에 따라 사용자가 앱을 설치할 때 권한을 부여하라는 메시지를 표시하려면 설치하는 동안 사용자 권한 부여(OAuth) 요청을 선택합니다. 사용자가 앱에 권한을 부여하는 경우 앱은 사용자 대신 API 요청을 수행하고 사용자에 대한 특성 앱 활동을 만드는 사용자 액세스 토큰을 생성할 수 있습니다. 자세한 내용은 사용자를 대신하여 GitHub 앱으로 인증GitHub 앱에 대한 사용자 액세스 토큰 생성을(를) 참조하세요.

  11. 필요에 따라 디바이스 흐름을 사용하여 사용자 액세스 토큰을 생성하려면 디바이스 흐름 사용을 선택합니다. 자세한 내용은 GitHub 앱에 대한 사용자 액세스 토큰 생성을(를) 참조하세요.

  12. 필요에 따라 "설정 URL"에서 사용자가 앱을 설치한 후 리디렉션할 URL을 입력합니다. 설치 후 추가 설정이 필요한 경우 이 URL을 사용하여 설치 후 수행할 단계를 사용자에게 알릴 수 있습니다. 자세한 내용은 설치 URL 정보을(를) 참조하세요.

    이전 단계에서 설치하는 동안 사용자 권한 부여(OAuth) 요청을 선택한 경우 여기에 URL을 입력할 수 없습니다. 대신 사용자는 추가 설정을 설명할 수 있는 권한 부여 흐름의 일부로 콜백 URL로 리디렉션됩니다.

  13. 필요에 따라 설치를 업데이트한 후 설치 URL로 사용자를 리디렉션하려면 업데이트 시 리디렉션을 선택합니다. 업데이트에는 설치를 위한 리포지토리 추가 또는 제거가 포함됩니다. "설치 URL"이 비어 있으면 무시됩니다.

  14. 필요에 따라 앱이 웹후크 이벤트를 수신하지 않으려면 활성을 선택 취소합니다. 예를 들어 앱이 인증에만 사용되거나 웹후크에 응답할 필요가 없는 경우 이 옵션을 선택 취소합니다. 자세한 내용은 GitHub 앱에서 웹후크 사용을(를) 참조하세요.

  15. 이전 단계에서 활성을 선택한 경우 "웹후크 URL"에서 GitHub이(가) 웹후크 이벤트를 보내야 하는 URL을 입력합니다. 자세한 내용은 GitHub 앱에서 웹후크 사용을(를) 참조하세요.

  16. 필요에 따라 이전 단계에서 활성을 선택한 경우 "웹후크 암호"에서 비밀 토큰을 입력하여 웹후크를 보호합니다. GitHub은(는) 웹후크 암호를 설정할 것을 권장합니다. 자세한 내용은 GitHub 앱에서 웹후크 사용을(를) 참조하세요.

  17. 웹후크 URL을 입력한 경우 "SSL 검증"에서 SSL 검증을 사용하도록 설정할지 여부를 선택합니다. GitHub은(는) SSL 확인을 사용하도록 설정하는 것이 좋습니다.

  18. "사용 권한"에서 앱에 필요한 권한을 선택합니다. 각 사용 권한에 대해 드롭다운 메뉴를 사용하고 읽기 전용, 읽기 및 쓰기 또는 액세스 없음을 클릭합니다. 앱에 필요한 최소 권한을 선택해야 합니다. 자세한 내용은 GitHub 앱에 대한 권한 선택을(를) 참조하세요.

  19. 이전 단계에서 활성을 선택하여 앱이 웹후크 이벤트를 수신해야 함을 나타내는 경우 "이벤트 구독"에서 앱이 수신할 웹후크 이벤트를 선택합니다. 이전 단계에서 선택한 사용 권한은 사용 가능한 웹후크 이벤트를 결정합니다. 각 웹후크 이벤트에 대한 자세한 내용은 e 웹후크 이벤트 및 페이로드 항목을 참조하세요.

  20. "이 GitHub App을(를) 설치할 수 있는 위치"에서 이 계정에서만 또는 모든 계정을 선택합니다. 설치 옵션에 대한 자세한 내용은 GitHub 앱 공개 또는 비공개 만들기을(를) 참조하세요.

    참고

    GitHub App이(가) 엔터프라이즈에 등록된 경우 이 단계는 적용되지 않습니다.

  21.        **GitHub App 만들기**를 선택합니다.
    

다음 단계

GitHub App을(를) 등록한 후에는 GitHub App이(가) 작업을 수행하도록 코드를 작성해야 합니다. 코드 작성 방법을 보여 주는 예시는 다음을 참조하세요.

  •         [AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/quickstart)
    
  •         [AUTOTITLE](/apps/creating-github-apps/guides/building-a-github-app-that-responds-to-webhook-events)
    
  •         [AUTOTITLE](/apps/creating-github-apps/guides/building-a-login-with-github-button-with-a-github-app)
    
  •         [AUTOTITLE](/apps/creating-github-apps/guides/building-a-cli-with-a-github-app)
    
  •         [AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow)
    

모범 사례를 따르는 것을 목표로 해야 합니다. 자세한 내용은 GitHub 앱을 만들기 위한 모범 사례을(를) 참조하세요.

GitHub App이(가) 완전히 빌드되면 GitHub App을(를) 설치하고 GitHub App을(를) 다른 사용자와 공유할 수 있습니다. 자세한 내용은 고유한 GitHub 앱 설치GitHub 앱 공유을(를) 참조하세요.

언제든지 GitHub App의 설정을 변경할 수 있습니다. 자세한 내용은 GitHub 앱 등록 수정을(를) 참조하세요.