Optimizations

Author: Rmlyy

.env

@@ -2,10 +2,10 @@
 PORT=8720
 
 # Application URL (( Don't put the last / ))
-URL=https://yourdomain.com
+URL=http://localhost:8720
 
 # Secret key
-SECRET=verysecretkey
+SECRET=yoursecretkey
 
 # Application Name
 NAME=Uploader v1.0

.gitignore

@@ -1,2 +1,4 @@
 node_modules
-package-lock.json
+uploads
+package-lock.json
+.env

README.md

@@ -1,9 +1,20 @@
-# Uploader v1.0
-
-Simple to use Uploader with Discord Embed, ShareX & Flameshot support.
+# Table of contents
+1. [Introduction](#introduction)
+2. [Features](#features)
+3. [Prerequisites](#prerequisites)
+4. [Installation](#installation)
+5. [Configure ShareX](#configure-sharex)
+6. [Configure Flameshot](#configure-flameshot)
+7. [Upgrading](#upgrading)
+8. [Demo](#demo)
+9. [Support](#support)
+10. [Donate](#donate)
 ***
 
-## Features:
+## Introduction
+This is a simple to use, configurable & customizable uploader with Discord Embed, ShareX, Flameshot support, and many more [features](#features).
+
+## Features
 * Customizable
 * ShareX Support
 * Flameshot Support
@@ -20,8 +31,8 @@ Simple to use Uploader with Discord Embed, ShareX & Flameshot support.
 * Node.JS v14 recommended or v14+
 * (Optional) a web server
 
-## Installation:
-**NOTE:** The installation guide was written assuming the host OS is Debian 10.
+## Installation
+**NOTE:** The installation guide was written assuming the host OS is Ubuntu 20.04.
 
 1. Clone the repository
 `$ git clone https://github.com/Rmlyy/Uploader.git`
@@ -33,7 +44,7 @@ Simple to use Uploader with Discord Embed, ShareX & Flameshot support.
 4.1 Change URL  
 `URL=https://yourdomain.com` Change the URL to your domain or IP Address. **Don't put the last /**  
 4.2 Change the secret key  
-`SECRET=verysecretkey` It is highly recommended to change the secret key so others can't upload to your server.  
+`SECRET=yoursecretkey` It is highly recommended to change the secret key so others can't upload to your server.  
 5. Run it
 `node app.js`  
 You can use something like `screen` or `pm2` to keep the server running.
@@ -121,17 +132,23 @@ Make sure you have the `proxy_http` module enabled: `a2enmod proxy_http`
     ProxyPass "/"   "http://localhost:8720"
 </VirtualHost>
 ```
-7. Configure ShareX   
-7.1 [Download ShareX example config](https://rmly.dev/uploader/config.sxcu)  
-7.2 Import the config  
-7.3 Change "Request URL" to your domain  
-7.4 Change secret key value to your secret key  
+## Configure ShareX   
+1. [Download the ShareX example config](https://dl.rmly.dev/config.sxcu)  
+2. Import the config  
+3. Change "Request URL" to your domain  
+4. Change secret key value to your secret key  
 
 ## Configure Flameshot
 For Flameshot users on Linux, you can use [this shell script](https://gist.github.com/Rmlyy/3d712dd1d5ed75416746f7657b3819fb).
 
+### Upgrading
+To upgrade, simply replace all the old files and directories (except the uploads directory if you want to keep your uploads) with the new files, and then restart the server.
+
+### Demo
+A live version of this uploader is hosted at [https://i.rmly.dev](https://i.rmly.dev), however, there isn't any possibility to test the upload at the moment, it is best if you try it on your own.
+
 ## Support
-Need help? Feel free to join [my discord server](https://discord.rmly.dev) or [email me](mailto:rmly@rmly.dev).
+Need help? Feel free to join [my discord server](https://discord.rmly.dev) or [email me](mailto:hello@rmly.dev).
 
 ## Donate
 You can donate [here](https://rmly.dev/donate) to support this project. Thanks!

env.example

@@ -0,0 +1,35 @@
+# Listening port
+PORT=8720
+
+# Application URL (( Don't put the last / ))
+URL=https://yourdomain.com
+
+# Secret key
+SECRET=yoursecretkey
+
+# Application Name
+NAME=Uploader v1.0
+
+# Application Headers
+IMAGE_HEADER=${name}, ${size}, ${width}x${height}
+TEXT_HEADER=${name}, ${size}, ${words} words
+UNCATEGORIZED_HEADER=${name}, ${size}
+
+# Statistics
+STATISTICS=${total} uploads with a size of ${size}
+
+# Discord Embeds / Twitter Cards
+ ## Image Card
+  IMAGE_CARD_TITLE=${name} (${size}, ${width}x${height})
+  IMAGE_CARD_DESCRIPTION=Uploaded at ${uploadedAt}
+
+  ## Text Card
+   TEXT_CARD_TITLE=${name} (${size}, ${words} words)
+   TEXT_CARD_DESCRIPTION=Uploaded at ${uploadedAt}
+
+  ## Uncategorized Card / Video Card
+   UNCATEGORIZED_CARD_TITLE=${name} ${size}
+   UNCATEGORIZED_CARD_DESCRIPTION=Uploaded at ${uploadedAt}
+
+# Set to random for a random color or enter your preferred color in HEX format
+CARD_COLOR=random

routes/delete.js

@@ -1,35 +1,21 @@
-const express = require('express')
-const router = express.Router()
-
-const fs = require('fs')
+const router = require('express').Router()
 const path = require('path')
+const fs = require('fs')
+const getPath = require('../utils/path')
 
 router.get('/:file', (req, res) => {
     const { file } = req.params
     const { key } = req.query
-    const imagesPath = `${path.dirname(require.main.filename)}/uploads/images/${file}`
-    const textPath = `${path.dirname(require.main.filename)}/uploads/text/${file}`
-    const videosPath = `${path.dirname(require.main.filename)}/uploads/videos/${file}`
-    const uncategorizedPath = `${path.dirname(require.main.filename)}/uploads/uncategorized/${file}`
-    let finalPath
-
-    if (fs.existsSync(imagesPath)) {
-        finalPath = imagesPath
-    } else if (fs.existsSync(textPath)) {
-        finalPath = textPath
-    } else if (fs.existsSync(videosPath)) {
-        finalPath = videosPath
-    } else if (fs.existsSync(uncategorizedPath)) {
-        finalPath = uncategorizedPath
-    } else return res.status(404).render('404')
 
-    const fileData = require(`../uploads/data/${file}.json`)
+    if (getPath(file)) {
+        const fileData = require(`../uploads/data/${file}.json`)
 
-    if (fileData.key === key) {
-        fs.unlinkSync(finalPath)
-        fs.unlinkSync(`${path.dirname(require.main.filename)}/uploads/data/${file}.json`)
-        res.send('File sucessfully deleted.')
-    } else return res.status(401).send('Invalid deletion key.')
+        if (fileData.key === key) {
+            fs.unlinkSync(getPath(file))
+            fs.unlinkSync(`${path.dirname(require.main.filename)}/uploads/data/${file}.json`)
+            res.send('File sucessfully deleted.')
+        } else res.status(401).send('Invalid deletion key.')
+    } else res.status(404).render('404')
 })
 
 module.exports = router

routes/dl.js

@@ -1,29 +1,13 @@
-const express = require('express')
-const router = express.Router()
-
-const fs = require('fs')
-const path = require('path')
+const router = require('express').Router()
+const path = require('../utils/path')
 
 router.get('/:file', (req, res) => {
     const { file } = req.params
-    const imagesPath = `${path.dirname(require.main.filename)}/uploads/images/${file}`
-    const textPath = `${path.dirname(require.main.filename)}/uploads/text/${file}`
-    const videosPath = `${path.dirname(require.main.filename)}/uploads/videos/${file}`
-    const uncategorizedPath = `${path.dirname(require.main.filename)}/uploads/uncategorized/${file}`
-    let finalPath
-
-    if (fs.existsSync(imagesPath)) {
-        finalPath = imagesPath
-    } else if (fs.existsSync(textPath)) {
-        finalPath = textPath
-    } else if (fs.existsSync(videosPath)) {
-        finalPath = videosPath
-    } else if (fs.existsSync(uncategorizedPath)) {
-        finalPath = uncategorizedPath
-    } else return res.status(404).render('404')
 
-    res.set("Content-Disposition", `attachment;filename=${file}`)
-    res.sendFile(finalPath)
+    if (path(file)) {
+        res.set("Content-Disposition", `attachment;filename=${file}`)
+        res.sendFile(path(file))
+    } else res.status(404).render('404')
 })
 
 module.exports = router

routes/index.js

@@ -1,5 +1,4 @@
-const express = require('express')
-const router = express.Router()
+const router = require('express').Router()
 
 const template = require('string-placeholder')
 const totalUploads = require('../utils/totalUploads')

routes/raw.js

@@ -1,28 +1,11 @@
-const express = require('express')
-const router = express.Router()
-
-const fs = require('fs')
-const path = require('path')
+const router = require('express').Router()
+const path = require('../utils/path')
 
 router.get('/:file', (req, res) => {
     const { file } = req.params
-    const imagesPath = `${path.dirname(require.main.filename)}/uploads/images/${file}`
-    const textPath = `${path.dirname(require.main.filename)}/uploads/text/${file}`
-    const videosPath = `${path.dirname(require.main.filename)}/uploads/videos/${file}`
-    const uncategorizedPath = `${path.dirname(require.main.filename)}/uploads/uncategorized/${file}`
-    let finalPath
-
-    if (fs.existsSync(imagesPath)) {
-        finalPath = imagesPath
-    } else if (fs.existsSync(textPath)) {
-        finalPath = textPath
-    } else if (fs.existsSync(videosPath)) {
-        finalPath = videosPath
-    } else if (fs.existsSync(uncategorizedPath)) {
-        finalPath = uncategorizedPath
-    } else return res.status(404).render('404')
 
-    res.sendFile(finalPath)
+    if (path(file)) res.sendFile(path(file))
+    else res.status(404).render('404')
 })
 
 module.exports = router

routes/upload.js

@@ -1,7 +1,6 @@
-const express = require('express')
+const router = require('express').Router()
 const path = require('path')
 const fs = require('fs')
-const router = express.Router()
 
 router.post('/', (req, res) => {
     const { secret, onlyURL } = req.query
@@ -17,7 +16,7 @@ router.post('/', (req, res) => {
 
     const generateString = require('../utils/generateString')
     const fileName = `${generateString(5)}${path.extname(file.name)}`
-    const deletionKey = generateString(32)
+    const deletionKey = generateString(8)
     const date = new Date()
 
     let uploadPath

routes/view.js

@@ -1,5 +1,4 @@
-const express = require('express')
-const router = express.Router()
+const router = require('express').Router()
 
 const fs = require('fs')
 const path = require('path')

utils/path.js

@@ -0,0 +1,19 @@
+const path = require('path')
+const fs = require('fs')
+
+module.exports = function(file) {
+    const imagesPath = `${path.dirname(require.main.filename)}/uploads/images/${file}`
+    const textPath = `${path.dirname(require.main.filename)}/uploads/text/${file}`
+    const videosPath = `${path.dirname(require.main.filename)}/uploads/videos/${file}`
+    const uncategorizedPath = `${path.dirname(require.main.filename)}/uploads/uncategorized/${file}`
+
+    if (fs.existsSync(imagesPath)) {
+        return imagesPath
+    } else if (fs.existsSync(textPath)) {
+        return textPath
+    } else if (fs.existsSync(videosPath)) {
+        return videosPath
+    } else if (fs.existsSync(uncategorizedPath)) {
+        return uncategorizedPath
+    } else return false
+}