GitHub 앱 등록

GitHub Apps

등록 정보

본인의 개인 계정이나 본인이 소유한 조직 또는 조직이 소유한 모든 앱을 관리할 수 있는 권한을 부여한 조직에 GitHub App을(를) 등록할 수 있습니다. 자세한 내용은 "조직에서 GitHub App 관리자 추가 및 제거"을(를) 참조하세요.

GitHub App 등록

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

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

   • 개인 계정 소유한 앱의 경우 설정을 클릭합니다.
   • 조직이 소유한 앱의 경우:
     1. 사용자의 조직을 클릭합니다.
     2. 조직 오른쪽에서 설정을 클릭합니다.

3. 왼쪽 사이드바에서 개발자 설정을 클릭합니다.

4. 왼쪽 사이드바에서 GitHub Apps 을 클릭합니다.

5. 새 GitHub 앱을 클릭합니다.

6. "GitHub 앱 이름"에서 앱의 이름을 입력합니다. 명확하고 짧은 이름을 선택해야 합니다. 이름은 34자를 초과할 수 없습니다. 앱의 이름(소문자로 변환되고 공백이 -으로 대체되고 특수 문자가 바뀐 경우)은 앱이 작업을 수행할 때 사용자 인터페이스에 표시됩니다. 예를 들어 My APp Näme은 my-app-name와 같이 표시됩니다.

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

7. 필요에 따라 "설명"에서 앱에 대한 설명을 입력합니다. 사용자와 조직은 앱을 설치할 때 이 설명을 볼 수 있습니다.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

21. "이 GitHub 앱을 설치할 수 있는 위치"에서 이 계정에서만 또는 모든 계정을 선택합니다.{ %ifversion ghec %} Enterprise Managed Users를 사용하는 경우 이 계정에서만이 사용자 계정에 대해 사용하지 않도록 설정됩니다. 이 옵션은 모든 계정 대신 이 엔터프라이즈를 읽습니다.{ % endif %} 설치 옵션에 대한 자세한 내용은 "공개 또는 비공개 GitHub 앱 만들기"을 참조하세요.

22. GitHub 앱 만들기를 클릭합니다.

다음 단계

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

• "GitHub 앱 빌드에 대한 빠른 시작"
• "웹후크 이벤트에 응답하는 GitHub 앱 빌드"
• "GitHub 앱을 사용하여 "GitHub로 로그인" 단추 빌드"
• "GitHub 앱을 사용하여 CLI 빌드"
• "GitHub Actions 워크플로에서 GitHub 앱을 사용하여 인증된 API 요청 만들기"

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

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

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