Expand README from project report

README.md

@@ -2,25 +2,30 @@
 
 nginx 설정을 기반으로 서비스 바로가기 목록을 구성하는 PHP 대시보드입니다.
 
+## 프로젝트 성격
+
+Seoul은 서버에 흩어진 웹 서비스들을 한 화면에서 찾기 위한 시작 페이지입니다. nginx 설정 파일을 읽어 HTTPS server block과 document root를 수집하고, 각 root에서 얕은 PHP entry를 찾아 링크 목록으로 렌더링합니다.
+
 ## 주요 기능
 
-- nginx 설정 파일을 읽고 HTTPS server block의 host를 추출합니다.
+- nginx 설정 파일 순회
-- document root에서 얕은 PHP entry를 찾아 바로가기 목록으로 표시합니다.
+- HTTPS server block의 host 추출
-- 자기 자신, 내부 이름, IP literal, 변수, 정규식 형태 host를 제외합니다.
+- document root에서 `index.php`, `monitor.php` 같은 entry 탐색
-- PWA manifest와 service worker를 제공합니다.
+- 자기 자신, 내부 host, IP literal, 변수, 정규식 형태 host 제외
-- 서비스 이름, host, entry path를 한 화면에서 빠르게 확인할 수 있게 구성합니다.
+- 서비스 이름, host, entry path 표시
+- PWA manifest와 service worker 제공
 
 ## 주요 진입점
 
-- `index.php`
+- `index.php`: 바로가기 대시보드
-- `manifest.webmanifest`
+- `manifest.webmanifest`: PWA manifest
-- `sw.js`
+- `sw.js`: service worker
 
 ## 구성
 
-- `index.php`: 바로가기 대시보드 본체
+- `index.php`: nginx 설정 파싱과 HTML 렌더링
-- `manifest.webmanifest`: PWA manifest
+- `manifest.webmanifest`: PWA 설치 정보
-- `sw.js`: service worker
+- `sw.js`: 대시보드 캐시와 PWA 동작
 - `assets/`: 아이콘과 정적 자산
 
 ## 입력 소스
@@ -30,6 +35,21 @@ nginx 설정을 기반으로 서비스 바로가기 목록을 구성하는 PHP
 - `/etc/nginx/conf.d`
 - 각 server block의 document root
 
+## 처리 흐름
+
+1. nginx 설정 경로를 순회합니다.
+2. `server_name`과 document root를 수집합니다.
+3. document root에서 얕은 PHP entry를 찾습니다.
+4. 제외 규칙을 통과한 항목만 링크 목록으로 렌더링합니다.
+
+## 제외/필터 기준
+
+- 자기 자신 또는 중복 host
+- 내부 전용 host
+- IP literal
+- nginx 변수나 정규식 형태 host
+- 외부 노출이 부적절한 entry
+
 ## 참고
 
 `car/` 디렉터리는 별도 저장소로 관리하므로 이 저장소에서는 제외합니다.
@@ -39,3 +59,10 @@ nginx 설정을 기반으로 서비스 바로가기 목록을 구성하는 PHP
 - nginx 설정 읽기는 표시용으로만 사용합니다.
 - 생성된 host와 link 값은 렌더링 전에 escape합니다.
 - 내부 전용 host와 IP literal은 목록에서 제외해 외부 노출 가능성을 낮춥니다.
+
+## 운영 체크포인트
+
+- nginx 설정 변경 후 목록에 의도한 서비스만 노출되는지 확인합니다.
+- 민감하거나 내부 전용 host가 목록에 나오지 않도록 제외 규칙을 유지합니다.
+- Car 서비스 명세는 별도 문서와 저장소에서 관리합니다.
+