OpenSource-Hub
D

docat

898 stars·개발 도구·SHA-256 체크섬 확인됨

간단하고 멀티 버전을 지원하는 문서 호스팅 도구로, 코드를 관리하듯 문서 버전을 관리할 수 있습니다.

스마트 다운로드

프로젝트 홈페이지 방문

아직 설치 프로그램이 없습니다 — 소스 저장소로 이동하세요

원클릭 Docker 배포로 여러 버전의 문서를 손쉽게 호스팅하세요.

주요 기능

  • 여러 프로젝트 및 각 프로젝트의 다중 버전 지원
  • Docker를 통한 원클릭 배포로 2분 만에 서비스 시작
  • CLI 클라이언트 docatl 제공, 원클릭 문서 업로드
  • 프로젝트 클레임 및 토큰 인증 지원으로 업로드 보안 보장
  • 사용자 지정 페이지 머리글 및 바닥글 지원, 브랜드 스타일에 맞게 조정

할 수 없는 것

  • •기본적으로 인증이 활성화되어 있지 않으므로 서비스 주소를 아는 사람은 누구나 문서를 업로드할 수 있습니다. 공용 네트워크에 배포하는 경우 반드시 Nginx의 HTTP Basic Auth를 구성해야 합니다(자세한 내용은 README 참조). 또한 DOCAT은 문서 호스팅만 담당하며 문서 작성 기능은 제공하지 않으므로, 먼저 mkdocs 등의 도구로 정적 파일을 생성해야 합니다.

사용 사례

  • 소프트웨어의 다양한 버전(예: v1.0, v2.0)별로 해당 사용자 매뉴얼을 각각 호스팅
  • 기업 내부 팀이 사용하며, 타사 문서 호스팅 플랫폼에 의존할 필요 없음
  • 오픈 소스 프로젝트 문서를 게시하면서 이전 버전 문서도 보존하여 사용자가 열람할 수 있도록 함

상세 설명

DOCAT은 여러 문서 버전을 관리해야 하는 프로젝트 또는 팀을 위해 설계된 경량 셀프 호스팅 문서 호스팅 서버입니다. mkdocs, Sphinx, mdBook 등의 정적 사이트 생성기와 원활하게 호환됩니다. Docker 명령어 하나만으로 완전한 기능을 갖춘 문서 호스팅 플랫폼을 얻을 수 있습니다. 토큰을 통한 프로젝트 클레임을 지원하고, CLI 도구(docatl)로 문서를 손쉽게 업로드할 수 있으며, 설정 파일을 통해 헤더와 푸터를 사용자 정의할 수 있습니다. Read the Docs 같은 호스팅 서비스와 달리 DOCAT은 데이터에 대한 완전한 통제권을 제공하므로, 사내 기업 문서나 프라이버시 요구 사항이 엄격한 프로젝트에 매우 적합합니다.

문제 해결 & FAQ (1)

문제 해결
docat이 .zip 대신 .tar 또는 .tar.gz 파일 업로드를 지원하나요?

아니요, docat은 업로드를 위해 .zip 파일만 허용합니다. 빌드 환경에 zip 명령어가 없다면, docatl CLI 도구(docat 프로젝트에서 제공)를 사용하여 문서를 zip으로 패키징하십시오. docatl은 컨테이너에 바이너리로 추가할 수 있습니다. https://github.com/docat-org/docatl 참조하십시오.

원본 Issue #916

태그

documentationhostingversioningdockermkdocssphinx

시작하기

1

설치 프로그램 다운로드

위 버튼을 클릭하여 시스템에 맞는 설치 프로그램을 다운로드

2

소프트웨어 설치

다운로드한 설치 프로그램을 더블 클릭하고 안내에 따르세요

3

1단계: 로컬에 영구 디렉터리 생성 (예: mkdir -p docat-run/doc)

4

2단계: Docker 명령을 실행하여 컨테이너 시작 (포트 8000, 디렉터리 마운트)

5

3단계: 브라우저를 열고 http://localhost:8000에 접속하면 기본 화면을 볼 수 있습니다

설치 가이드
  1. 1단계: 로컬에 영구 디렉터리 생성 (예: mkdir -p docat-run/doc)
  2. 2단계: Docker 명령을 실행하여 컨테이너 시작 (포트 8000, 디렉터리 마운트)
  3. 3단계: 브라우저를 열고 http://localhost:8000에 접속하면 기본 화면을 볼 수 있습니다
파일 무결성

체크섬 없음

이 프로젝트는 GitHub Release 페이지에 SHA-256 체크섬을 게시하지 않았습니다

SHA256 체크섬

체크섬 없음

GitHub Releases에서 직접 다운로드하고 파일 무결성을 직접 확인하세요

이 플랫폼의 모든 SHA-256 체크섬은 프로젝트의 공식 GitHub Release 페이지에서 추출되었으며, 어떠한 변경도 없습니다. GitHub Releases 페이지에서 직접 검증할 수 있습니다.

오픈소스 투명성

GitHub 소스 보기
환경 가이드

제거 정보

Docker 컨테이너를 중지하고 삭제합니다: docker stop docat && docker rm docat; 그런 다음 로컬 영구 데이터 디렉터리(기본값은 docat-run/)를 삭제하면 완전히 제거됩니다.

추가 의존성 없음

다운로드 후 바로 사용 가능. 추가 런타임이 필요하지 않습니다.

프로젝트 정보
라이선스MIT
마지막 업데이트2026-06-27 13:40:07
GitHub 저장소공식 웹사이트

문제 발생? 아래 FAQ 확인

1 FAQ

유사한 프로젝트