mirror of https://github.com/overleaf/overleaf.git synced 2024-12-26 18:51:17 +00:00

History

Simon Detheridge 460dd96b17 Cosmetic clean-up of GCS Persistor & tests		2020-03-05 13:45:46 +00:00
..
.github
app/js	Cosmetic clean-up of GCS Persistor & tests	2020-03-05 13:45:46 +00:00
config	Add note on gcs config to config file	2020-03-04 15:38:18 +00:00
firejail
template_files
test	Cosmetic clean-up of GCS Persistor & tests	2020-03-05 13:45:46 +00:00
uploads
user_files
.dockerignore
.eslintrc
.gitignore
.nvmrc
.prettierignore
.prettierrc
app.js
buildscript.txt
docker-compose.ci.yml	Use http for the fake GCS server	2020-03-04 17:01:20 +00:00
docker-compose.yml	Use http for the fake GCS server	2020-03-04 17:01:20 +00:00
Dockerfile
install_deps.sh
Jenkinsfile
LICENSE
Makefile
nodemon.json
package-lock.json	Add gcs client library	2020-03-04 15:09:14 +00:00
package.json	Add gcs client library	2020-03-04 15:09:14 +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/*
/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.