{"id":22812474,"url":"https://github.com/open-template-hub/file-storage-server-template","last_synced_at":"2025-08-12T23:04:22.209Z","repository":{"id":38076582,"uuid":"287944888","full_name":"open-template-hub/file-storage-server-template","owner":"open-template-hub","description":"File Storage Server Template is a generic open-source file storage server that has a simple yet powerful design to connect your business with third-party file storage provider companies (AWS S3, Google Cloud Storage).","archived":false,"fork":false,"pushed_at":"2023-01-27T07:03:45.000Z","size":219,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-04-22T16:10:38.485Z","etag":null,"topics":["amazon","amazon-web-services","aws","aws-s3","download","file","gcloud","gcp","gcp-cloud-functions","gcp-storage","google-cloud-storage","storage","upload"],"latest_commit_sha":null,"homepage":"https://opentemplatehub.com/product/server/file-storage-server-template","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/open-template-hub.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-08-16T13:02:44.000Z","updated_at":"2024-03-14T22:20:46.000Z","dependencies_parsed_at":"2023-02-15T06:32:00.305Z","dependency_job_id":null,"html_url":"https://github.com/open-template-hub/file-storage-server-template","commit_stats":null,"previous_names":[],"tags_count":15,"template":true,"template_full_name":null,"purl":"pkg:github/open-template-hub/file-storage-server-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-template-hub%2Ffile-storage-server-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-template-hub%2Ffile-storage-server-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-template-hub%2Ffile-storage-server-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-template-hub%2Ffile-storage-server-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/open-template-hub","download_url":"https://codeload.github.com/open-template-hub/file-storage-server-template/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-template-hub%2Ffile-storage-server-template/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269693303,"owners_count":24460225,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-10T02:00:08.965Z","response_time":71,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["amazon","amazon-web-services","aws","aws-s3","download","file","gcloud","gcp","gcp-cloud-functions","gcp-storage","google-cloud-storage","storage","upload"],"created_at":"2024-12-12T12:12:46.052Z","updated_at":"2025-08-10T07:31:42.378Z","avatar_url":"https://github.com/open-template-hub.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n   \u003ca href=\"https://opentemplatehub.com\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/open-template-hub/open-template-hub.github.io/master/assets/logo/server/file-storage-server-logo.png\" alt=\"Logo\" width=200\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003e\nOpen Template Hub - File Storage Server Template v5\n\u003c/h1\u003e\n\n[![License](https://img.shields.io/github/license/open-template-hub/file-storage-server-template?color=43b043\u0026style=for-the-badge)](LICENSE)\n[![Issues](https://img.shields.io/github/issues/open-template-hub/file-storage-server-template?color=43b043\u0026style=for-the-badge)](https://github.com/open-template-hub/file-storage-server-template/issues)\n[![PRCLosed](https://img.shields.io/github/issues-pr-closed-raw/open-template-hub/file-storage-server-template?color=43b043\u0026style=for-the-badge)](https://github.com/open-template-hub/file-storage-server-template/pulls?q=is%3Apr+is%3Aclosed)\n[![LastCommit](https://img.shields.io/github/last-commit/open-template-hub/file-storage-server-template?color=43b043\u0026style=for-the-badge)](https://github.com/open-template-hub/file-storage-server-template/commits/master)\n[![Release](https://img.shields.io/github/release/open-template-hub/file-storage-server-template?include_prereleases\u0026color=43b043\u0026style=for-the-badge)](https://github.com/open-template-hub/file-storage-server-template/releases)\n[![SonarCloud](https://img.shields.io/sonar/quality_gate/open-template-hub_file-storage-server-template?server=https%3A%2F%2Fsonarcloud.io\u0026label=Sonar%20Cloud\u0026style=for-the-badge\u0026logo=sonarcloud)](https://sonarcloud.io/dashboard?id=open-template-hub_file-storage-server-template)\n\nFile Storage Server Template is a generic open-source file storage server that has a simple yet powerful design to connect your business with third-party file storage provider companies (AWS S3, Google Cloud Storage).\n\n## Ways to Begin\n\nnpm install --save-dev @types/node\n\n### 1. Express Deploy\n\nDeploy this template to Heroku\n\n[![Deploy](https://img.shields.io/badge/Deploy_to-Heroku-7056bf.svg?style=for-the-badge\u0026logo=heroku)](https://heroku.com/deploy?template=https://github.com/open-template-hub/file-storage-server-template)\n\n### 2. Start with Server Generator\n\nCreate your server with Server Generator Package\n\n[![NPM](https://img.shields.io/badge/NPM-server_generator-cb3837.svg?style=for-the-badge\u0026logo=npm)](https://www.npmjs.com/package/@open-template-hub/server-generator)\n\n### 3. GitHub Template\n\nUse this repository as a Template\n\n[![GitHubTemplate](https://img.shields.io/badge/GitHub-Template-24292e.svg?style=for-the-badge\u0026logo=github)](https://github.com/open-template-hub/file-storage-server-template/generate)\n\n## Installations\n\nInstall **nodejs** and **npm** via **[nodejs.org](https://nodejs.org)**.\n\nCheck installed versions of **nodejs** and **npm** via running following commands:\n\n```\nnode -v\nnpm -v\n```\n\nCheck project's current **nodejs** and **npm** version from **[package.json](package.json)**.\n\n## Environment Variables\n\nIf you don't give **RESPONSE_ENCRYPTION_SECRET**, response encryption mechanism will be disabled automatically.\n\n```applescript\nPORT=4004\n\nPROJECT=OTH\nMODULE=FileStorageServer\nENVIRONMENT=Local\n\nMONGODB_URI={Database Connection Url}\nMONGODB_CONNECTION_LIMIT={MongoDB Connection Limit}\n\nDATABASE_URL={Database Connection Url}\nPOSTGRESQL_CONNECTION_LIMIT={Postgresql Connection Limit}\n\nCLOUDAMQP_APIKEY={MQ Api Key}\nCLOUDAMQP_URL={MQ Connection Url}\n\nFILE_SERVER_QUEUE_CHANNEL=oth_file_queue\nORCHESTRATION_SERVER_QUEUE_CHANNEL=oth_orchestration_queue\n\nREDISCLOUD_URL={Redis Connection Url}\nREDIS_CONNECTION_LIMIT={Redis Connection Limit}\n\nACCESS_TOKEN_SECRET={Access Token Secret}\nRESPONSE_ENCRYPTION_SECRET={Response Encryption Secret}\n```\n\nFor pre-deployment of S3 provider, update **assets/sql/preload.data.json**\nwith your configuration:\n\n```json\n{\n  \"key\": \"S3\",\n  \"description\": \"Amazon S3 Provider\",\n  \"payload\": {\n    \"service\": \"S3\",\n    \"accessKeyId\": \"{AWS Access Key Id}\",\n    \"secretAccessKey\": \"{AWS Secret Key Id}\",\n    \"region\": \"{S3 Region}\",\n    \"apiVersion\": \"{API Version}\",\n    \"bucketName\": \"{S3 Bucket Name}\",\n    \"publicUrl\": \"{S3 Public Url}\"\n  }\n}\n```\n\nFor pre-deployment of Google Cloud Storage provider, update **assets/sql/preload.data.json**\nwith your configuration:\n\n```json\n{\n  \"key\": \"GCloud\",\n  \"description\": \"Google Cloud Storage Provider\",\n  \"payload\": {\n    \"service\": \"GCloud\",\n    \"projectId\": \"{GCloud Project Id}\",\n    \"clientId\": \"{GCloud Service User Unique Id}\",\n    \"serviceAccount\": \"{GCloud Service User Email}\",\n    \"secretAccessKey\": \"{GCloud Service User Private Key}\",\n    \"bucketName\": \"{GCloud Bucket Name}\",\n    \"publicUrl\": \"{GCloud Public Url}\"\n  }\n}\n```\n\n## Http Requests\n\nYou can find list of available http request in the [requests](assets/requests) directory. You can run http requests directly via **WebStorm**, for more information check out: [jetbrains.com/help/idea/http-client-in-product-code-editor.html](https://jetbrains.com/help/idea/http-client-in-product-code-editor.html)\n\n## Contributors\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/furknyavuz\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/2248168?s=460\u0026u=435ef6ade0785a7a135ce56cae751fb3ade1d126\u0026v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eFurkan Yavuz\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/open-template-hub/file-storage-server-template/issues/created_by/furknyavuz\" title=\"Answering Questions\"\u003e💬\u003c/a\u003e \u003ca href=\"https://github.com/open-template-hub/file-storage-server-template/commits?author=furknyavuz\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"https://github.com/open-template-hub/file-storage-server-template/pulls?q=is%3Apr+reviewed-by%3Afurknyavuz\" title=\"Reviewed Pull Requests\"\u003e👀\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/fatihturker\"\u003e\u003cimg src=\"https://avatars1.githubusercontent.com/u/2202179?s=460\u0026u=261b1129e7106c067783cb022ab9999aad833bdc\u0026v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eFatih Turker\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/open-template-hub/file-storage-server-template/issues/created_by/fatihturker\" title=\"Answering Questions\"\u003e💬\u003c/a\u003e \u003ca href=\"https://github.com/open-template-hub/file-storage-server-template/commits?author=fatihturker\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"https://github.com/open-template-hub/file-storage-server-template/pulls?q=is%3Apr+reviewed-by%3Afatihturker\" title=\"Reviewed Pull Requests\"\u003e👀\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/mertlsarac\"\u003e\u003cimg src=\"https://avatars1.githubusercontent.com/u/38442589?s=400\u0026u=aa3cda11724fc297a0bfa6beb35c9be81687cf3c\u0026v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eMert Sarac\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/open-template-hub/file-storage-server-template/issues/created_by/mertlsarac\" title=\"Answering Questions\"\u003e💬\u003c/a\u003e \u003ca href=\"https://github.com/open-template-hub/file-storage-server-template/commits?author=mertlsarac\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"https://github.com/open-template-hub/file-storage-server-template/pulls?q=is%3Apr+reviewed-by%3Amertlsarac\" title=\"Reviewed Pull Requests\"\u003e👀\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\u003c!-- markdownlint-enable --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\n## Contributing\n\nRefer to **[CONTRIBUTING.md](https://github.com/open-template-hub/.github/blob/master/docs/CONTRIBUTING.md)** to see how to contribute to Open Template Hub.\n\n\u003cbr/\u003e\n\n## Code of Conduct\n\nRefer to **[CODE_OF_CONDUCT.md](https://github.com/open-template-hub/.github/blob/master/docs/CODE_OF_CONDUCT.md)** to see contributor covenant code of conduct.\n\n\u003cbr/\u003e\n\n## LICENSE\n\nThe source code for this project is released under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-template-hub%2Ffile-storage-server-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopen-template-hub%2Ffile-storage-server-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-template-hub%2Ffile-storage-server-template/lists"}