Doxygen 외부 검색 기능 설정: Apache와 NGINX 환경에서의 CGI 연동 가이드

Doxygen 외부 검색의 필요성

Doxygen은 C++, C# 등 다양한 언어의 API 문서를 자동 생성하는 도구로, 기본 서버 기반 검색은 공백 처리로 인해 정확도 저하 문제가 있다. Doxygen 1.8.3 이후 도입된 EXTERNAL_SEARCH 옵션은 오픈소스 검색 엔진인 Xapian과 연동하여 이 문제를 해결한다.

WAS별 CGI 설정 방법

Doxygen의 외부 검색은 CGI 바이너리 파일(doxysearch.cgi)을 실행해야 하므로 웹 서버 설정이 필수적이다.

• Apache HTTP Server: ScriptAlias와 Options +ExecCGI를 설정하여 CGI 스크립트 실행을 허용한다. serve-cgi-bin.conf 파일을 수정해 /var/www/cgi-bin/으로 경로를 지정해야 한다.
• NGINX: 전통적인 CGI를 지원하지 않으므로 FcgiWrap 패키지를 설치하여 FastCGI로 변환한다. fcgiwrap.conf에서 .cgi 파일에 대한 fastcgi_pass 소켓 연결을 설정한다.

Doxygen 구성 및 배포 절차

외부 검색을 활성화하려면 Doxyfile에서 SEARCHENGINE=YES, EXTERNAL_SEARCH=YES 등을 설정하고 문서를 생성해야 한다. 생성된 searchdata.xml을 doxyindexer 명령어로 처리해 doxysearch.db 디렉터리를 만든다.

최종적으로 배포 문서의 루트 디렉터리에는 doxysearch.cgi 파일과 doxysearch.db 디렉터리가 모두 존재해야 하며, Xapian 라이브러리(libxapian-dev) 설치가 선행되어야 한다.