서비스 데스크 용어집
프로젝트의 보안 강화
외부 참여자에게 보내는 이메일 사용자 정의
서비스 데스크 티켓에 대한 사용자 정의 템플릿 사용
지원 봇 사용
- 지원 봇의 표시 이름 변경
외부 참가자가 코멘트를 추가하면 이슈 다시 열기
사용자 정의 이메일 주소
알려진 문제
추가 Service Desk 별칭 이메일 사용
- Service Desk 별칭 이메일 구성
  - Microsoft Graph
- 서비스 데스크 별칭 이메일에 접미어 구성
다중 노드 환경에서 이메일 투입 구성
- Helm 차트 (Kubernetes)
- Linux 패키지 (Omnibus)
  - 모든 노드 설정
  - 단일 이메일 투입 노드 설정

서비스 데스크 구성

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

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

전제 조건:

프로젝트에 대한 적어도 Maintainer 역할이 있어야 합니다.
GitLab Self-Managed의 경우 GitLab 인스턴스에 수신 이메일을 설정해야 합니다.
이메일 서브 주소를 사용해야 하지만, catch-all 메일함을 사용할 수도 있습니다. 이를 위해서는 관리자 액세스가 있어야 합니다.
프로젝트의 이슈 추적기가 활성화되어 있어야 합니다.

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

왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
설정 > 일반을 선택합니다.
서비스 데스크를 확장합니다.
서비스 데스크 활성화 토글을 켭니다.
선택 사항. 필드를 작성합니다.
- 서비스 데스크 이메일 주소에 접미사 추가.
- 아래 모든 서비스 데스크 이슈에 추가할 템플릿 디렉터리이 비어 있는 경우, 리포지터리에 설명 템플릿을 생성합니다.
변경 사항 저장을 선택합니다.

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

서비스 데스크 용어집

이 용어집은 서비스 데스크와 관련된 용어에 대한 정의를 제공합니다.

용어	정의
외부 참여자	GitLab 계정이 없는 사용자로, 이메일을 통해서만 이슈나 서비스 데스크 티켓과 상호 작용할 수 있습니다.
요청자	서비스 데스크 티켓을 생성하거나 `/convert_to_ticket` 빠른 조치를 사용하여 요청자로 추가된 외부 참여자입니다.

프로젝트의 보안 강화

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

이메일 시스템에서 서비스 데스크 이메일 주소를 별칭 뒤에 두어 나중에 변경할 수 있도록 합니다.
GitLab 인스턴스에 Akismet를 활성화하여 이 서비스에 스팸 확인을 추가합니다.
차단되지 않은 이메일 스팸은 많은 스팸 이슈가 생성되는 결과를 초래할 수 있습니다.

외부 참여자에게 보내는 이메일 사용자 정의

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 태그를 포함할 수 있습니다.
예를 들어, 이메일을 조직의 브랜드 지침에 따라 헤더와 푸터가 포함되도록 서식을 지정할 수 있습니다. 또한 다음과 같은 자리 표시자를 포함하여 서비스 데스크 티켓이나 GitLab 인스턴스와 관련된 동적 콘텐츠를 표시할 수 있습니다.

자리 표시자	`thank_you.md` 및 `new_participant`	`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은 기본 감사 이메일을 보냅니다.

사용자 지정 감사 이메일 템플릿을 생성하려면:

리포지터리의 .gitlab/service_desk_templates/ 디렉터리에서 thank_you.md라는 파일을 생성합니다.
Markdown 파일에 텍스트, GitLab Flavored Markdown,
일부 선택된 HTML 태그 및 답장을 사용자 정의할 자리 표시자를 작성합니다.

새 참여자 이메일

new_participant 이메일은 GitLab 17.0에 도입되었습니다.

외부 참여자가 티켓에 추가되면 GitLab은 새로운 참여자 이메일을 보내어 대화에 참여한 사실을 알립니다.
추가 구성 없이 GitLab은 기본 새 참여자 이메일을 보냅니다.

사용자 지정 새 참여자 이메일 템플릿을 생성하려면:

리포지터리의 .gitlab/service_desk_templates/ 디렉터리에서 new_participant.md라는 파일을 생성합니다.
Markdown 파일에 텍스트, GitLab Flavored Markdown,
일부 선택된 HTML 태그 및 답장을 사용자 정의할 자리 표시자를 작성합니다.

새 노트 이메일

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

사용자의 브랜드에 맞추기 위해 사용자 지정 새 노트 이메일 템플릿을 생성할 수 있습니다.

리포지터리의 .gitlab/service_desk_templates/ 디렉터리에 new_note.md라는 파일을 생성합니다.
Markdown 파일에 텍스트, GitLab Flavored Markdown,
일부 선택된 HTML 태그 및 새 노트 이메일을 사용자 정의할 자리 표시자를 포함합니다.
이메일 수신자가 댓글 내용을 읽을 수 있도록 템플릿에 %{NOTE_TEXT}를 반드시 포함하도록 주의하십시오.

이메일 헤더, 푸터 및 추가 텍스트에 대한 인스턴스별 설정

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

GitLab 15.9에서 소개됐습니다.

인스턴스 관리자는 GitLab 인스턴스에 헤더, 푸터 또는 추가 텍스트를 추가하고 GitLab에서 발송된 모든 이메일에 이를 적용할 수 있습니다. 사용자 지정 thank_you.md, new_participant 또는 new_note.md를 사용하는 경우, 이 내용을 포함하려면 템플릿에 %{SYSTEM_HEADER}, %{SYSTEM_FOOTER}, 또는 %{ADDITIONAL_TEXT}를 추가하세요.

더 많은 정보를 보려면 시스템 헤더 및 푸터 메시지 및 사용자 지정 추가 텍스트를 참조하세요.

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

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

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

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

전제 조건:

설명 템플릿을 만들어야 합니다.

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

왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
설정 > 일반을 선택합니다.
서비스 데스크를 확장합니다.
모든 서비스 데스크 이슈에 추가할 템플릿 드롭다운 디렉터리에서 템플릿을 검색하거나 선택합니다.

지원 봇 사용

서비스 데스크는 특별한 지원 봇 사용으로 작동합니다. 이 사용자는 과금되는 사용자가 아니기 때문에 라이선스 제한 수에 포함되지 않습니다.

GitLab 16.0과 이전에는 서비스 데스크 이메일에서 생성된 코멘트에서 GitLab 지원 봇을 표시합니다. GitLab 16.1 이후에는 코멘트에서 이메일을 보낸 사용자의 이메일이 표시됩니다. 이 기능은 GitLab 16.1 이후에 작성된 코멘트에만 적용됩니다.

지원 봇의 표시 이름 변경

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

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

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

외부 참가자가 코멘트를 추가하면 이슈 다시 열기

GitLab 16.7에서 소개됐습니다.

GitLab을 구성하여 외부 참가자가 이메일로 이슈에 새 코멘트를 추가할 때 닫힌 이슈를 다시 열도록 할 수 있습니다. 이로써 이 문제의 담당자를 언급하는 내부 코멘트가 추가되고 이들을 위한 할 일이 생성됩니다.

실제 시연을 보려면 짧은 쇼케이스 비디오를 참조하세요.

전제 조건:

프로젝트에 적어도 유지자 역할이 있어야 합니다.

이 설정을 사용하려면:

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

사용자 정의 이메일 주소

Status: Beta

GitLab 16.3에서 service_desk_custom_email라는 플래그와 함께 소개됐습니다. 기본으로 비활성화됐습니다.
GitLab 16.4에서 GitLab.com 및 Self-Managed에서 활성화됐습니다.
SMTP 인증 방법을 선택하는 기능이 GitLab 16.6에서 소개됐습니다.
service_desk_custom_email 플래그가 제거됐습니다. (https://gitlab.com/gitlab-org/gitlab/-/issues/387003) GitLab 16.7에서 제거됐습니다.
GitLab Self-Managed에서 SMTP 호스트에 대한 지역 네트워크 허용이 GitLab 16.7에서 소개됐습니다.

고객 지원 통신의 발신자로 표시될 사용자 정의 이메일 주소를 구성하세요. 브랜드 식별을 유지하고 지원 요청자들에게 신뢰감을 심어줍니다.

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

이 기능은 Beta 상태입니다. 베타 기능은 본격적인 사용에는 적합하지 않지만 출시 전에 크게 변경될 가능성은 적습니다. 사용자들은 베타 기능을 사용해보고 피드백 이슈에 의견을 제공하는 것을 권장합니다.

전제 조건

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

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

이메일 포워딩을 설정할 수 있어야 합니다.
전달된 이메일은 원래의 From 헤더를 보존해야 합니다.
서비스 제공업체가 서브 주소를 지원해야 합니다. 이메일 주소는 로컬 파트(@ 이전의 모든 내용)와 도메인 파트로 구성됩니다. 이메일 서브 주소를 사용하면 로컬 파트 뒤에 + 기호를 추가하여 해당 이메일 주소의 고유한 변형을 만들 수 있습니다. 예를 들어, support@example.com 주소로 이메일을 보내지만 support+1@example.com 주소로 확인해보세요.
SMTP 자격 증명이 필요합니다(이상적으로 앱 패스워드를 사용해야 합니다). 사용자 이름과 비밀번호는 256비트 키를 사용하는 Advanced Encryption Standard(AES)로 데이터베이스에 저장됩니다.
SMTP 호스트는 GitLab Self-Managed의 네트워크(또는 GitLab SaaS의 공개 인터넷)에서 해결할 수 있어야 합니다.
프로젝트에 적어도 유지자 역할이 있어야 합니다.
프로젝트에 서비스 데스크를 구성해야 합니다.

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

서비스 데스크 이메일을 사용자의 이메일 주소를 사용하여 보내려면 이 작업을 수행하고 검증하세요.

왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
설정 > 일반을 선택합니다.
서비스 데스크를 확장하고 사용자 정의 이메일 주소 구성 섹션을 찾아냅니다.
이 프로젝트의 제시된 서비스 데스크 주소를 확인하고, Gmail과 같은 이메일 제공업체에서 사용자 정의 이메일 주소에서 서비스 데스크 주소로 이메일을 전달 설정하세요.
GitLab에서 필드를 완료하세요.
저장 및 연결 테스트를 선택합니다.

구성이 저장되었고 사용자 정의 이메일 주소의 검증이 트리거됐습니다.

검증

설정을 완료한 후 모든 프로젝트 소유자 및 사용자가 사용자 지정 이메일 구성을 저장한 관리자는 알림 이메일을받습니다.
사용자 정의 이메일 주소(하위 주소가 포함된)로 제공된 SMTP 자격 증명을 사용하여 확인 이메일이 전송됩니다. 이 이메일에는 확인 토큰이 포함되어 있습니다. 이메일 전달이 올바르게 설정되고 모든 사전 조건이 충족되면, 이메일은 서비스 데스크 주소로 전달되어 GitLab에서 수집됩니다. GitLab은 다음 조건을 확인합니다:
1. GitLab이 SMTP 자격 증명을 사용하여 이메일을 보낼 수 있습니다.
2. 하위 주소가 지원됩니다(+verify 하위 주소가 포함된).
3. 전달 후 From 헤더가 보존됩니다.
4. 확인 토큰이 올바릅니다.
5. 이메일을 30분 안에 수신합니다.
일반적으로 이 과정은 몇 분만 소요됩니다.
언제든지 확인을 취소하거나 실패하면 사용자 정의 이메일 재설정을 선택하세요. 설정 페이지는 업데이트되어 확인의 현재 상태를 반영합니다. SMTP 자격 증명이 삭제되고 구성을 다시 시작할 수 있습니다.
실패와 성공시 모든 프로젝트 소유자 및 확인 프로세스를 트리거한 사용자가 확인 결과를 포함한 알림 이메일을받습니다. 확인이 실패하면 이메일에 이유의 세부 정보도 포함됩니다.
확인이 성공하면 사용자 정의 이메일 주소를 사용할 준비가되었습니다. 이제 사용자 정의 이메일 주소를 통해 서비스 데스크 이메일을 보낼 수 있습니다.

구성 문제 해결

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

잘못된 자격 증명

잘못된 자격 증명이 사용되었다는 오류가 발생할 수 있습니다.

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

이를 해결하려면:

SMTP 자격 증명, 특히 사용자 이름과 암호를 확인하십시오.
때로는 GitLab이 SMTP 서버가 지원하는 인증 방법을 자동으로 선택하지 못할 수 있습니다. 다음 중 하나를 수행하십시오:
- 사용 가능한 인증 방법(Plain, Login, CRAM-MD5)을 시도합니다.
- SMTP 서버가 지원하는 인증 방법을 확인하려면 swaks 명령 줄 도구를 사용하십시오:
  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. 사용자 지정 이메일 설정 양식에서 지원되는 인증 방법을 선택합니다.

잘못된 전달 대상

잘못된 전달 대상이 사용되었다는 오류가 발생할 수 있습니다.

이는 확인 이메일이 사용자 정의 이메일 구성 양식에 표시된 프로젝트별 서비스 데스크 주소와 다른 이메일 주소로 전달되었을 때 발생합니다.

해결하려면:

올바른 이메일 주소를 전달하는 방법을 찾으십시오:
- 확인 결과 이메일에서 모든 프로젝트 소유자 및 확인 프로세스를 트리거한 사용자에게 표시된 서비스 데스크 주소를 확인합니다.
- 사용자 정의 이메일 주소를 설정하는 양식에서 전달할 서비스 데스크 이메일 주소를 복사합니다.
모든 이메일을 올바른 대상 이메일 주소로 전달합니다.

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

사용자 정의 이메일 주소가 확인된 후 관리자는 사용자 정의 이메일 주소를 통해 서비스 데스크 이메일을 보내거나 보내지 않도록 설정할 수 있습니다.

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

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

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

왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
설정 > 일반을 선택합니다.
서비스 데스크를 확장합니다.
사용자 정의 이메일 활성화 토글을 끕니다. 이메일 전달을 설정했기 때문에 사용자 정의 이메일 주소로의 이메일은 계속 처리되어 프로젝트의 서비스 데스크 티켓으로 표시됩니다.
외부 참가자에게 보내는 서비스 데스크 이메일은 이제 GitLab 인스턴스의 기본 발신 이메일 구성을 사용하여 전송됩니다.

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

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

프로세스의 모든 단계에서 구성을 재설정하려면 사용자 정의 이메일 재설정을 선택합니다. 그럼 인증서가 데이터베이스에서 제거됩니다.

사용자 지정 이메일 회신 주소

외부 참가자는 서비스 데스크 티켓에 이메일로 회신할 수 있습니다. GitLab은 티켓에 해당하는 32자 회신 키가 포함된 이메일 회신 주소를 사용합니다. 사용자 정의 이메일이 구성되면 GitLab은 해당 이메일에서 회신 주소를 생성합니다.

도메인을 사용하여 Google Workspace 사용

Google Workspace를 사용할 때 서비스 데스크에 대한 사용자 지정 이메일 주소를 설정합니다.

전제 조건:

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

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

Google Workspace 계정을 구성합니다.
이메일 전달 구성합니다.
사용자 정의 이메일 주소 구성합니다.

Google Workspace 계정 구성

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

Google Workspace에서:

사용하려는 사용자 정의 이메일 주소(예: support@example.com)에 대한 새 계정을 만듭니다.
해당 계정으로 로그인하여 두 단계 인증을 활성화합니다.
앱 비밀번호를 생성하여 SMTP 암호로 사용할 수 있습니다. 안전한 곳에 보관하고 문자 간에 공백을 제거하십시오.

다음으로 이메일 전달을 구성합니다.

알려진 문제

일부 서비스 제공업체에서는 더 이상 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 별칭 이메일 구성

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

Service Desk는 기본적으로 들어오는 이메일 구성을 사용합니다. 그러나 Service Desk에 대한 별도의 이메일 주소가 필요한 경우 프로젝트 설정에서 사용자 정의 접미사와 함께 service_desk_email을 구성하세요.

필수 컴포넌트:

address는 주소의 user 부분에 +%{key} 플레이스홀더를 반드시 포함해야 합니다. 이 플레이스홀더는 이슈를 생성해야 하는 프로젝트를 식별하는 데 사용됩니다.
service_desk_email 및 incoming_email 구성은 항상 서로 다른 메일함을 사용하여 Service Desk 이메일이 올바르게 처리되도록 해야 합니다.

IMAP를 사용하여 Service Desk를 위한 사용자 정의 메일함을 구성하려면 아래 스니펫을 구성 파일에 추가하세요:

Linux package (Omnibus)

GitLab 15.3 이상에서 Service Desk는 기본적으로 Sidekiq 작업을 대기시키는 대신 webhook (내부 API 호출)을 사용합니다. GitLab 15.3에서 webhook을 사용하려면 비밀 파일을 생성해야 합니다. 자세한 내용은 Merge Request 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

암호화된 자격 증명 사용

소개됨 in GitLab 15.9.

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

사전 요구 사항:

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

암호화된 파일에 대한 지원되는 구성 항목:

user
password

Linux package (Omnibus)

기존에 /etc/gitlab/gitlab.rb의 서비스 데스크 구성이 다음과 같았다면:

gitlab_rails['service_desk_email_email'] = "service-desk-email@mail.example.com"
gitlab_rails['service_desk_email_password'] = "examplepassword"

암호화된 비밀을 편집하세요:

sudo gitlab-rake gitlab:service_desk_email:secret:edit EDITOR=vim

서비스 데스크 이메일 비밀의 평문 내용을 입력하세요:

user: 'service-desk-email@mail.example.com'
password: 'examplepassword'

/etc/gitlab/gitlab.rb를 편집하고 service_desk 설정에서 email 및 password를 제거하세요.
파일을 저장하고 GitLab을 다시 구성하세요:
```
sudo gitlab-ctl reconfigure
```

Helm chart (Kubernetes)

Service Desk 이메일 비밀을 저장하기 위해 Kubernetes 시크릿을 사용하세요. 자세한 내용은 Helm IMAP secrets를 참조하세요.

Docker

초기에 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"

컨테이너 내부로 이동하여 암호화된 비밀을 편집하세요:

sudo docker exec -t <container_name> bash
gitlab-rake gitlab:service_desk_email:secret:edit EDITOR=editor

서비스 데스크 비밀의 평문 내용을 입력하세요:

user: 'service-desk-email@mail.example.com'
password: 'examplepassword'

docker-compose.yml에서 service_desk 설정에서 email 및 password를 제거하세요.
파일을 저장하고 GitLab을 다시 시작하세요:
```
docker compose up -d
```

Self-compiled (source)

초기에 /home/git/gitlab/config/gitlab.yml에서 서비스 데스크 구성이 이와 유사하다면:

production:
  service_desk_email:
    user: 'service-desk-email@mail.example.com'
    password: 'examplepassword'

암호화된 비밀을 편집하세요:

bundle exec rake gitlab:service_desk_email:secret:edit EDITOR=vim RAILS_ENVIRONMENT=production

서비스 데스크에 대한 비밀의 평문 내용을 입력하세요:

user: 'service-desk-email@mail.example.com'
password: 'examplepassword'

파일을 저장하고 GitLab 및 Mailroom을 다시 시작하세요

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

Microsoft Graph

self-compiled (source) installs으로 소개된 이후로 GitLab 15.11에서 소개되었습니다.

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

Linux package (Omnibus)

/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 for US Government나 다른 Azure 배포를 위해 azure_ad_endpoint와 graph_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)

서비스 데스크 이메일 클라이언트 비밀번호를 포함하는 쿠버네티스 비밀를 생성하세요:
```
kubectl create secret generic service-desk-email-client-secret --from-literal=secret=<YOUR-CLIENT_SECRET>
```

GitLab 서비스 데스크 이메일 인증 토큰용 쿠버네티스 비밀을 생성하세요. GitLab 설치의 헬름 릴리스명으로 <name>을 대체하세요:

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)

Helm 값 내보내기:

helm get values gitlab > gitlab_values.yaml

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 for US Government나 다른 Azure 배포를 위해 azureAdEndpoint와 graphEndpoint 설정을 구성하세요. 이러한 필드는 대소문자를 구분합니다:

global:
  appConfig:
  serviceDeskEmail:
    [..]
    azureAdEndpoint: https://login.microsoftonline.us
    graphEndpoint: https://graph.microsoft.us
    [..]

파일을 저장하고 새 값 적용:

helm upgrade -f gitlab_values.yaml gitlab gitlab/gitlab

Docker

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
        }

파일을 저장하고 GitLab 재시작:
```
docker compose up -d
```

Microsoft Cloud for US Government나 다른 Azure 배포를 위해 azure_ad_endpoint와 graph_endpoint 설정을 구성하세요:

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
        }

파일을 저장하고 GitLab 재시작:
```
docker compose up -d
```

Self-compiled (source)

/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 for US Government나 다른 Azure 배포를 위해 azure_ad_endpoint와 graph_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), 또는 밑줄(_)만 포함할 수 있습니다.

구성하면, 사용자 정의 접미어는 새로운 서비스 데스크 이메일 주소를 생성하며, 다음 형식의 키인 <프로젝트_전체_경로>-<사용자_정의_접미어>로 구성됩니다.

필수 구성 사항:

서비스 데스크 별칭 이메일을 구성해야 합니다.

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

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

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

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

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

다중 노드 환경에서 이메일 투입 구성

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

GitLab은 mail_room이라는 별도의 프로세스를 사용하여 incoming_email 및 service_desk_email 메일함에서 새로운 읽지 않은 이메일을 투입합니다.

Helm 차트 (Kubernetes)

GitLab Helm 차트는 여러 하위 차트로 구성되며, 그 중 하나가 Mailroom 하위 차트입니다. common settings for incoming_email 및 common settings for service_desk_email를 구성합니다.

Linux 패키지 (Omnibus)

다중 노드 Linux 패키지 설치 환경에서는 mail_room을 하나의 노드에서만 실행합니다. 예를 들어, 단일 rails 노드(예: application_role) 또는 완전히 별도의 노드에서 실행합니다.

모든 노드 설정

생성된 이메일 주소를 웹 UI 및 생성된 이메일에서 렌더링하기 위해 incoming_email 또는 service_desk_email 섹션을 /etc/gitlab/gitlab.rb에서 모든 노드에 추가합니다:

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"

GitLab은 mail_room에서 GitLab 응용 프로그램으로 이메일 페이로드를 전송하는 데 사용하는 이메일 설정별로 delivery_method를 구성합니다:

권장: 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"

GitLab 16.0에서 폐기 예정 및 17.0에서 제거 예정): 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"

이메일 투입을 실행하면 안 되는 모든 노드에서 mail_room을 비활성화합니다. 예를 들어, /etc/gitlab/gitlab.rb에서:
```
mailroom['enabled'] = false
```
변경 사항이 적용되려면 GitLab을 다시 구성합니다.

단일 이메일 투입 노드 설정

모든 노드를 설정하고 mail_room 프로세스를 비활성화한 후, 단일 노드에서 mail_room을 활성화합니다. 이 노드는 incoming_email 및 service_desk_email의 메일함을 주기적으로 폴링하고 새로운 읽지 않은 이메일을 GitLab로 이동합니다.

이메일을 추가로 처리하는 기존 노드를 선택합니다.
incoming_email과 service_desk_email에 대한 전체 구성 및 자격 증명을 추가합니다.
이 노드에서 mail_room을 활성화합니다. 예를 들어, /etc/gitlab/gitlab.rb에서:
```
mailroom['enabled'] = true
```
변경 사항이 적용되려면 이 노드에서 GitLab을 다시 구성합니다.

서비스 데스크 구성

서비스 데스크 용어집

프로젝트의 보안 강화

외부 참여자에게 보내는 이메일 사용자 정의

감사 이메일

새 참여자 이메일

새 노트 이메일

이메일 헤더, 푸터 및 추가 텍스트에 대한 인스턴스별 설정

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

지원 봇 사용

지원 봇의 표시 이름 변경

외부 참가자가 코멘트를 추가하면 이슈 다시 열기

사용자 정의 이메일 주소

전제 조건

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

검증

구성 문제 해결

잘못된 자격 증명

잘못된 전달 대상

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

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

사용자 지정 이메일 회신 주소

도메인을 사용하여 Google Workspace 사용

Google Workspace 계정 구성

알려진 문제

추가 Service Desk 별칭 이메일 사용

Service Desk 별칭 이메일 구성

Microsoft Graph

서비스 데스크 별칭 이메일에 접미어 구성

다중 노드 환경에서 이메일 투입 구성

Helm 차트 (Kubernetes)

Linux 패키지 (Omnibus)

모든 노드 설정

단일 이메일 투입 노드 설정

도움말

기능 사용 가능성과 제품 평가판

도움받기