seoul/README.md

Seoul

nginx 설정을 읽어 웹 서비스 바로가기 목록을 만드는 PHP 대시보드입니다.

서버에 있는 여러 웹 서비스를 한 화면에서 찾기 위해 사용합니다. nginx server block에서 host와 document root를 읽고, 각 root 안의 PHP entry를 찾아 링크로 보여줍니다.

사용한 것

• PHP
• nginx 설정 파일
• PWA manifest
• Service worker 정리 스크립트

파일

• index.php: nginx 설정을 읽고 바로가기 화면을 렌더링합니다.
• api.php: WOL 호환 요청만 Control API로 넘깁니다.
• asset-version.php: 정적 파일 버전을 JSON으로 내려줍니다.
• assets/asset-reload.js: 파일 버전이 바뀌면 캐시를 비우고 화면을 다시 엽니다.
• manifest.webmanifest: PWA 설치 정보입니다.
• sw.js: 과거 service worker 등록을 정리합니다.

동작

• /etc/nginx/nginx.conf, /etc/nginx/sites-enabled, /etc/nginx/conf.d를 읽습니다.
• HTTPS server block의 server_name과 root를 수집합니다.
• 각 document root에서 index.php, monitor.php 같은 얕은 entry를 찾습니다.
• 자기 자신, 내부 host, IP 주소, 변수 host, 정규식 host는 목록에서 제외합니다.
• 화면에 서비스 이름, host, entry path를 표시합니다.

캐시 처리

• asset-version.php는 PHP, JS, CSS, manifest, icon 파일의 hash를 계산합니다.
• index.php는 정적 파일 경로에 버전 값을 붙입니다.
• 파일 버전이 바뀌면 브라우저 캐시와 service worker 등록을 정리한 뒤 현재 화면을 다시 엽니다.
• 문서 응답은 no-store로 내려 오래된 화면이 남지 않게 합니다.

보안

• nginx 설정은 목록 표시용으로만 읽습니다.
• 화면에 출력하는 host와 link 값은 escape합니다.
• 내부 전용 host와 IP 주소는 목록에서 제외합니다.
• api.php는 WOL 관련 액션만 받습니다. 인증과 토큰 검증은 Control 쪽에서 처리합니다.

메모

• car/ 디렉터리는 별도 저장소로 관리하므로 이 저장소의 서비스 목록에서는 제외합니다.
• nginx 설정을 바꾼 뒤에는 의도하지 않은 host가 목록에 나오지 않는지 확인합니다.