overleaf/services/filestore
2018-11-07 16:12:49 +00:00
..
app/coffee
config
firejail
template_files
test
uploads
user_files
.gitignore
.nvmrc
.travis.yml
app.coffee fix typo 2018-09-11 10:51:10 +01:00
cluster.coffee
Dockerfile add dockerfile to install packages needed by filestore 2018-11-07 16:12:49 +00:00
Gruntfile.coffee
Jenkinsfile
LICENSE
npm-shrinkwrap.json fix shrinkwrap for upgraded logger-sharelatex module 2018-09-06 17:01:40 +01:00
package.json fix shrinkwrap for upgraded logger-sharelatex module 2018-09-06 17:01:40 +01:00
README.md Add some details to the README 2018-10-22 14:09:56 +01:00
tiny.pdf

filestore-sharelatex

An API for CRUD operations on binary files stored in S3

Build Status

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

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.

Copyright (c) ShareLaTeX, 2014.