add trust proxy option

Author: alexthemaster

README.md

@@ -35,6 +35,7 @@ All options accepted by the `ShareXServer` constructor:
 -   `fileListing` (string | false, default `files`) - Path to file listing of uploads. Set to `false` to disable the listing.
 -   `debug` (boolean, default `false`) - Enable verbose debug logging to the console.
 -   `forceHttps` (boolean, default `false`) - Force HTTPS for return URL (useful when running behind reverse proxy)
+-   `trustProxy` (boolean, default `false`) - Sets Express trust proxy to true; Useful for getting your X-Forwarded-For IP from reverse proxy when running with debug enabled; Also enables forceHttps if not explicitly set to a boolean
 
 ## 🗒️ Usage notes:
 
@@ -48,7 +49,7 @@ All options accepted by the `ShareXServer` constructor:
 -   Endpoint: `POST /api/upload` (multipart form, field name `file`).
 -   Auth: include header `x-password: <your-password>`.
 -   Success response: JSON containing a `url` pointing to the uploaded file.
-- Error response: JSON containing an `error` property with status code 400 for missing file and 401 for missing/incorrect password.
+-   Error response: JSON containing an `error` property with status code 400 for missing file and 401 for missing/incorrect password.
 
 Example (PowerShell / pwsh):
 
@@ -81,7 +82,7 @@ curl -X POST "http://localhost:8080/api/upload" \
     -   Purpose: When `enableSxcu` is `true`, will return a .sxcu file to be used with ShareX.
 
 > **Note:** All endpoints take the configured `baseUrl` into account.  
-> This means that every URL, will be prefixed with the `baseUrl` you have configured. (example: `GET /baseUrl/files`)
+> This means that every URL will be prefixed with the `baseUrl` you have configured. (example: `GET /baseUrl/files`)
 
 ---
 
@@ -90,9 +91,4 @@ curl -X POST "http://localhost:8080/api/upload" \
 -   Filenames are generated as: `${nanoid(this.filenameLength)}.{ext}` where `ext` is the uploaded file's original extension.
 -   A collision safeguard checks whether a file with the generated name already exists and regenerates once if necessary. The probability of collision is [extremely low](https://zelark.github.io/nano-id-cc/) with `nanoid`.
 
-
 ---
-
-## 📌 Documentation notice
-
-This README was produced with the assistance of an AI.

docker/Dockerfile

@@ -19,8 +19,9 @@ ENV BASE_URL=/
 ENV SAVE_PATH=/uploads
 ENV FILENAME_LENGTH=10
 ENV ENABLE_SXCU=TRUE
+ENV TRUST_PROXY=TRUE
 ENV DEBUG=FALSE
-ENV FORCE_HTTPS=FALSE
+ENV FORCE_HTTPS=
 ENV FILE_LISTING=/files
 
 CMD ["node", "index.js"]

docker/README.md

@@ -57,9 +57,15 @@ The ShareX Server Docker image can be configured via the following environment v
 -   **FORCE_HTTPS**
 
     -   Description: Force HTTPS in return URL (useful when running behind reverse proxy)
-    -   Default: `false`
+    -   Default: ` `
     -   Example: `FORCE_HTTPS=true`
 
+-   **TRUST_PROXY**
+
+    -   Description: Sets Express trust proxy to true; Useful for getting your X-Forwarded-For IP from reverse proxy when running with debug enabled; Also enables forceHttps if not explicitly set to a boolean
+    -   Default: `false`
+    -   Example: `TRUST_PROXY=true`
+
 -   **DEBUG**
 
     -   Description: Enables debug logging. Set to `true` to log detailed server activity.

docker/index.js

@@ -7,7 +7,11 @@ new ShareXServer({
     port: process.env.PORT,
     fileLength: process.env.LENGTH,
     enableSxcu: JSON.parse(process.env.ENABLE_SXCU.toLowerCase()) ?? true,
-    forceHttps: JSON.parse(process.env.FORCE_HTTPS.toLowerCase()) ?? false,
-    fileListing: process.env.FILE_LISTING.toLowerCase() == "false" ? false : process.env.FILE_LISTING,
+    forceHttps: JSON.parse(process.env.FORCE_HTTPS.toLowerCase()) ?? null,
+    trustProxy: JSON.parse(process.env.TRUST_PROXY.toLowerCase()) ?? false,
+    fileListing:
+        process.env.FILE_LISTING.toLowerCase() == "false"
+            ? false
+            : process.env.FILE_LISTING,
     debug: JSON.parse(process.env.DEBUG.toLowerCase()) ?? false,
 });

package.json

@@ -1,6 +1,6 @@
 {
     "name": "sharex-server",
-    "version": "2.2.0",
+    "version": "2.3.0",
     "description": "ShareX image and file hosting using Node.js",
     "main": "dist/index.js",
     "scripts": {

src/index.ts

@@ -29,6 +29,7 @@ export class ShareXServer {
         fileListing = "files",
         debug = false,
         forceHttps = false,
+        trustProxy,
     }: SharexServerOptions) {
         this.port = port;
         // Ensure baseUrl starts and ends with /
@@ -46,6 +47,14 @@ export class ShareXServer {
                 : fileListing
             : false;
 
+        if (trustProxy) {
+            if (this.forceHttps !== true && this.forceHttps !== false) {
+                this.forceHttps = true;
+            }
+
+            this.#server.set("trust proxy", true);
+        }
+
         if (!password) {
             console.error(
                 "[Error] A password must be provided to start the server."
@@ -293,4 +302,11 @@ export interface SharexServerOptions {
     debug?: boolean;
     /** Force HTTPS in return URL (useful when running behind reverse proxy) */
     forceHttps?: boolean;
+    /** Sets Express trust proxy to true
+     *
+     * Useful for getting your X-Forwarded-For IP from reverse proxy
+     *
+     * Also enables forceHttps if not explicitly set to a boolean
+     */
+    trustProxy?: boolean;
 }