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 run --detach --name gitlab_docs -it --rm -p 4000:4000 registry.gitlab.com/gitlab-org/gitlab-docs/archives:16.0

    • 도커 컴포즈를 사용하여 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에서 더 알아보기 링크를 선택하십시오. 예를 들어:

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

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

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

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가 포함된 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