summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorFlam3rboy <34555296+Flam3rboy@users.noreply.github.com>2021-08-12 20:16:45 +0200
committerFlam3rboy <34555296+Flam3rboy@users.noreply.github.com>2021-08-12 20:16:45 +0200
commit71eeb8df01442f8068d7ad2ec582057351cac0b0 (patch)
tree4bc51b92f6149e28425ad590ba87ea72cfa3a586 /README.md
parentMerge branch 'cdn' (diff)
downloadserver-71eeb8df01442f8068d7ad2ec582057351cac0b0.tar.xz
:sparkles: cdn
Diffstat (limited to 'README.md')
-rw-r--r--README.md89
1 files changed, 0 insertions, 89 deletions
diff --git a/README.md b/README.md
deleted file mode 100644

index 6cd6186a..00000000 --- a/README.md +++ /dev/null
@@ -1,89 +0,0 @@ -# Fosscord-CDN -CDN for Fosscord - -## Run localy: -``` -npm i -node dist/ -``` - -## Endpoints: -### POST `/attachments/<filename>` -``` -Content-Type: form-data - -attachment: File (binary-data) -``` -##### Returns: -``` -{ - "success": boolean, // true - "message": string, // "attachment uploaded" - "id": snowflake, // "794183329158135808" - "filename": string // "lakdoiauej.png" -} -``` -### GET `/attachments/<id>/<filename>` -``` -requests image from database with given <id> and <filename> -``` -##### Returns: -``` -Content-Type: image/<imageType(png,img,gif)> -Image -``` -### DELETE `/attachments/<id>/<filename>` -``` -deletes database entry -``` -##### Returns: -``` -Content-Type: application/json - -{ - "success": true, - "message": "attachment deleted" -} -``` - -<hr> - -_(endpoints for crawler):_ -### POST `/external` - -``` -requests crawling of `og:`metadata and the download of the `og:image` property --------- -Content-Type: application/json - -body: -{"url": URL} // "https://discord.com" -``` -##### Returns: -``` -Content-Type: application/json - -{ - "id": string, // "aHR0cHM6Ly9kaXNjb3JkLmNvbQ==" - "ogTitle": string, // "Discord | Your Place to Talk and Hang Out" - "ogDescription": string, // "Discord is the easiest way to talk over voice, video, and text. Talk, chat, hang out, and stay close with your friends and communities." - "cachedImage": string, // "/external/aHR0cHM6Ly9kaXNjb3JkLmNvbQ==/discord.png" - "ogUrl": string, // "https://discord.com/" - "ogType": string // "website" -} -``` -### GET `/external/<id>/<filename>` -- requests cached crawled image -``` -url-params: - :id // aHR0cHM6Ly9kaXNjb3JkLmNvbQ== - :filename // discord.png -``` -``` -/external/aHR0cHM6Ly9kaXNjb3JkLmNvbQ==/discord.png -``` -##### Returns: -``` -Content-Type: image/<imageType(png,img,gif)> -Image -```