mwc-proxy 0.0.1 → 0.0.2

package/README.md

@@ -1,10 +1,12 @@
+<div align="center">
+  <img src="logo.png" width="200" alt="mwc-proxy" />
+</div>
+
 # Minecraft Web Client Proxies
 
 This repository contains the **WebSocket proxy** for making Minecraft servers accessible to web clients.
 
----
-
-## MWC proxy (this repo)
+## MWC proxy
 
 - **WebSocket-based Minecraft proxy** — browser clients connect via WebSocket; the proxy forwards to Java Minecraft servers (TCP).
 - **Microsoft/Mojang authentication** — makes it possible to connect to official Minecraft servers!
@@ -14,6 +16,21 @@ This repository contains the **WebSocket proxy** for making Minecraft servers ac
 - **Prometheus metrics** — built-in metrics and optional `express-prom-bundle` middleware.
 - **Callback interface for extensions** — e.g. custom connection routing, connection limits, banned origins.
 
+[Deploy with a single line of command RIGHT NOW](https://github.com/zardoy/minecraft-everywhere)
+
+## Docker Compose Deploy
+
+The recommended way to run an instance is with **Docker Compose**, using the example that includes automatic updates via Watchtower and an optional **env.js** mount for config overrides:
+
+**[docker-compose.example.yml](docker-compose.example.yml)**
+
+Copy it to `docker-compose.yml`, create `env.js` if you want external config (see [config overrides](#config-overrides)), then:
+
+```sh
+docker compose up -d
+```
+
+Images are published to GitHub Container Registry (`ghcr.io/zardoy/mwc-proxy`). The compose file uses a Watchtower service to keep the image updated. The access log is rotated at 100MB and mounted at `./logs` so it is preserved on the host. You can override the entrypoint (e.g. to apply `tc` egress rate limiting) by mounting your own script and setting `entrypoint: ["/bin/sh", "/entrypoint.sh"]`; your script should end with `exec node dist/app.js`.
 
 ## Using this package as NPM library
 
@@ -45,23 +62,14 @@ Environment variables: `PORT`, `URL_ROOT`, `ALLOW_ORIGIN`, `MAX_CONNECTIONS_PER_
 
 ---
 
-## Docker (auto-updated images)
-
-Images are published to GitHub Container Registry and updated on releases.
-
-```sh
-docker pull ghcr.io/zardoy/mwc-proxy:latest
-# or a specific version
-docker pull ghcr.io/zardoy/mwc-proxy:0.1.0
-```
+## Config overrides
 
-Run:
+You can override the proxy API options (deep-merge) in two ways:
 
-```sh
-docker run -p 2344:2344 -e PORT=2344 ghcr.io/zardoy/mwc-proxy
-```
+1. **env.js** — Mount or place `env.js` so the CLI loads it, then set `global.MWC_PROXY_CONFIG_OVERRIDES = { ... }` with any [ProxyMiddlewareOptions](src/api.ts) overrides.
+2. **CONFIG_OVERRIDES_JSON** — Set the env var to a JSON string, e.g. `CONFIG_OVERRIDES_JSON='{"metricsEndpoint":false}'`.
 
-The container exposes port **2344** by default. Override with `PORT` or pass `--port` to the app.
+Useful for toggling metrics endpoint, auth limits, single-server defaults, etc., without changing code.
 
 ---
 

package/dist/app.d.ts

@@ -2,8 +2,8 @@
 /**
  * Standalone CLI / Docker entry point.
  *
- * Reads configuration from environment variables and command-line arguments,
- * then starts the proxy server. No MWC-specific code lives here.
+ * Reads configuration from environment variables, optional env.js (can set global.MWC_PROXY_CONFIG_OVERRIDES),
+ * and CONFIG_OVERRIDES_JSON env var, then starts the proxy server. Options are deep-merged.
  *
  * Supported env vars:
  *   PORT                   — listen port (default 2344, overridden by argv[2])
@@ -15,6 +15,10 @@
  *   SIGNAL_DESCRIPTION     — description forwarded to signal server
  *   SIGNAL_DOMAIN          — domain forwarded to signal server
  *   DISABLE_SIGNAL         — set to 1 or true to disable signal server reporting
+ *   CONFIG_OVERRIDES_JSON  — optional JSON string; deep-merged over createProxyMiddleware options
+ *   LOG_MAX_BYTES         — max access log file size in bytes; when exceeded, log is truncated (default 100MB)
+ *
+ * In env.js you can set global.MWC_PROXY_CONFIG_OVERRIDES (object) for the same deep-merge behavior.
  */
 export {};
 //# sourceMappingURL=app.d.ts.map

package/dist/app.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;;;;;;GAgBG"}
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;;;;;;;;;;GAoBG"}

package/dist/app.js

@@ -3,8 +3,8 @@
 /**
  * Standalone CLI / Docker entry point.
  *
- * Reads configuration from environment variables and command-line arguments,
- * then starts the proxy server. No MWC-specific code lives here.
+ * Reads configuration from environment variables, optional env.js (can set global.MWC_PROXY_CONFIG_OVERRIDES),
+ * and CONFIG_OVERRIDES_JSON env var, then starts the proxy server. Options are deep-merged.
  *
  * Supported env vars:
  *   PORT                   — listen port (default 2344, overridden by argv[2])
@@ -16,6 +16,10 @@
  *   SIGNAL_DESCRIPTION     — description forwarded to signal server
  *   SIGNAL_DOMAIN          — domain forwarded to signal server
  *   DISABLE_SIGNAL         — set to 1 or true to disable signal server reporting
+ *   CONFIG_OVERRIDES_JSON  — optional JSON string; deep-merged over createProxyMiddleware options
+ *   LOG_MAX_BYTES         — max access log file size in bytes; when exceeded, log is truncated (default 100MB)
+ *
+ * In env.js you can set global.MWC_PROXY_CONFIG_OVERRIDES (object) for the same deep-merge behavior.
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
@@ -27,8 +31,48 @@ const fs_1 = __importDefault(require("fs"));
 const express_1 = __importDefault(require("express"));
 const compression_1 = __importDefault(require("compression"));
 const index_1 = require("./index");
-if (fs_1.default.existsSync(path_1.default.join(__dirname, './env.js'))) {
-    require('./env.js');
+function deepMerge(target, source) {
+    const out = { ...target };
+    for (const key of Object.keys(source)) {
+        const s = source[key];
+        if (s === undefined)
+            continue;
+        const t = target[key];
+        if (s !== null &&
+            typeof s === 'object' &&
+            !Array.isArray(s) &&
+            t !== null &&
+            typeof t === 'object' &&
+            !Array.isArray(t)) {
+            ;
+            out[key] = deepMerge(t, s);
+        }
+        else {
+            ;
+            out[key] = s;
+        }
+    }
+    return out;
+}
+function getConfigOverrides() {
+    const fromGlobal = global
+        .MWC_PROXY_CONFIG_OVERRIDES;
+    if (fromGlobal && typeof fromGlobal === 'object')
+        return fromGlobal;
+    const fromEnv = process.env.CONFIG_OVERRIDES_JSON;
+    if (fromEnv) {
+        try {
+            return JSON.parse(fromEnv);
+        }
+        catch {
+            return {};
+        }
+    }
+    return {};
+}
+const envJsPath = path_1.default.join(__dirname, './env.js');
+if (fs_1.default.existsSync(envJsPath)) {
+    require(envJsPath);
 }
 const app = (0, express_1.default)();
 const keyFile = path_1.default.join(__dirname, './key.pem');
@@ -41,7 +85,24 @@ if (fs_1.default.existsSync(keyFile)) {
 app.use((0, compression_1.default)());
 const logsDir = path_1.default.join(__dirname, 'logs');
 fs_1.default.mkdirSync(logsDir, { recursive: true });
-const accessFile = fs_1.default.createWriteStream(path_1.default.join(logsDir, 'access.log'), { flags: 'a' });
+const accessLogPath = path_1.default.join(logsDir, 'access.log');
+const LOG_MAX_BYTES = process.env.LOG_MAX_BYTES ? Number(process.env.LOG_MAX_BYTES) : 100 * 1024 * 1024; // 100MB default
+const accessLog = { stream: fs_1.default.createWriteStream(accessLogPath, { flags: 'a' }) };
+function maybeRotateAccessLog() {
+    if (LOG_MAX_BYTES <= 0)
+        return;
+    try {
+        const stat = fs_1.default.statSync(accessLogPath);
+        if (stat.size > LOG_MAX_BYTES) {
+            accessLog.stream.end();
+            fs_1.default.truncateSync(accessLogPath, 0);
+            accessLog.stream = fs_1.default.createWriteStream(accessLogPath, { flags: 'a' });
+        }
+    }
+    catch (error) {
+        console.error('Error rotating access log:', error);
+    }
+}
 const urlRoot = process.env.URL_ROOT ?? '/api/vm/net';
 const portArg = process.argv.indexOf('--port');
 const port = process.argv[2] && !process.argv[2].startsWith('-')
@@ -49,13 +110,14 @@ const port = process.argv[2] && !process.argv[2].startsWith('-')
     : portArg === -1
         ? process.env.PORT ?? 2344
         : process.argv[portArg + 1];
-app.use((0, index_1.createProxyMiddleware)({
+const baseOptions = {
     allowOrigin: process.env.ALLOW_ORIGIN ?? '*',
     server: httpsServer,
     urlRoot,
     log(line) {
+        maybeRotateAccessLog();
         const ts = new Date().toISOString().replace('T', ' ').split('.')[0];
-        accessFile.write(`[${ts}] ${line}\n`);
+        accessLog.stream.write(`[${ts}] ${line}\n`);
     },
     allowOriginApp: true,
     maxConnectionsPerIp: process.env.MAX_CONNECTIONS_PER_IP ? Number(process.env.MAX_CONNECTIONS_PER_IP) : 5,
@@ -67,7 +129,10 @@ app.use((0, index_1.createProxyMiddleware)({
             domain: process.env.SIGNAL_DOMAIN,
             listenPort: Number(port),
         },
-}));
+};
+const overrides = getConfigOverrides();
+const options = Object.keys(overrides).length > 0 ? deepMerge(baseOptions, overrides) : baseOptions;
+app.use((0, index_1.createProxyMiddleware)(options));
 app.use(express_1.default.static(path_1.default.join(__dirname, './dist')));
 (httpsServer ?? app).listen(port, () => {
     console.log(`Proxy server listening on port ${port}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mwc-proxy",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "license": "MIT",
   "main": "dist/index.js",
   "exports": {