mirror of https://github.com/overleaf/overleaf.git synced 2024-11-29 21:03:39 -05:00

History

Antoine Clausse 01188589f8 Add some JSDoc types to `@overleaf/logger` (#19153 ) * Add some JSDoc types to `@overleaf/logger` * Update `logger.error` calls * Fixup `logger.err` JSDoc * Update `logger.err` calls * Fix `args` type * Remove "Error message" description * Replace `arguments` by actual arguments of the method * Fix: "ESLint: Unnecessary '.apply()'.(no-useless-call)" * Add JSDoc params to `debug` `info` `warn` * Remove extra `args` param in JSDoc so developers aren't invited to use it Not sure if this is the best thing to do because it creates a warning in the IDE: "Parameter args is not described in JSDoc" * Add comment about serialization of `err` `req` `res` * Allow strings as first param in `debug` `info` `warn` * Fix syntax for optional parameters in JSDoc * Add 2 signatures, to avoid "string, string" params * Fix `@signature` names copy-pastes Co-authored-by: Jakob Ackermann <jakob.ackermann@overleaf.com> * Revert the double `@param attributes`. It doesn't work --------- Co-authored-by: Jakob Ackermann <jakob.ackermann@overleaf.com> GitOrigin-RevId: 086dee8bbf30d577c5e1f844a9df5e518c46aca7		2024-06-28 08:04:25 +00:00
..
app/js	Merge pull request #18289 from overleaf/ac-ar-eslint-return-await	2024-05-27 10:22:49 +00:00
config	Merge pull request #18116 from overleaf/jpa-bulk-replace-localhost	2024-04-26 08:04:39 +00:00
firejail	bumped up rlimit-nproc to 600	2016-12-14 18:15:09 +00:00
template_files	Handle templates locally ok	2014-11-27 11:08:29 +00:00
test	Merge pull request #18289 from overleaf/ac-ar-eslint-return-await	2024-05-27 10:22:49 +00:00
uploads	Initial open source commit	2014-02-14 16:39:05 +00:00
user_files	Use default settings file	2014-04-02 17:45:41 +01:00
.gitignore	[misc] bump the dev-env to 3.3.2	2020-08-10 17:01:12 +01:00
.nvmrc	Merge pull request #17870 from overleaf/bg-node-upgrade-18-20-2	2024-04-24 08:05:16 +00:00
.prettierignore	Add linting to makefile	2019-12-16 11:58:22 +00:00
app.js	Add some JSDoc types to `@overleaf/logger` (#19153 )	2024-06-28 08:04:25 +00:00
buildscript.txt	Merge pull request #17870 from overleaf/bg-node-upgrade-18-20-2	2024-04-24 08:05:16 +00:00
docker-compose.ci.yml	Merge pull request #17081 from overleaf/csh-build_scripts-redis-acceptance	2024-02-14 09:06:09 +00:00
docker-compose.yml	Merge pull request #17081 from overleaf/csh-build_scripts-redis-acceptance	2024-02-14 09:06:09 +00:00
Dockerfile	Merge pull request #17870 from overleaf/bg-node-upgrade-18-20-2	2024-04-24 08:05:16 +00:00
install_deps.sh	Merge pull request #12990 from overleaf/jpa-filestore-ss	2023-05-09 08:04:37 +00:00
LICENSE	Create LICENSE	2014-02-19 14:48:15 +00:00
Makefile	Merge pull request #18167 from overleaf/em-simpler-typescript-backend	2024-05-07 08:04:00 +00:00
package.json	Merge pull request #17974 from overleaf/rh-express-4192	2024-04-23 08:05:01 +00:00
README.md	Merge pull request #16859 from overleaf/jpa-sharelatex-cleanup	2024-02-09 09:04:11 +00:00
tiny.pdf	added missing files	2016-12-14 17:14:15 +00:00
tsconfig.json	Merge pull request #18289 from overleaf/ac-ar-eslint-return-await	2024-05-27 10:22:49 +00:00

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 HTTP 200 filestore is up or HTTP 503 when shutting down
/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.