{"id":18544043,"url":"https://github.com/themimitoof/krin","last_synced_at":"2026-04-30T13:33:27.267Z","repository":{"id":91051453,"uuid":"154221377","full_name":"Themimitoof/krin","owner":"Themimitoof","description":"[WIP :construction_worker:] Share instantaneously files and pictures","archived":false,"fork":false,"pushed_at":"2019-04-13T10:24:15.000Z","size":68,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-15T05:34:29.238Z","etag":null,"topics":["file-sharing","file-upload","nodejs","screenshot","screenshotscloud"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/Themimitoof.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-22T21:43:46.000Z","updated_at":"2021-04-20T07:35:18.000Z","dependencies_parsed_at":"2023-03-01T17:00:21.383Z","dependency_job_id":null,"html_url":"https://github.com/Themimitoof/krin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Themimitoof/krin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Themimitoof%2Fkrin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Themimitoof%2Fkrin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Themimitoof%2Fkrin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Themimitoof%2Fkrin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Themimitoof","download_url":"https://codeload.github.com/Themimitoof/krin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Themimitoof%2Fkrin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32466333,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"ssl_error","status_checked_at":"2026-04-30T13:12:06.837Z","response_time":57,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["file-sharing","file-upload","nodejs","screenshot","screenshotscloud"],"created_at":"2024-11-06T20:15:11.591Z","updated_at":"2026-04-30T13:33:27.240Z","avatar_url":"https://github.com/Themimitoof.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Krin: Share instantaneously files and pictures\nKrin is a simple server that host files and pictures for sharing instantaneously with your collegues or your friends built in _NodeJS_ and _SQLite_.\nIt can be used by multiple users by creating new _API key_ for each person.\n\n\n## Prerequisites\nYou only need to have [Node.JS](https://nodejs.org/en/download/) installed on your machine.\n\n\n## Docker installation\n_WIP_\n\n## Manual installation\n_WIP_\n\n## Usage\n### Routes\n#### `GET /files`\nHeaders:\n * `X-Api-Key`: _user's api key_\n * _(optionnal)_ `Content-type`: _return the error message in JSON if the value is `application/json`, otherwise is return in plain text._\n\nReturn: _Return the link to the file._\n\n#### `POST /files`\nHeaders:\n * `X-Api-Key`: _user's api key_\n * _(optionnal)_ `Expires-At`: expiration date of the ressource in _`RFC2822` or `ISO8601` format_.\n\nReturn: _Return the list of user's files._\n\n#### `GET /files/:filename`\nHeaders:\n * _(optionnal)_ `Content-type`: _return the error message in JSON if the value is `application/json`, otherwise is return in plain text._\n\nReturn: _Return the requested file or error message._\n\n#### `DELETE /files/:filename`\nHeaders:\n * `X-Api-Key`: _user's api key_\n * _(optionnal)_ `Content-type`: _return the error message in JSON if the value is `application/json`, otherwise is return in plain text._\n\nReturn: _Return validation message or error message._\n\n\n### Examples\n#### **Get users file list**\n```bash\ncurl -H \"X-Api-Key: \u003cmy_api_key\u003e\" http://\u003clink_to_my_instance\u003e/files\n```\n\nReturn:\n```json\n[\n    {\n        \"uuid\": \"2bfe71af-3ca5-4c2b-a148-da1eb1b88b36\",\n        \"file\": \"2732b422634229d30187ea25a930af13.jpg\",\n        \"owner\": \"4faa8b88-d63b-11e8-9f8b-f2801f1b9fd1\",\n        \"expireAt\": null,\n        \"createdAt\": \"2018-10-31 08:07:22.760 +00:00\",\n        \"updatedAt\": \"2018-10-31 08:07:22.760 +00:00\"\n    },\n    ...\n]\n```\n\n#### **Uploading a file with cURL**\n```bash\ncurl -X POST -H \"X-Api-Key: \u003cmy_api_key\u003e\" -d @\u003cfile\u003e http://\u003clink_to_my_instance\u003e/files\n```\n\nReturn: `http://\u003clink_to_my_instance\u003e/files/fkjldsjlkdsjklsdjflkdsjklsdjfs`\n\n#### Uploading a file with cURL and return in JSON:\n```bash\ncurl -X POST -H \"X-Api-Key: \u003cmy_api_key\u003e\" -H \"Content-type: application/json\" -d @\u003cfile\u003e http://\u003clink_to_my_instance\u003e/files\n```\n\nReturn:\n```json\n{\n    \"code\": 200,\n    \"message\": \"http://\u003clink_to_my_instance\u003e/files/fkjldsjlkdsjklsdjflkdsjklsdjfs\"\n}\n```\n\n#### **Uploading a file with expiration date with cURL**\n```bash\ncurl -X POST -H \"X-Api-Key: \u003cmy_api_key\u003e\" -H \"Expires-At: Mon, Dec 24 2018 23:59:59 GMT\" -d @\u003cfile\u003e http://\u003clink_to_my_instance\u003e/files\n```\n\nReturn: `http://\u003clink_to_my_instance\u003e/files/enzjrkzenrezkjrnezjknrzjke`\n\n#### **Delete a file with cURL**\n```bash\ncurl -X DELETE -H \"X-Api-Key: \u003cmy_api_key\u003e\" http://\u003clink_to_my_instance\u003e/files/\u003cfile_name\u003e\n```\n\nReturn: `File deleted`\n\n#### **Delete a file with cURL and return in JSON**\n```bash\ncurl -X DELETE -H \"X-Api-Key: \u003cmy_api_key\u003e\" -H \"Content-type: application/json\" -d @\u003cfile\u003e http://\u003clink_to_my_instance\u003e/files/\u003cfile_name\u003e\n```\n\nReturn:\n```json\n{\n    \"code\": 200,\n    \"message\": \"File deleted\"\n}\n```\n\n## Command lines\n_WIP_\n\n\n## Limitation\nToday, Krin uses _[file-type](https://www.npmjs.com/package/file-type) module_ to determine the MIME type and the extension of the file. If is not recognized by the module, it fallback automaticaly to _application/octet-stream_.\n\n\n## Contribution\nFeel free to contribute to the project by creating issues or merge request for implementing new features or patch bug.\n\n\n## License\nKrin is released with [MIT License](LICENSE).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthemimitoof%2Fkrin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthemimitoof%2Fkrin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthemimitoof%2Fkrin/lists"}