overleaf/services/filestore/README.md

24 lines
893 B
Markdown
Raw Normal View History

2019-05-07 11:22:35 -04:00
overleaf/filestore
2014-02-18 12:24:40 -05:00
====================
An API for CRUD operations on binary files stored in S3
2019-05-07 11:22:35 -04:00
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/overleaf/filestore/blob/master/app.coffee . URLs are of the form:
2018-10-22 09:09:56 -04:00
* `/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`
2014-02-18 12:24:40 -05:00
License
-------
The code in this repository is released under the GNU AFFERO GENERAL PUBLIC LICENSE, version 3. A copy can be found in the `LICENSE` file.
2019-05-07 11:22:35 -04:00
Copyright (c) Overleaf, 2014-2019.