mirror of https://github.com/overleaf/overleaf.git synced 2024-12-28 03:10:49 +00:00

History

Brian Gough 2ec38068aa add comments about aws-sdk and s3 backends		2019-12-06 14:35:13 +00:00
..
.github	replace private link with public one	2019-10-25 11:51:58 -04:00
app/coffee	add comments about aws-sdk and s3 backends	2019-12-06 14:35:13 +00:00
config
firejail
template_files
test
uploads
user_files
.dockerignore
.gitignore
.nvmrc
.travis.yml
app.coffee
buildscript.txt	bump build script to 1.1.24	2019-10-25 11:52:54 -04:00
cluster.coffee
docker-compose.ci.yml	bump build script to 1.1.24	2019-10-25 11:52:54 -04:00
docker-compose.yml	bump build script to 1.1.24	2019-10-25 11:52:54 -04:00
Dockerfile
install_deps.sh
Jenkinsfile
LICENSE
Makefile	bump build script to 1.1.24	2019-10-25 11:52:54 -04:00
nodemon.json
npm-shrinkwrap.json
package.json
README.md
tiny.pdf

README.md

overleaf/filestore

An API for CRUD operations on binary files stored in S3

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:

/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.