GitLab 제품 문서 호스팅

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

만일 docs.gitlab.com에 접근할 수 없는 경우, 문서를 직접 호스팅할 수 있습니다.

note
인스턴스의 로컬 도움말에는 모든 문서(예: GitLab Runner 또는 GitLab Operator의 문서)가 포함되지 않으며, 검색이나 탐색이 불가능합니다. Self-Managed GitLab 인스턴스 내에서 특정 페이지로의 직접 링크만 지원합니다.

문서 자체 호스팅 옵션

GitLab 제품 문서를 호스팅하기 위해 다음을 사용할 수 있습니다:

  • 도커 컨테이너
  • GitLab Pages
  • 사용자 고유의 웹 서버

다음 예제는 GitLab 16.0을 사용하지만, 귀하의 GitLab 인스턴스와 일치하는 버전을 사용하세요.

도커를 사용하여 제품 문서 자체 호스팅

문서 웹사이트는 컨테이너 내부의 포트 4000에서 제공됩니다. 다음 예제에서는 호스트에서 동일한 포트로 노출합니다.

다음 중 하나를 반드시 수행하세요:

  • 방화벽에서 포트 4000을 허용하세요.
  • 다른 포트를 사용하세요. 다음 예제에서 4000을 다른 포트 번호로 변경하세요.

Docker 컨테이너에서 GitLab 제품 문서 웹사이트를 실행하려면:

  1. GitLab을 호스팅하는 서버 또는 GitLab 인스턴스와 통신할 수 있는 다른 서버에서:

    • 일반 Docker를 사용하는 경우, 다음 명령을 실행하세요: 

      docker run --detach --name gitlab_docs -it --rm -p 4000:4000 registry.gitlab.com/gitlab-org/gitlab-docs/archives:16.0

    • Docker compose를 사용하여 GitLab을 호스팅하는 경우, 기존 docker-compose.yaml에 다음을 추가하세요: 

      version: '3.6'
services:
  gitlab_docs:
    image: registry.gitlab.com/gitlab-org/gitlab-docs/archives:16.0
    hostname: 'https://docs.gitlab.example.com:4000'
    ports:
      - '4000:4000'

      그런 다음 변경 사항을 가져오세요: 

      docker-compose up -d
  2. http://0.0.0.0:4000으로 이동하여 문서 웹사이트를 확인하세요.
  3. 도움말 링크를 새 문서 사이트로 리디렉션하세요.

GitLab Pages를 사용하여 제품 문서 자체 호스팅

GitLab Pages를 사용하여 GitLab 제품 문서를 호스팅할 수 있습니다.

전제 조건:

  • 페이지 사이트 URL이 서브폴더를 사용하지 않도록 확인하세요. 사전에 컴파일된 방식으로 CSS 및 JavaScript 파일이 메인 도메인 또는 서브도메인을 기준으로 상대적입니다. 예를 들어, https://example.com/docs/와 같은 URL은 지원되지 않습니다.

GitLab Pages로 제품 문서 사이트를 호스팅하려면:

  1. 빈 프로젝트를 생성하세요.

  2. 새 .gitlab-ci.yml 파일을 만들거나 기존 파일을 편집하고 다음 pages 작업을 추가하세요. 버전이 GitLab 설치와 동일한지 확인하세요: 

    image: registry.gitlab.com/gitlab-org/gitlab-docs/archives:16.0
pages:
  script:
    - mkdir public
    - cp -a /usr/share/nginx/html/* public/
  artifacts:
    paths:
    - public

  3. 선택 사항. GitLab Pages 도메인 이름을 설정하세요. GitLab Pages 웹사이트 유형에 따라 두 가지 옵션이 있습니다:

    웹사이트 유형 기본 도메인 사용자 정의 도메인
    프로젝트 웹사이트 지원되지 않음 지원됨
    사용자 또는 그룹 웹사이트 지원됨 지원됨
  4. 도움말 링크를 새 문서 사이트로 리디렉션하세요.

자체 웹 서버에 제품 문서 자체 호스팅

note
생성하는 웹사이트는 설치된 GitLab 버전과 일치하는 하위 디렉토리에 호스팅되어야 합니다(예: 16.0/). Docker 이미지는 기본적으로 이 버전을 사용합니다.

제품 문서 사이트가 정적인 경우, 컨테이너 내의 /usr/share/nginx/html 내용을 가져와서 원하는 위치에 호스팅할 수 있습니다.

html 디렉토리는 다음 구조를 가지며 다음과 같이 제공됩니다: 

├── 16.0/
├── index.html

이 예에서:

  • 16.0/은 문서가 호스팅되는 디렉토리입니다.
  • index.html은 문서를 포함하는 디렉토리로 리디렉션하는 간단한 HTML 파일입니다. 여기에서는 16.0/입니다.

문서 사이트의 HTML 파일을 추출하려면:

  1. 문서 웹사이트의 HTML 파일을 보유하는 컨테이너를 생성하세요: 

    docker create -it --name gitlab_docs registry.gitlab.com/gitlab-org/gitlab-docs/archives:16.0

  2. 웹사이트를 /srv/gitlab/ 아래로 복사하세요: 

    docker cp gitlab-docs:/usr/share/nginx/html /srv/gitlab/

    이제 /srv/gitlab/html/ 디렉토리에 문서 웹사이트가 포함됩니다.

  3. 컨테이너를 제거하세요: 

    docker rm -f gitlab_docs
  4. 웹 서버를 포인트하여 /srv/gitlab/html/의 내용을 제공하세요.
  5. 도움말 링크를 새 문서 사이트로 리디렉션하세요.

/help 링크를 새 문서 사이트로 리디렉션

로컬 제품 문서 사이트가 실행된 후에는 GitLab 응용 프로그램에서 도움말 링크를 로컬 사이트로 리디렉션하여 완전히 정규화된 도메인 이름을 문서 URL로 사용하세요. 예를 들어 Docker 방법을 사용한 경우, http://0.0.0.0:4000을 입력하세요.

버전을 추가하실 필요는 없습니다. GitLab이 필요에 따라 버전을 감지하고 문서 URL 요청에 추가합니다. 예를 들어, GitLab 버전이 16.0인 경우:

  • GitLab 문서 URL은 http://0.0.0.0:4000/16.0/가 됩니다.
  • GitLab의 링크는 <인스턴스_url>/help/administration/settings/help_page#destination-requirements로 표시됩니다.
  • 해당 링크를 선택하면 http://0.0.0.0:4000/16.0/ee/administration/settings/help_page/#destination-requirements로 리디렉션됩니다.

설정을 테스트하려면 GitLab에서 더 알아보기 링크를 선택하세요. 예를 들어:

  1. 왼쪽 사이드바에서 아바타를 선택하세요.
  2. 환경 설정을 선택하세요.
  3. 구문 강조 테마 섹션에서 더 알아보기를 선택하세요.

제품 문서를 나중 버전으로 업그레이드

나중 버전으로 문서 사이트를 업그레이드하려면 더 최신의 Docker 이미지 태그를 다운로드해야 합니다.

도커를 사용하여 업그레이드

나중 버전으로 업그레이드하려면 도커를 사용하세요:

  • 도커를 사용하는 경우:

    1. 실행 중인 컨테이너를 중지합니다: 

      sudo docker stop gitlab_docs

    2. 기존 컨테이너를 제거합니다: 

      sudo docker rm gitlab_docs

    3. 새 이미지를 가져옵니다. 예: 16.0: 

      docker run --detach --name gitlab_docs -it --rm -p 4000:4000 registry.gitlab.com/gitlab-org/gitlab-docs/archives:16.0

  • Docker Compose를 사용하는 경우:

    1. docker-compose.yaml 파일에서 버전을 변경합니다. 예: 16.0: 

      version: '3.6'
services:
  gitlab_docs:
    image: registry.gitlab.com/gitlab-org/gitlab-docs/archives:16.0
    hostname: 'https://docs.gitlab.example.com:4000'
    ports:
      - '4000:4000'

    2. 변경 사항을 가져옵니다: 

      docker-compose up -d

GitLab Pages를 사용하여 업그레이드

나중 버전으로 업그레이드하려면 GitLab Pages를 사용하세요:

  1. 기존의 .gitlab-ci.yml 파일을 편집하고 image 버전 번호를 변경합니다: 

    image: registry.gitlab.com/gitlab-org/gitlab-docs/archives:16.0

  2. 변경 사항을 커밋하고 푸시하면 GitLab Pages가 새 문서 사이트 버전을 가져옵니다.

자체 웹 서버를 사용하여 업그레이드

나중 버전으로 업그레이드하려면 자체 웹 서버를 사용하세요:

  1. 문서 사이트의 HTML 파일을 복사합니다: 

    docker create -it --name gitlab_docs registry.gitlab.com/gitlab-org/gitlab-docs/archives:16.0
docker cp gitlab_docs:/usr/share/nginx/html /srv/gitlab/
docker rm -f gitlab_docs

  2. 선택 사항. 이전 사이트를 제거합니다: 

    rm -r /srv/gitlab/html/16.0/

문제 해결

검색이 동작하지 않음

로컬 검색은 15.6 버전 이상에 포함되어 있습니다. 이전 버전을 사용하는 경우 검색이 동작하지 않습니다.

이미지는 컨테이너 레지스트리의 별도 저장소에 푸시됩니다.

로컬 검색을 사용하려면 이름에 archives가 포함된 Docker 이미지를 사용해야 합니다. 예: 

registry.gitlab.com/gitlab-org/gitlab-docs/archives:16.0

자세한 내용은 다양한 유형의 검색을 참조하세요. GitLab Docs가 사용 중입니다.

Docker 이미지를 찾을 수 없음

15.5 버전 이전을 사용하는 경우 Docker 이미지 이름에서 /archives를 삭제해야 합니다.

예: 

registry.gitlab.com/gitlab-org/gitlab-docs:15.5