Просмотр исходного кода

Add some details to the README

Christopher Hoskin 7 лет назад
Родитель
Сommit
038b3476fe
1 измененных файлов с 12 добавлено и 0 удалено
  1. 12 0
      services/filestore/README.md

+ 12 - 0
services/filestore/README.md

@@ -5,6 +5,18 @@ An API for CRUD operations on binary files stored in S3
 
 [![Build Status](https://travis-ci.org/sharelatex/filestore-sharelatex.png?branch=master)](https://travis-ci.org/sharelatex/filestore-sharelatex)
 
+filestore acts as a proxy between the CLSIs and (currently) Amazon S3 storage, presenting a RESTful HTTP interface to the CLSIs on port 3009 by default. Urls are mapped to node functions in https://github.com/sharelatex/filestore-sharelatex/blob/master/app.coffee . URLs are of the form:
+
+* `/project/:project_id/file/:file_id`
+* `/template/:template_id/v/:version/:format`
+* `/project/:project_id/public/:public_file_id`
+* `/project/:project_id/size`
+* `/bucket/:bucket/key/*`
+* `/heapdump`
+* `/shutdown`
+* `/status` - returns `filestore sharelatex up` or `server is being shut down` (HTTP 500)
+* `/health_check` 
+
 License
 -------