개요

Overleaf는 Docker 네트워크 안에서 HTTP로 서로를 호출하는 여러 서비스로 실행됩니다. 이 섹션의 페이지는 이러한 내부 API를 설명합니다. 각 서비스의 코드를 바탕으로 작성된 develop/hoppscotch/openapi/의 OpenAPI 파일에서 가져왔습니다.

이 API는 모두 공개되어 있지 않습니다. Docker 네트워크 내부에서만 접근할 수 있으며, 대부분 인증이 없습니다.

​

서비스

서비스	주소	하는 일
web	http://web:3000	메인 앱. 비공개 API를 다른 서비스와 이미지의 cron 스크립트가 호출합니다
document-updater	http://document-updater:3003	편집기에서 열린 문서를 Redis에 보관하고 편집을 적용한 뒤 Mongo에 다시 기록합니다
docstore	http://docstore:3016	모든 프로젝트의 모든 문서를 Mongo의 docs 컬렉션에 저장합니다
real-time	http://real-time:3026	편집기의 socket.io 연결을 유지하고 브라우저와 서비스 사이에서 편집을 전달합니다
chat	http://chat:3010	프로젝트 채팅과 댓글 스레드를 저장합니다
project-history	http://project-history:3054	대기열의 편집을 기록 변경으로 변환해 history-v1에 보내고 레이블을 보관합니다
history-v1	http://history-v1:3100	모든 프로젝트의 전체 기록과 파일 내용을 blob으로 저장합니다
filestore	http://filestore:3009	템플릿 파일과, 읽기 전용으로 history-v1이 기록한 blob을 제공합니다
clsi	http://clsi:3013	프로젝트를 컴파일하고 SyncTeX와 단어 수 계산을 실행하며 문서를 변환합니다
notifications	http://notifications:3042	프로젝트 목록에 표시되는 알림을 저장합니다
linked-url-proxy	http://linked-url-proxy:3066	web을 위해 외부 URL을 가져오고 내부 주소를 거부합니다
third-party-datastore	http://third-party-datastore:3002	사용자별 작업 대기열 하나로 프로젝트를 Dropbox와 동기화합니다

​

인증

• web: WEB_API_USER 및 WEB_API_PASSWORD를 사용한 HTTP 기본 인증. git-bridge 경로는 대신 개인 액세스 토큰을 사용합니다.
• history-v1: STAGING_PASSWORD를 사용한 staging 계정의 HTTP 기본 인증 또는 JWT.
• 그 밖의 모든 서비스: 없음.

​

사용해 보기

개발 환경은 http://localhost:9170에서 Hoppscotch를 실행하며, Docker 주소로 서비스에 접근하는 프록시를 함께 제공합니다. 프록시 설정과 OpenAPI 파일 가져오기 방법은 README를 참고하세요.