mirror of https://github.com/overleaf/overleaf.git synced 2024-12-28 05:12:25 +00:00

History

Simon Detheridge 37d44d5d86 Return full path in stubbed 'glob' method		2020-01-07 09:26:01 +00:00
..
.github
app/js	Add comment regarding deleteDirectory being internal-only	2020-01-07 09:26:01 +00:00
config
firejail
template_files
test	Return full path in stubbed 'glob' method	2020-01-07 09:26:01 +00:00
uploads
user_files
.dockerignore
.eslintrc
.gitignore
.nvmrc
.prettierignore
.prettierrc
.travis.yml
app.js	Clean up and promisify health-check controller and KeyBuilder	2020-01-07 09:23:41 +00:00
buildscript.txt
docker-compose.ci.yml
docker-compose.yml
Dockerfile
install_deps.sh
Jenkinsfile
LICENSE
Makefile
nodemon.json
npm-shrinkwrap.json	Use 'glob' to determine 'directory' size.	2020-01-07 09:26:00 +00:00
package.json	Use 'glob' to determine 'directory' size.	2020-01-07 09:26:00 +00:00
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.