Platform Docs

Appearance

문서 라이브러리 보관·복구 ​

플랫폼 문서(비전·결정·규격·보고서)는 UiPlatform CI가 HTML/PDF로 만들어 콘솔 API(POST /api/library/v1/documents)로 게시하고, 콘솔이 로컬 파일시스템 보관소에 적재한다. 파일 본문 저장은 FileStore가 소유하므로(docs/SERVICE_BOUNDARIES.md) 문서 라이브러리는 콘솔 전용 로컬 볼륨을 쓴다 — 볼륨이 없으면 재기동 시 문서가 사라진다.

1. 보관 위치 ​

항목값
보관소콘솔 서버 로컬 파일시스템(오브젝트 스토리지 사용 안 함)
경로PORTAL_CONSOLE_DOC_LIBRARY_PATH (기본 var/doc-library · 컨테이너에서는 /app/var/doc-library)
게시 로그게시 완료: platform-vision@2026-09-15 (filesystem)

관리자 화면 문서 라이브러리의 보관 위치 줄이 실제 경로를 보여준다.

2. 유실 방지 (볼륨) ​

  • Docker Compose 배포: docker-compose.onprem.yml 에 마운트가 있다(PORTAL_CONSOLE_DOC_LIBRARY_HOST_PATH, 기본 ./data/doc-library).
  • Coolify 등 오케스트레이터 배포: 서비스 설정의 볼륨(영속 스토리지) 에 /app/var/doc-library 를 매핑한다. 매핑 없이 재배포하면 문서가 사라진다.
  • 백업 대상에 그 경로를 포함한다(컨테이너가 root로 실행되므로 root 권한 cron 권장).

3. 사라진 문서 복구 ​

문서의 원본은 저장소(UiPlatform/docs)이고 게시는 재실행 가능하다 — 아래 한 번이면 전체가 다시 올라간다.

bash
gh workflow run publish-docs.yml -R hohyun94/UiPlatform
  • GitHub Actions 화면에서 Publish platform docs → Run workflow 도 같은 효과다.
  • 같은 버전(docs 최근 커밋 날짜)에 덮어쓰므로 중복이 생기지 않는다.

4. R2 전환은 더 이상 지원하지 않는다 ​

과거에는 PORTAL_CONSOLE_STORAGE_*(R2)로 문서를 보관할 수 있었다. 첨부 파일 본문 소유권을 FileStore로 일원화하면서 문서 라이브러리는 로컬 보관만 쓰며, PORTAL_CONSOLE_DOC_LIBRARY_PROVIDER=r2 를 설정하면 게시·조회가 사전조건 오류로 거부된다. 포털 첨부 파일은 각 포털이 FileStore 어댑터로 직접 다룬다.