서비스 데스크 구성

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed

기본적으로 새로운 프로젝트에서 서비스 데스크가 활성화되어 있습니다. 활성화되지 않은 경우 프로젝트 설정에서 활성화할 수 있습니다.

필수 사항:

프로젝트에서 서비스 데스크를 활성화하려면:

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
  2. 설정 > 일반을 선택합니다.
  3. 서비스 데스크를 확장합니다.
  4. 서비스 데스크 활성화 토글을 켭니다.
  5. 선택 사항. 필드를 작성합니다.
  6. 변경 사항 저장을 선택합니다.

이제 이 프로젝트에서 서비스 데스크가 활성화되었습니다. 이메일 주소 아래의 서비스 데스크에 사용할 이메일 주소로 누군가 이메일을 보내면, GitLab은 해당 이메일의 내용으로 기밀 이슈를 생성합니다.

프로젝트 보안 강화

서비스 데스크 프로젝트의 보안을 강화하려면 다음을 수행해야 합니다:

  • 서비스 데스크 이메일 주소를 이메일 시스템의 별칭 뒤에 둠으로써 나중에 이를 변경할 수 있도록 합니다.
  • 이 서비스에 스팸 확인을 추가하기 위해 GitLab 인스턴스에 Akismet를 활성화합니다. 차단되지 않은 이메일 스팸은 많은 스팸 이슈가 생성되는 결과를 낳을 수 있습니다.

요청자에게 전송된 이메일 사용자화

  • GitLab 13.2에서 GitLab 프리미엄에서 GitLab 무료로 이전되었습니다.
  • UNSUBSCRIBE_URL, SYSTEM_HEADER, SYSTEM_FOOTER, ADDITIONAL_TEXT 플레이스홀더가 GitLab 15.9에서 도입되었습니다.
  • %{ISSUE_DESCRIPTION}이 GitLab 16.0에서 도입되었습니다.
  • %{ISSUE_URL}이 GitLab 16.1에서 도입되었습니다.

요청자가 다음 상황에서 이메일을 받습니다:

  • 요청자가 서비스 데스크로 이메일을 보내어 새 티켓을 제출하는 경우.
  • 서비스 데스크 티켓에 새로운 공개 코멘트가 추가되는 경우.
    • 코멘트를 편집하는 것은 새 이메일을 보내지 않습니다.

이러한 이메일 메시지의 내용을 서비스 데스크 이메일 템플릿으로 사용자화할 수 있습니다. 템플릿에는 GitLab Flavored Markdown일부 HTML 태그를 포함할 수 있습니다. 예를 들어, 이메일을 조직의 브랜드 가이드에 따라 헤더 및 푸터를 포함하도록 서식을 지정할 수 있습니다. 또한 티켓별로 동적 콘텐츠를 표시하기 위해 다음 플레이스홀더를 포함할 수도 있습니다.

플레이스홀더 thank_you.md new_note.md 설명
%{ISSUE_ID} Yes Yes 티켓 IID.
%{ISSUE_PATH} Yes Yes 티켓 IID가 추가된 프로젝트 경로.
%{ISSUE_URL} Yes Yes 티켓의 URL. 외부 참가자는 프로젝트가 공개되고 티켓이 기밀이 아닌 경우에만 티켓을 볼 수 있습니다 (서비스 데스크 티켓은 기본적으로 기밀이다).
%{ISSUE_DESCRIPTION} Yes Yes 티켓 설명. 사용자가 설명을 편집한 경우, 외부 참가자에게 전달되어서는 안 되는 민감한 정보가 포함될 수 있습니다. 이 플레이스홀더를 신중하게 사용하고 이상적으로는 설명을 수정하지 않거나 팀이 템플릿 디자인을 인지하고 있는 경우에만 사용하세요.
%{UNSUBSCRIBE_URL} Yes Yes 구독 취소 URL.
%{NOTE_TEXT} No Yes 사용자가 티켓에 추가한 새 코멘트. new_note.md에서 이를 포함시키도록 주의하세요. 그렇지 않으면 요청자는 서비스 데스크 티켓의 업데이트를 볼 수 없을 수 있습니다.

감사 이메일

요청자가 서비스 데스크를 통해 이슈를 제출하면, GitLab은 감사 이메일을 보냅니다. 추가 구성 없이 GitLab은 기본 감사 이메일을 보냅니다.

사용자 정의 감사 이메일 템플릿을 만들려면:

  1. 리포지토리의 .gitlab/service_desk_templates/ 디렉토리에 thank_you.md라는 파일을 만듭니다.
  2. 해당 Markdown 파일에 GitLab Flavored Markdown, 선택된 HTML 태그, 그리고 Service Desk 요청에 맞게 사용자 정의할 수 있는 플레이스홀더를 채웁니다.

새로운 노트 이메일

서비스 데스크 티켓에 새로운 공개 코멘트가 있는 경우, GitLab은 새로운 노트 이메일을 보냅니다. 추가 구성 없이 GitLab은 코멘트 내용을 보냅니다.

브랜드에 맞는 이메일을 유지하려면 사용자 정의 새로운 노트 이메일 템플릿을 만들 수 있습니다. 다음과 같이 진행하면 됩니다.

  1. 리포지토리의 .gitlab/service_desk_templates/ 디렉토리에 new_note.md라는 파일을 만듭니다.
  2. 해당 Markdown 파일에 GitLab Flavored Markdown, 선택된 HTML 태그, 그리고 새로운 노트 이메일을 사용자 정의하기 위한 플레이스홀더를 채웁니다. 이때 템플릿에 %{NOTE_TEXT}를 포함하여 수신자가 코멘트 내용을 읽을 수 있도록 해야 합니다.

인스턴스 수준의 이메일 헤더, 푸터 및 추가 텍스트

Tier: Free, Premium, Ultimate Offering: Self-managed

인스턴스 관리자는 GitLab 인스턴스에 헤더, 푸터 또는 추가 텍스트를 추가하고 GitLab에서 보내는 모든 이메일에 이를 적용할 수 있습니다. thank_you.md 또는 new_note.md를 사용자 정의하는 경우에는 %{SYSTEM_HEADER}, %{SYSTEM_FOOTER}, 또는 %{ADDITIONAL_TEXT}를 템플릿에 추가하여 해당 내용을 포함해야 합니다.

자세한 내용은 시스템 헤더와 푸터 메시지사용자 정의 추가 텍스트을 참조하세요.

서비스 데스크 티켓에 사용자 정의 템플릿 사용

각 새로운 서비스 데스크 티켓의 설명에 추가할 설명 템플릿프로젝트당 하나 선택할 수 있습니다.

다음의 다양한 수준에서 설명 템플릿을 설정할 수 있습니다.

템플릿은 상속됩니다. 예를 들어 프로젝트에서는 인스턴스 또는 프로젝트의 상위 그룹에 설정된 템플릿에도 액세스할 수 있습니다.

전제 조건:

서비스 데스크에서 사용자 정의 설명 템플릿을 사용하려면:

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
  2. 설정 > 일반을 선택합니다.
  3. 서비스 데스크를 확장합니다.
  4. 모든 서비스 데스크 이슈에 추가되는 템플릿 드롭다운 목록에서 템플릿을 검색 또는 선택합니다.

지원 봇 사용자

백그라운드에서, 서비스 데스크는 특별한 지원 봇 사용자가 이슈를 만들게 됩니다. 이 사용자는 청구 가능한 사용자가 아니기 때문에 라이선스 제한 수에 포함되지 않습니다.

GitLab 16.0 이전에는 서비스 데스크 이메일에서 생성된 코멘트에 GitLab Support Bot이라는 제목이 표시됩니다. GitLab 16.1 이후부터 이러한 코멘트에는 이메일을 보낸 사용자의 이메일이 표시됩니다. 이 기능은 GitLab 16.1 이후에 생성된 코멘트에만 적용됩니다.

지원 봇의 표시 이름 변경

지원 봇 사용자의 표시 이름을 변경할 수 있습니다. 서비스 데스크에서 보내는 이메일에는 이 이름이 From 헤더에 표시됩니다. 기본 표시 이름은 GitLab Support Bot입니다.

사용자 정의 이메일 표시 이름을 편집하려면:

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
  2. 설정 > 일반을 선택합니다.
  3. 서비스 데스크를 확장합니다.
  4. 이메일 표시 이름 아래에 새로운 이름을 입력합니다.
  5. 변경 사항 저장을 선택합니다.

외부 참가자의 댓글로 인해 이슈 다시 열기

외부 참가자가 이메일을 통해 이슈에 새 댓글을 추가하면 GitLab을 구성하여 이슈를 다시 열 수 있습니다. 이는 뿐만 아니라 이슈의 담당자에게 언급하는 내부 코멘트를 추가하고 그들을 위한 할 일 항목을 만듭니다.

실습을 위한, 짧은 쇼케이스 비디오를 참조하세요.

전제 조건:

  • 프로젝트에 적어도 Maintainer 역할이 있어야 합니다.

이 설정을 활성화하려면:

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
  2. 설정 > 일반을 선택합니다.
  3. 서비스 데스크를 확장합니다.
  4. 외부 참가자의 새 노트로 이슈 다시 열기 확인란을 선택합니다.
  5. 변경 사항 저장을 선택합니다.

커스텀 이메일 주소

상태: 베타

고객 지원 통신의 발신자로 표시할 커스텀 이메일 주소를 구성합니다. 고객 지원 요청자들 사이에서 브랜드 신원을 유지하고 신뢰감을 심어줍니다.

개요는 짧은 쇼케이스 비디오를 참조하세요.

이 기능은 베타 상태입니다. 베타 기능은 제품으로 출시되기 전에는 사용할 수 있지만, 크게 변경될 가능성이 낮습니다. 사용자들에게 베타 기능을 시도하고 피드백 이슈를 제공할 것을 권장합니다.

전제 조건

프로젝트 당 하나의 서비스 데스크용 커스텀 이메일 주소를 사용할 수 있으며 해당 인스턴스 전체에서 고유해야 합니다.

사용하려는 커스텀 이메일 주소는 다음 요구 사항을 모두 충족해야 합니다.

  • 이메일 전달을 설정할 수 있어야 합니다.
  • 전달된 이메일은 원래 From 헤더를 보존해야 합니다.
  • 서비스 제공업체는 서브 주소 지원을 해야 합니다. 이메일 주소는 로컬 부분(@ 이전의 모든 것)과 도메인 부분으로 이루어집니다.

    이메일 서브 주소화를 통해 로컬 부분 뒤에 + 기호를 추가하여 이메일 주소의 고유한 변형을 만들 수 있습니다. 이메일 주소가 support@example.com인 경우, support+1@example.com으로 이메일을 보내고 메일함에 나타나는지 확인하십시오.

  • SMTP 자격 증명이 있어야 합니다(이상적으로는 앱 비밀번호를 사용해야 합니다). 사용자 이름과 비밀번호는 256비트 키를 사용한 고급 암호화 표준(AES)을 사용하여 데이터베이스에 저장됩니다.
  • SMTP 호스트는 GitLab 인스턴스의 네트워크(셀프 매니지드의 경우)에서 해결할 수 있어야 합니다. (GitLab SaaS의 경우 공개 인터넷에서)
  • 프로젝트의 유지자 권한 이상이 있어야 합니다.
  • 해당 프로젝트에 서비스 데스크가 구성되어 있어야 합니다.

커스텀 이메일 주소 구성

고유한 이메일 주소로 서비스 데스크 이메일을 보내려면 커스텀 이메일 주소를 구성하고 확인합니다.

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
  2. 설정 > 일반을 선택합니다.
  3. 서비스 데스크를 확장하고 커스텀 이메일 주소 구성 섹션을 찾습니다.
  4. 이 프로젝트의 제시된 서비스 데스크 주소를 확인하고 이메일 제공업체(예: Gmail)에서 커스텀 이메일 주소로부터 서비스 데스크 주소로의 이메일 전달을 설정합니다.
  5. GitLab에서 필드를 완료합니다.
  6. 저장 및 연결 테스트를 선택합니다.

구성이 저장되고 커스텀 이메일 주소 확인이 트리거됩니다.

확인

  1. 구성을 완료한 후에는 모든 프로젝트 소유자와 커스텀 이메일 구성을 저장한 관리자에게 알림 이메일이 전송됩니다.
  2. 제공된 SMTP 자격 증명을 사용하여 커스텀 이메일 주소(서브 주소 포함)로 확인 이메일이 전송됩니다. 이메일에는 확인 토큰이 포함됩니다. 이메일 전달이 올바르게 설정되고 모든 전제 조건이 충족되면, 이메일이 서비스 데스크 주소로 전달되고 GitLab에서 소화됩니다. GitLab은 다음 조건을 확인합니다.
    1. GitLab이 SMTP 자격 증명을 사용하여 이메일을 보낼 수 있는지
    2. 서브 주소가 지원되는지(+verify 서브 주소 포함)
    3. 전달 후 From 헤더가 보존되는지
    4. 확인 토큰이 올바른지
    5. 이메일이 30분 안에 수신되는지

일반적으로 이 프로세스는 몇 분만에 완료됩니다.

언제든지 확인을 취소하거나 실패한 경우 커스텀 이메일 재설정을 선택하십시오. 설정 페이지는 이에 따라 업데이트되어 확인 상태를 반영합니다. SMTP 자격 증명이 삭제되며 구성을 다시 시작할 수 있습니다.

확인이 실패하거나 성공한 경우 모든 프로젝트 소유자 및 확인 프로세스를 트리거한 사용자는 확인 결과를 담은 알림 이메일을 받게 됩니다. 확인이 실패한 경우 이메일에는 이유에 대한 자세한 내용도 포함되어 있습니다.

확인에 성공하면 커스텀 이메일 주소를 사용할 수 있습니다. 이제 커스텀 이메일 주소를 사용하여 서비스 데스크 이메일을 보낼 수 있습니다.

구성 문제 해결

사용자 지정 이메일을 구성하는 동안 다음과 같은 문제가 발생할 수 있습니다.

유효하지 않은 자격 증명

유효하지 않은 자격 증명이 사용되었다는 오류 메시지를 받을 수 있습니다.

이는 SMTP 서버가 인증에 성공하지 않았다고 반환할 때 발생합니다.

다음과 같이 문제를 해결합니다:

  1. SMTP 자격 증명, 특히 사용자 이름과 암호를 확인하십시오.
  2. 때로는 GitLab이 SMTP 서버가 지원하는 인증 방법을 자동으로 선택하지 못할 수 있습니다. 따라서:
    • 사용 가능한 인증 방법 (Plain, Login, CRAM-MD5)을 시도하십시오.
    • swaks 명령줄 도구를 사용하여 SMTP 서버가 지원하는 인증 방법을 확인하십시오:
      1. 다음 명령을 자격 증명과 함께 실행하고 250-AUTH로 시작하는 줄을 찾으십시오:

        swaks --to user@example.com \
              --from support@example.com \
              --auth-user support@example.com \
              --server smtp@example.com:587 \
              -tls-optional \
              --auth-password your-app-password
        
      2. 이제 사용 가능한 인증 방법 중 하나를 사용하여 사용자 정의 이메일 설정 양식에서 선택하십시오.

잘못된 전달 대상

잘못된 전달 대상을 사용했다는 오류 메시지를 받을 수 있습니다.

프로젝트별 서비스 데스크 주소가 표시된 사용자 정의 이메일 구성 양식과 다른 이메일 주소로 인증 이메일이 전달된 경우 발생합니다.

incoming_email에서 생성된 서비스 데스크 주소를 사용해야 합니다. service_desk_email에서 생성된 추가 서비스 데스크 별칭 주소로 전달하는 것은 지원되지 않습니다. 왜냐하면 모든 이메일 답장 기능을 지원하지 않기 때문입니다.

다음과 같이 문제를 해결합니다:

  1. 올바른 이메일 주소를 전달하기 위해 다음을 수행하십시오:
    • 모든 프로젝트 소유자와 인증 프로세스를 트리거한 사용자가 수신하는 인증 결과 이메일에서 주소를 확인하십시오.
    • 사용자 정의 이메일 설정 양식에서 이메일 전달 대상 서비스 데스크 주소를 확인하고 주소를 복사하십시오.
  2. 모든 이메일을 사용자 정의 이메일 주소로 올바른 대상 이메일 주소로 전달하십시오.

사용자 정의 이메일 주소 활성화 또는 비활성화

사용자 정의 이메일 주소가 확인된 후, 관리자는 사용자 정의 이메일 주소를 통해 서비스 데스크 이메일을 전송하는 것을 활성화하거나 비활성화할 수 있습니다.

사용자 정의 이메일 주소를 활성화하려면:

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾으십시오.
  2. 설정 > 일반을 선택하십시오.
  3. 서비스 데스크를 확장하십시오.
  4. 사용자 정의 이메일 활성화 토글을 켭니다. 외부 참가자에 대한 서비스 데스크 이메일은 SMTP 자격 증명을 사용하여 전송됩니다.

사용자 정의 이메일 주소를 비활성화하려면:

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾으십시오.
  2. 설정 > 일반을 선택하십시오.
  3. 서비스 데스크를 확장하십시오.
  4. 사용자 정의 이메일 활성화 토글을 끕니다. 이메일 전달을 설정했기 때문에 사용자 정의 이메일 주소로의 이메일은 계속 처리되어 프로젝트의 서비스 데스크 티켓으로 나타납니다.

    외부 참가자에 대한 서비스 데스크 이메일은 이제 GitLab 인스턴스의 기본 발신 이메일 구성을 사용하여 전송됩니다.

사용자 정의 이메일 구성 변경 또는 제거

사용자 정의 이메일 구성을 변경하려면 이를 재설정하고 제거한 후 다시 사용자 정의 이메일을 구성해야 합니다.

프로세스 중 언제든지 구성을 재설정하려면 사용자 정의 이메일 재설정을 선택하십시오. 자격 증명이 데이터베이스에서 제거됩니다.

사용자 정의 이메일 답장 주소

외부 참가자는 서비스 데스크 티켓에 이메일 답장을 할 수 있습니다. GitLab은 티켓에 해당하는 32자 리플 작성 키를 사용하는 이메일 답장 주소를 사용합니다. 사용자 정의 이메일이 구성되면 GitLab이 해당 이메일에서 답장 주소를 생성합니다.

도메인이 있는 Google Workspace 사용

Google Workspace를 사용하는 경우 자체 도메인용 서비스 데스크에 사용자 정의 이메일 주소를 설정합니다.

전제 조건:

  • Google Workspace 계정이 이미 있어야 합니다.
  • 테넌트용 새 계정을 만들 수 있어야 합니다.

Google Workspace에서 사용자 정의 서비스 데스크 이메일 주소를 구성하려면:

  1. Google Workspace 계정 구성을 선택하십시오.
  2. 이메일 전달 구성을 선택하십시오.
  3. 사용자 정의 이메일 주소 구성을 선택하십시오.

구글 워크스페이스 계정 구성

먼저 Google Workspace 계정을 만들고 구성해야 합니다.

Google Workspace에서:

  1. 사용하려는 사용자 정의 이메일 주소에 대한 새 계정을 만드십시오(예: support@example.com).
  2. 해당 계정으로 로그인하고 이중 인증을 활성화하십시오.
  3. 앱 비밀번호를 생성하여 SMTP 암호로 사용할 수 있도록 하십시오. 안전한 위치에 저장하고 문자 사이의 공백을 제거하십시오.

다음으로, 이메일 전달 구성을 완료해야 합니다.

사용자 정의 이메일 주소 구성

GitLab에서:

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
  2. 설정 > 일반을 선택합니다.
  3. 서비스 데스크를 확장하고 사용자 정의 이메일 설정을 찾습니다.
  4. 다음 필드를 완성합니다:
    • 사용자 정의 이메일 주소: 귀사의 사용자 정의 이메일 주소.
    • SMTP 호스트: smtp.gmail.com.
    • SMTP 포트: 587.
    • SMTP 사용자명: 사용자 지정 이메일 주소로 미리 채워집니다.
    • SMTP 암호: 이전에 사용자 정의 이메일 계정을 위해 생성한 앱 암호.
    • SMTP 인증 방법: GitLab이 서버에서 지원하는 방법을 선택하도록 합니다(권장).
  5. 저장하고 연결 테스트를 선택합니다.
  6. 검증 프로세스 이후 사용자 정의 이메일 주소를 활성화하거나 비활성화할 수 있어야 합니다.

알려진 문제

  • 일부 서비스 제공업체는 더 이상 SMTP 연결을 허용하지 않습니다. 종종 사용자별로 활성화할 수 있으며 앱 암호를 생성할 수 있습니다.
  • Microsoft Exchange는 From 헤더를 보존하지 않으므로 동일한 테넌트의 사용자 정의 이메일을 사용할 수 없습니다. 해결책으로:
    • GitLab SaaS에서는 사용자 정의 이메일 주소에서 Service Desk 이메일로 이메일을 전달하기 위해 전송 규칙을 사용합니다. 현재 테넌트 외부의 이메일 주소로 전달하여 원본 From 헤더를 보존합니다.
    • GitLab self-managed에서는 사용자 정의 이메일 주소 또는 GitLab 인스턴스의 incoming_email 또는 service_desk_email을 위해 다른 서비스 제공업체의 하위 도메인 또는 다른 도메인을 사용합니다.

추가 Service Desk 별칭 이메일 사용

Tier: Free, Premium, Ultimate Offering: Self-managed

인스턴스 수준의 Service Desk에 대해 추가 별칭 이메일 주소를 사용할 수 있습니다.

이를 위해 반드시 인스턴스 구성에 service_desk_email을 구성해야 합니다. 또한 서브 주소 부분의 기본 -issue-을 대체하는 사용자 정의 접미사를 구성할 수도 있습니다.

Service Desk 별칭 이메일 구성

note
GitLab.com에서는 이미 contact-project+%{key}@incoming.gitlab.com를 이메일 주소로 사용하는 사용자 정의 메일박스가 구성되어 있습니다. 프로젝트 설정에서 여전히 사용자 정의 접미사를 구성할 수 있습니다.

Service Desk는 기본적으로 수신 이메일 구성을 사용합니다. 그러나 Service Desk에 대한 별도의 이메일 주소를 갖기 위해 프로젝트 설정에서 사용자 정의 접미사와 함께 service_desk_email을 구성해야 합니다.

전제 조건:

  • 주소@ 전의 +%{key} 자리 표시자를 반드시 포함해야 합니다. 이 자리 표시자는 이슈가 생성될 프로젝트를 식별하는 데 사용됩니다.
  • service_desk_emailincoming_email 구성은 반드시 서로 다른 메일박스를 사용하여 Service Desk 이메일이 올바르게 처리되도록 해야 합니다.

IMAP를 사용하여 Service Desk에 대한 사용자 정의 메일박스를 구성하려면 다음 스니펫을 구성 파일에 추가하세요.

Linux package (Omnibus)
note
GitLab 15.3 이상에서는 Service Desk가 기본적으로 Sidekiq 작업을 대기열에 추가하는 대신 webhook (내부 API 호출)을 사용합니다. GitLab 15.3에서 Linux 패키지 설치에서 webhook을 사용하려면 비밀 파일을 생성해야 합니다. 자세한 내용은 병합 요청 5927을 참조하세요. GitLab 15.4에서는 Linux 패키지 설치를 다시 구성하면 비밀 파일 구성 설정이 자동으로 생성되므로 별도의 비밀 파일 구성 설정이 필요하지 않습니다. 자세한 내용은 이슈 1462을 참조하세요.
gitlab_rails['service_desk_email_enabled'] = true
gitlab_rails['service_desk_email_address'] = "project_contact+%{key}@gmail.com"
gitlab_rails['service_desk_email_email'] = "project_contact@gmail.com"
gitlab_rails['service_desk_email_password'] = "[REDACTED]"
gitlab_rails['service_desk_email_mailbox_name'] = "inbox"
gitlab_rails['service_desk_email_idle_timeout'] = 60
gitlab_rails['service_desk_email_log_file'] = "/var/log/gitlab/mailroom/mail_room_json.log"
gitlab_rails['service_desk_email_host'] = "imap.gmail.com"
gitlab_rails['service_desk_email_port'] = 993
gitlab_rails['service_desk_email_ssl'] = true
gitlab_rails['service_desk_email_start_tls'] = false
Self-compiled (source)
service_desk_email:
  enabled: true
  address: "project_contact+%{key}@example.com"
  user: "project_contact@example.com"
  password: "[REDACTED]"
  host: "imap.gmail.com"
  delivery_method: webhook
  secret_file: .gitlab-mailroom-secret
  port: 993
  ssl: true
  start_tls: false
  log_path: "log/mailroom.log"
  mailbox: "inbox"
  idle_timeout: 60
  expunge_deleted: true

구성 옵션은 수신 이메일을 구성하는 것과 동일합니다.

암호화된 자격 증명 사용

서비스 데스크 이메일 자격 증명을 평문으로 구성 파일에 저장하는 대신, 선택적으로 들어오는 이메일 자격 증명에 대해 암호화된 파일을 사용할 수 있습니다.

필수 조건:

  • 암호화된 자격 증명을 사용하려면 먼저 암호화된 구성을 활성화해야 합니다.

암호화된 파일에 대한 지원되는 구성 항목은 다음과 같습니다:

  • user
  • password
Linux package (Omnibus)
  1. 초기에 /etc/gitlab/gitlab.rb에 있는 서비스 데스크 구성이 다음과 같았다면:

    gitlab_rails['service_desk_email_email'] = "service-desk-email@mail.example.com"
    gitlab_rails['service_desk_email_password'] = "examplepassword"
    
  2. 암호화된 비밀을 편집합니다:

    sudo gitlab-rake gitlab:service_desk_email:secret:edit EDITOR=vim
    
  3. 서비스 데스크 이메일 비밀의 평문 내용을 입력합니다:

    user: 'service-desk-email@mail.example.com'
    password: 'examplepassword'
    
  4. /etc/gitlab/gitlab.rb를 편집하고 service_deskemailpassword 설정을 제거합니다.
  5. 파일을 저장하고 GitLab을 재구성합니다:

    sudo gitlab-ctl reconfigure
    
Helm chart (Kubernetes)

서비스 데스크 이메일 비밀을 저장하기 위해 Kubernetes 시크릿을 사용합니다. 자세한 내용은 Helm IMAP 비밀을 참조하세요.

Docker
  1. 초기에 docker-compose.yml의 서비스 데스크 구성이 다음과 같았다면:

    version: "3.6"
    services:
      gitlab:
        image: 'gitlab/gitlab-ee:latest'
        restart: always
        hostname: 'gitlab.example.com'
        environment:
          GITLAB_OMNIBUS_CONFIG: |
            gitlab_rails['service_desk_email_email'] = "service-desk-email@mail.example.com"
            gitlab_rails['service_desk_email_password'] = "examplepassword"
    
  2. 컨테이너 내부로 들어가 암호화된 비밀을 편집합니다:

    sudo docker exec -t <container_name> bash
    gitlab-rake gitlab:service_desk_email:secret:edit EDITOR=editor
    
  3. 서비스 데스크 비밀의 평문 내용을 입력합니다:

    user: 'service-desk-email@mail.example.com'
    password: 'examplepassword'
    
  4. docker-compose.yml을 편집하고 service_deskemailpassword 설정을 제거합니다.
  5. 파일을 저장하고 GitLab을 다시 시작합니다:

    docker compose up -d
    
Self-compiled (source)
  1. 초기에 /home/git/gitlab/config/gitlab.yml에 있는 서비스 데스크 구성이 다음과 같았다면:

    production:
      service_desk_email:
        user: 'service-desk-email@mail.example.com'
        password: 'examplepassword'
    
  2. 암호화된 비밀을 편집합니다:

    bundle exec rake gitlab:service_desk_email:secret:edit EDITOR=vim RAILS_ENVIRONMENT=production
    
  3. 서비스 데스크 비밀의 평문 내용을 입력합니다:

    user: 'service-desk-email@mail.example.com'
    password: 'examplepassword'
    
  4. /home/git/gitlab/config/gitlab.yml를 편집하고 service_desk_email:userpassword 설정을 제거합니다.
  5. 파일을 저장하고 GitLab과 Mailroom을 다시 시작합니다:

    # systemd를 실행 중인 시스템의 경우
    sudo systemctl restart gitlab.target
    
    # SysV init을 실행 중인 시스템의 경우
    sudo service gitlab restart
    

Microsoft Graph

  • GitLab 14.9에서 대체 Azure 배포가 소개되었습니다.
  • GitLab 15.11에서 self-compiled (source) 설치에 도입되었습니다.

service_desk_email은 IMAP 대신 Microsoft Graph API를 사용하여 Microsoft Exchange Online 메일함을 읽도록 구성할 수 있습니다. Microsoft Graph을 위해 들어오는 이메일과 동일한 방법으로 OAuth 2.0 애플리케이션을 설정하세요.

Linux package (Omnibus)
  1. 다음 값을 대체하여 /etc/gitlab/gitlab.rb를 편집합니다:

    gitlab_rails['service_desk_email_enabled'] = true
    gitlab_rails['service_desk_email_address'] = "project_contact+%{key}@example.onmicrosoft.com"
    gitlab_rails['service_desk_email_email'] = "project_contact@example.onmicrosoft.com"
    gitlab_rails['service_desk_email_mailbox_name'] = "inbox"
    gitlab_rails['service_desk_email_log_file'] = "/var/log/gitlab/mailroom/mail_room_json.log"
    gitlab_rails['service_desk_email_inbox_method'] = 'microsoft_graph'
    gitlab_rails['service_desk_email_inbox_options'] = {
      'tenant_id': '<YOUR-TENANT-ID>',
      'client_id': '<YOUR-CLIENT-ID>',
      'client_secret': '<YOUR-CLIENT-SECRET>',
      'poll_interval': 60  # Optional
    }
    

    미국 정부용 Microsoft Cloud 또는 기타 Azure 배포용으로 azure_ad_endpointgraph_endpoint 설정을 구성합니다. 예를 들어:

    gitlab_rails['service_desk_email_inbox_options'] = {
      'azure_ad_endpoint': 'https://login.microsoftonline.us',
      'graph_endpoint': 'https://graph.microsoft.us',
      'tenant_id': '<YOUR-TENANT-ID>',
      'client_id': 'YOUR-CLIENT-ID',
      'client_secret': '<YOUR-CLIENT-SECRET>',
      'poll_interval': 60  # Optional
    }
    
Helm chart (Kubernetes)
  1. Microsoft Graph 클라이언트 시크릿을 포함하는 Kubernetes 시크릿을 생성합니다:

    kubectl create secret generic service-desk-email-client-secret --from-literal=secret=<YOUR-CLIENT-SECRET>
    
  2. GitLab 서비스 데스크 이메일 인증 토큰을 위한 Kubernetes 시크릿을 생성합니다. <name>은 GitLab 설치의 Helm 릴리스명으로 대체합니다:

    kubectl create secret generic <name>-service-desk-email-auth-token --from-literal=authToken=$(head -c 512 /dev/urandom | LC_CTYPE=C tr -cd 'a-zA-Z0-9' | head -c 32 | base64)
    
  3. Helm 값들을 내보냅니다:

    helm get values gitlab > gitlab_values.yaml
    
  4. gitlab_values.yaml을 편집합니다:

    global:
      appConfig:
      serviceDeskEmail:
        enabled: true
        address: "project_contact+%{key}@example.onmicrosoft.com"
        user: "project_contact@example.onmicrosoft.com"
        mailbox: inbox
        inboxMethod: microsoft_graph
        azureAdEndpoint: https://login.microsoftonline.com
        graphEndpoint: https://graph.microsoft.com
        tenantId: "YOUR-TENANT-ID"
        clientId: "YOUR-CLIENT-ID"
        clientSecret:
          secret: service-desk-email-client-secret
          key: secret
        deliveryMethod: webhook
        authToken:
          secret: <name>-service-desk-email-auth-token
          key: authToken
    

    미국 정부용 Microsoft Cloud 또는 기타 Azure 배포용으로 azureAdEndpointgraphEndpoint 설정을 구성합니다. 이러한 필드는 대소문자를 구분합니다:

    global:
      appConfig:
      serviceDeskEmail:
        [..]
        azureAdEndpoint: https://login.microsoftonline.us
        graphEndpoint: https://graph.microsoft.us
        [..]
    
  5. 파일을 저장하고 새로운 값들을 적용합니다:

    helm upgrade -f gitlab_values.yaml gitlab gitlab/gitlab
    
Docker
  1. docker-compose.yml을 편집합니다:

    version: "3.6"
    services:
      gitlab:
        environment:
          GITLAB_OMNIBUS_CONFIG: |
            gitlab_rails['service_desk_email_enabled'] = true
            gitlab_rails['service_desk_email_address'] = "project_contact+%{key}@example.onmicrosoft.com"
            gitlab_rails['service_desk_email_email'] = "project_contact@example.onmicrosoft.com"
            gitlab_rails['service_desk_email_mailbox_name'] = "inbox"
            gitlab_rails['service_desk_email_log_file'] = "/var/log/gitlab/mailroom/mail_room_json.log"
            gitlab_rails['service_desk_email_inbox_method'] = 'microsoft_graph'
            gitlab_rails['service_desk_email_inbox_options'] = {
              'tenant_id': '<YOUR-TENANT-ID>',
              'client_id': '<YOUR-CLIENT-ID>',
              'client_secret': '<YOUR-CLIENT-SECRET>',
             'poll_interval': 60  # Optional
            }
    
  2. 파일을 저장하고 GitLab을 재시작합니다:

    docker compose up -d
    

미국 정부용 Microsoft Cloud 또는 기타 Azure 배포용으로 azure_ad_endpointgraph_endpoint 설정을 구성합니다:

  1. docker-compose.yml을 편집합니다:

    version: "3.6"
    services:
      gitlab:
        environment:
          GITLAB_OMNIBUS_CONFIG: |
            gitlab_rails['service_desk_email_enabled'] = true
            gitlab_rails['service_desk_email_address'] = "project_contact+%{key}@example.onmicrosoft.com"
            gitlab_rails['service_desk_email_email'] = "project_contact@example.onmicrosoft.com"
            gitlab_rails['service_desk_email_mailbox_name'] = "inbox"
            gitlab_rails['service_desk_email_log_file'] = "/var/log/gitlab/mailroom/mail_room_json.log"
            gitlab_rails['service_desk_email_inbox_method'] = 'microsoft_graph'
            gitlab_rails['service_desk_email_inbox_options'] = {
              'azure_ad_endpoint': 'https://login.microsoftonline.us',
              'graph_endpoint': 'https://graph.microsoft.us',
              'tenant_id': '<YOUR-TENANT-ID>',
              'client_id': '<YOUR-CLIENT-ID>',
              'client_secret': '<YOUR-CLIENT-SECRET>',
              'poll_interval': 60  # Optional
            }
    
  2. 파일을 저장하고 GitLab을 재시작합니다:

    docker compose up -d
    
Self-compiled (source)
  1. /home/git/gitlab/config/gitlab.yml을 편집합니다:

      service_desk_email:
        enabled: true
        address: "project_contact+%{key}@example.onmicrosoft.com"
        user: "project_contact@example.onmicrosoft.com"
        mailbox: "inbox"
        delivery_method: webhook
        log_path: "log/mailroom.log"
        secret_file: .gitlab-mailroom-secret
        inbox_method: "microsoft_graph"
        inbox_options:
          tenant_id: "<YOUR-TENANT-ID>"
          client_id: "<YOUR-CLIENT-ID>"
          client_secret: "<YOUR-CLIENT-SECRET>"
          poll_interval: 60  # Optional
    

미국 정부용 Microsoft Cloud 또는 기타 Azure 배포용으로 azure_ad_endpointgraph_endpoint 설정을 구성합니다. 예를 들어:

     service_desk_email:
       enabled: true
       address: "project_contact+%{key}@example.onmicrosoft.com"
       user: "project_contact@example.onmicrosoft.com"
       mailbox: "inbox"
       delivery_method: webhook
       log_path: "log/mailroom.log"
       secret_file: .gitlab-mailroom-secret
       inbox_method: "microsoft_graph"
       inbox_options:
         azure_ad_endpoint: "https://login.microsoftonline.us"
         graph_endpoint: "https://graph.microsoft.us"
         tenant_id: "<YOUR-TENANT-ID>"
         client_id: "<YOUR-CLIENT-ID>"
         client_secret: "<YOUR-CLIENT-SECRET>"
         poll_interval: 60  # Optional

서비스 데스크 별칭 이메일에 접미사 설정

프로젝트의 서비스 데스크 설정에서 사용자 정의 접미사를 설정할 수 있습니다.

접미사는 소문자(a-z), 숫자(0-9), 또는 밑줄(_)만 포함할 수 있습니다.

구성되면 사용자 정의 접미사는 새로운 서비스 데스크 이메일 주소를 만들어내며, 이는 service_desk_email_address 설정과 <project_full_path>-<custom_suffix> 형식의 키로 구성됩니다.

전제 조건:

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
  2. 설정 > 일반을 선택합니다.
  3. 서비스 데스크를 확장합니다.
  4. 이메일 주소 접미사 아래에 사용할 접미사를 입력합니다.
  5. 변경사항 저장을 선택합니다.

예를 들어, mygroup/myproject 프로젝트의 서비스 데스크 설정이 다음과 같이 구성되어 있는 경우:

  • 이메일 주소 접미사가 support로 설정되어 있습니다.
  • 서비스 데스크 이메일 주소가 contact+%{key}@example.com로 구성되어 있습니다.

이 프로젝트의 서비스 데스크 이메일 주소는 다음과 같습니다: contact+mygroup-myproject-support@example.com. incoming email 주소는 여전히 작동합니다.

사용자 정의 접미사를 구성하지 않으면 프로젝트 식별에 기본값이 사용됩니다.

다중 노드 환경에서 이메일 수신 구성

다중 노드 환경은 확장성, 오류 허용성 및 성능 상의 이유로 GitLab을 여러 서버에서 실행하는 설정입니다.

GitLab은 mail_room이라는 별도의 프로세스를 사용하여 incoming_emailservice_desk_email 메일박스에서 새로운 읽지 않은 이메일을 수신합니다.

Helm 차트 (Kubernetes)

GitLab Helm 차트는 여러 하위 차트로 구성되며, 이 중 하나가 Mailroom 하위 차트입니다. 공통 설정을 구성하십시오incoming_email을 위한 및 [공통 설정을 구성하십시오]service_desk_email을 위한 (https://docs.gitlab.com/charts/installation/command-line-options.html#service-desk-email-configuration).

Linux 패키지 (Omnibus)

다중 노드 Linux 패키지 설치 환경에서는 mail_room을 하나의 노드에서만 실행합니다. rails 노드(예: application_role)나 완전히 별도로 실행할 수 있습니다.

모든 노드 설정

  1. 웹 UI 및 생성된 이메일에서 이메일 주소를 표시하려면 각 노드에서 incoming_emailservice_desk_email에 대한 기본 구성을 추가합니다.

    /etc/gitlab/gitlab.rb에서 incoming_email 또는 service_desk_email 섹션을 찾습니다.

    incoming_email
    gitlab_rails['incoming_email_enabled'] = true
    gitlab_rails['incoming_email_address'] = "incoming+%{key}@example.com"
    
    service_desk_email
    gitlab_rails['service_desk_email_enabled'] = true
    gitlab_rails['service_desk_email_address'] = "project_contact+%{key}@example.com"
    
  2. GitLab은 mail_room에서 GitLab으로 이메일을 전송하는 데 두 가지 방법을 제공합니다. 각 이메일 설정에 대해 delivery_method를 구성할 수 있습니다:
    1. 권장: webhook (GitLab 15.3 이상의 기본값)은 API POST 요청을 통해 이메일 페이로드를 GitLab 애플리케이션에 전송합니다. 공유 토큰을 사용하여 인증합니다. 이 방법을 선택하는 경우 mail_room 프로세스가 API 엔드포인트에 액세스하고 모든 애플리케이션 노드에 대해 공유 토큰을 배포할 수 있도록합니다.

      incoming_email
      gitlab_rails['incoming_email_delivery_method'] = "webhook"
      
      # mail_room이 연락할 수있는 URL입니다. 내부 URL 또는 IP도 사용할 수 있지만, mail_room이 그 주소를 통해 GitLab API에 액세스 할 수 있도록하십시오.
      # "/"로 끝나지 않습니다.
      gitlab_rails['incoming_email_gitlab_url'] = "https://gitlab.example.com"
      
      # 임의 토큰이 포함 된 공유 비밀 파일입니다. 모든 노드에서 동일한지 확인하십시오.
      gitlab_rails['incoming_email_secret_file'] = ".gitlab_mailroom_secret"
      
      service_desk_email
      gitlab_rails['service_desk_email_delivery_method'] = "webhook"
      
      # mail_room이 연락할 수있는 URL입니다. 내부 URL 또는 IP도 사용할 수 있지만, mail_room이 그 주소를 통해 GitLab API에 액세스 할 수 있도록하십시오.
      # "/"로 끝나지 않습니다.
      gitlab_rails['service_desk_email_gitlab_url'] = "https://gitlab.example.com"
      
      # 임의 토큰이 포함 된 공유 비밀 파일입니다. 모든 노드에서 동일한지 확인하십시오.
      gitlab_rails['service_desk_email_secret_file'] = ".gitlab_mailroom_secret"
      
    2. [GitLab 16.0에서 사라지는 것이 예정된 사용 중단되었습니다] (../../../update/deprecations.md#sidekiq-delivery-method-for-incoming_email-and-service_desk_email-is-deprecated): 만약 webhook 설정에 문제가 있다면, sidekiq를 사용하여 Redis를 통해 이메일 페이로드를 직접 GitLab Sidekiq로 전달하십시오.

      incoming_email
      # Redis 구성을 사용하여 Sidekiq 작업을 직접 추가합니다.
      gitlab_rails['incoming_email_delivery_method'] = "sidekiq"
      
      service_desk_email
      # Redis 구성을 사용하여 Sidekiq 작업을 직접 추가합니다.
      gitlab_rails['service_desk_email_delivery_method'] = "sidekiq"
      
  3. 이메일 수신을 실행하면 안 되는 모든 노드에서 mail_room을 비활성화하십시오. 예를 들어, /etc/gitlab/gitlab.rb에서:

    mailroom['enabled'] = false
    
  4. 변경 사항이 적용되려면 GitLab을 다시 구성하십시오.

단일 이메일 수신 노드 설정

모든 노드를 설정한 후에 mail_room 프로세스를 비활성화한 다음, mail_room을 하나의 노드에서 활성화합니다. 이 노드는 주기적으로 incoming_emailservice_desk_email의 메일함을 확인하고 새로운 안읽은 이메일을 GitLab으로 이동시킵니다.

  1. 기존의 이메일 수신을 처리하는 노드를 선택합니다.
  2. incoming_emailservice_desk_email에 대한 전체 구성 및 자격 증명을 추가합니다.
  3. 이 노드에서 mail_room을 활성화합니다. 예를 들어, /etc/gitlab/gitlab.rb에서:

    mailroom['enabled'] = true
    
  4. 변경 사항이 적용되려면 GitLab을 다시 구성하십시오.