GitLab 제품 문서 호스팅하기

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

만약 docs.gitlab.com에서 GitLab 제품 문서에 접근할 수 없는 경우, 대신 문서를 직접 호스팅할 수 있습니다.

note
인스턴스의 로컬 도움말에는 모든 문서가 포함되지 않습니다(예: GitLab Runner나 GitLab Operator 문서는 포함되지 않음) 검색 가능하거나 탐색 가능하지 않습니다. 이것은 오직 Self-Managed GitLab 인스턴스 내에서 특정 페이지로의 직접 링크만 지원하기 위한 것입니다.

문서 자체 호스팅 옵션

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

  • 도커 컨테이너
  • GitLab Pages
  • 고유한 웹 서버

다음 예시는 GitLab 16.0를 사용하지만, 본인의 GitLab 인스턴스에 해당하는 버전을 사용하십시오.

도커로 제품 문서 자체 호스팅

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

다음 기본사항을 확인하십시오:

  • 방화벽에서 4000 포트를 허용합니다.
  • 다른 포트를 사용합니다. 다음 예시에서 가장 왼쪽에 있는 4000을 다른 포트 번호로 바꿉니다.

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로 완전히 정규화된 도메인 이름을 사용하십시오. 예를 들어, 도커 방법을 사용했다면, 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에서 Learn more 링크를 선택하십시오. 예를 들어:

  1. 왼쪽 사이드바에서 아바타를 선택하십시오.
  2. Preferences를 선택합니다.
  3. Syntax highlighting theme 섹션에서 Learn more를 선택합니다.

제품 문서를 최신 버전으로 업그레이드하기

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

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

Docker를 사용하여 나중의 버전으로 업그레이드하려면:

  • 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를 포함하는 도커 이미지를 사용하는지 확인하세요. 예: 

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

더 많은 정보는 다양한 검색 유형에 대해 GitLab Docs를 읽어보세요.

Docker 이미지를 찾을 수 없음

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

예: 

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