커스텀 도메인 설정하기

공개한 문서는 https://{subdomain}.monjiro.io에서 열람할 수 있습니다. 커스텀 도메인을 설정하면 https://docs.example.com처럼 보유한 도메인으로 공개 페이지를 제공할 수 있습니다. HTTPS 인증서는 자동으로 발급·갱신되므로 따로 준비할 필요가 없습니다.

Solo·Team·Enterprise 요금제에서 사용할 수 있습니다

커스텀 도메인을 설정할 수 있는 것은 조직의 Owner(소유자)와 Admin(관리자)입니다. 요금은 요금제를 참고해 주세요. GitHub와 연동한 OSS 문서는 Free 요금제에서도 설정할 수 있습니다(OSS 문서(GitHub 연동)).

사용할 수 있는 도메인

docs.example.com이나 help.example.co.jp처럼 보유한 도메인의 서브도메인을 사용할 수 있습니다.
example.com 같은 루트 도메인(서브도메인이 없는 도메인)은 사용할 수 없습니다. 루트 도메인으로도 공개하려면 www.example.com을 커스텀 도메인으로 설정하고, 루트 도메인은 도메인을 구입한 서비스의 포워딩 기능으로 www.example.com으로 전달해 주세요.
문서 하나에 설정할 수 있는 커스텀 도메인은 1개입니다. 같은 도메인을 다른 문서에서 사용할 수는 없습니다.

설정하기

인증서를 발급하려면 미리 도메인이 Monjiro를 가리키고 있어야 합니다. 화면의 안내에 따라 CNAME 레코드를 추가한 뒤 등록합니다.

문서의 편집 화면을 엽니다.
오른쪽 패널의 "설정" 탭을 열고, "접근"의 "커스텀 도메인" 항목에 있는 "설정"을 클릭합니다.

오른쪽 패널 "설정" 탭의 "접근". "공개 URL"의 "변경", "커스텀 도메인"과 "열람 제한"의 "설정" 버튼이 있습니다.

사용할 도메인(예: docs.example.com)을 입력하고 "다음"을 클릭합니다.

커스텀 도메인 설정 화면의 1단계. 사용할 도메인으로 docs.example.com을 입력한 상태

표시된 CNAME 레코드를 사용 중인 DNS에 추가합니다.

2단계. DNS에 추가할 CNAME 레코드(종류 CNAME, 이름 docs.example.com, 값 xxxx.cloudfront.net)와 "확인하고 등록" 버튼

항목	설정할 값
종류	CNAME
이름(호스트 이름)	사용할 도메인(예: docs.example.com. 서비스에 따라서는 docs 부분만 입력합니다)
값(대상)	화면에 표시되는 값(xxxx.cloudfront.net 형식)

DNS 설정이 반영될 때까지 기다린 뒤(대부분 몇 분에서 수십 분) "확인하고 등록"을 클릭합니다. 아직 반영되지 않았다면 CNAME 레코드가 아직 Monjiro를 가리키지 않는다는 안내가 표시됩니다. 잠시 기다린 뒤 다시 클릭해 주세요.
등록하면 "완료"가 표시되고 인증서 발급이 시작됩니다. 상태가 "유효"가 되기까지 몇 분에서 몇 시간이 걸릴 수 있습니다. 상태는 "설정" 탭의 "커스텀 도메인" 항목에 표시되며, 바뀔 때까지 자동으로 업데이트됩니다.

CNAME 레코드는 도메인을 구입한 서비스(Onamae.com, Muumuu Domain, Amazon Route 53, Cloudflare 등)의 DNS 설정 화면에서 추가합니다.

Cloudflare를 사용하는 경우

CNAME 레코드의 프록시를 비활성화("DNS only")해 주세요. 프록시가 켜져 있으면 DNS가 Monjiro를 가리키는지 확인할 수 없어 등록할 수 없습니다.

상태

확인 중: 인증서 발급을 기다리고 있습니다. CNAME 레코드를 삭제하지 말고 잠시 기다려 주세요.
유효: 커스텀 도메인으로 공개 페이지를 제공하고 있습니다.
실패: 인증서를 발급하지 못했습니다(CNAME 레코드를 도중에 삭제·변경한 경우 등). 화면에 이유가 표시됩니다. 커스텀 도메인을 해제하고 CNAME 레코드를 확인한 뒤 다시 등록해 주세요.

커스텀 도메인이 유효해진 뒤에도 https://{subdomain}.monjiro.io URL로 계속 열람할 수 있습니다.

커스텀 도메인 해제하기

"설정" 탭의 "커스텀 도메인" 항목에 있는 "커스텀 도메인 해제"를 클릭하고, 확인 창에서 "해제하기"를 클릭합니다. 해제하면 즉시 커스텀 도메인으로는 열람할 수 없게 됩니다. 추가한 CNAME 레코드는 해제한 뒤 삭제해도 문제없습니다.

다른 설정과의 관계

열람 제한: 커스텀 도메인으로 열람하는 경우에도 열람 제한(IP 제한·이메일 주소 제한)이 그대로 적용됩니다.
요금제 변경: Solo 이상의 요금제에서 Free로 변경하면 커스텀 도메인으로는 열람할 수 없게 됩니다(https://{subdomain}.monjiro.io에서는 계속 열람할 수 있습니다). 커스텀 도메인 설정은 남아 있으므로 요금제를 되돌리면 다시 사용할 수 있습니다. OSS 문서는 Free 요금제에서도 커스텀 도메인으로 열람할 수 있습니다.

자주 묻는 질문

현재 다른 사이트에서 사용 중인 서브도메인을 그대로 전환할 수 있나요?

네. 다만 CNAME 레코드를 Monjiro로 바꾼 뒤 인증서가 발급될 때까지(몇 분 정도) HTTPS로 열 수 없는 시간이 생깁니다. 이용자가 적은 시간대에 전환하는 것을 권장합니다.

CNAME 레코드가 아직 Monjiro를 가리키지 않는다는 안내가 표시되어 등록할 수 없습니다.

CNAME 레코드의 값이 화면에 표시된 값과 일치하는지 확인해 주세요. DNS 설정이 반영되기까지 시간이 걸릴 수 있습니다(대부분 몇 분에서 수십 분, 드물게 24~48시간). 반영된 뒤 다시 "확인하고 등록"을 클릭해 주세요. 설정 도중에 화면을 닫아도 다시 "설정"에서 같은 도메인을 입력하면 이어서 진행할 수 있습니다.

좀처럼 "유효"가 되지 않습니다.

CNAME 레코드를 삭제하거나 변경하지 않았는지 확인해 주세요. 상태가 "실패"가 되었다면 설정을 한 번 해제하고 5분 정도 기다린 뒤 처음부터 다시 등록해 주세요.