dynamic-self-register-proxy 1.0.12 → 1.0.15

package/README.md

@@ -38,7 +38,18 @@ dynamic-proxy
 npm start
 ```
 
-Le proxy démarre par défaut sur le port `3000`. Pour changer le port :
+Le proxy démarre par défaut sur le port `3000`.
+
+### Configuration via fichier .env
+
+Créez un fichier `.env` à la racine du projet (voir `.env.example`) :
+
+```env
+PROXY_NAME=Mon Proxy Dev
+PROXY_PORT=3000
+```
+
+### Configuration via variables d'environnement
 
 ```bash
 # Windows PowerShell
@@ -79,6 +90,8 @@ http://localhost:3000/myapp/  →  votre application sur le port 4000
 
 L'URL racine `/` affiche une page listant tous les serveurs enregistrés avec des liens pour y accéder.
 
+Le nom du proxy (configurable via `PROXY_NAME`) est affiché dans le titre et l'en-tête de la page.
+
 - **Navigateurs** (`Accept: text/html`) → Page HTML avec interface moderne
 - **Clients API** (`Accept: application/json`) → Réponse JSON
 
@@ -92,6 +105,7 @@ curl -H "Accept: application/json" http://localhost:3000/
 **Réponse JSON :**
 ```json
 {
+  "name": "Proxy Server",
   "status": "healthy",
   "uptime": 3600,
   "count": 2,
@@ -207,6 +221,7 @@ Vérifie l'état du proxy.
 **Response:**
 ```json
 {
+  "name": "Proxy Server",
   "status": "healthy",
   "uptime": 3600,
   "registeredRoutes": 2,
@@ -421,6 +436,7 @@ Dans votre fichier de configuration Claude Desktop (`claude_desktop_config.json`
       "command": "npx",
       "args": ["dynamic-self-register-proxy"],
       "env": {
+        "PROXY_NAME": "MCP Gateway",
         "PROXY_PORT": "8080",
         "HEALTH_CHECK_INTERVAL": "60000",
         "HEALTH_CHECK_TIMEOUT": "10000",
@@ -433,12 +449,22 @@ Dans votre fichier de configuration Claude Desktop (`claude_desktop_config.json`
 
 ## Configuration
 
+Le proxy charge automatiquement le fichier `.env` s'il existe (voir `.env.example` pour un template).
+
+### Variables du proxy
+
 | Variable | Défaut | Description |
 |----------|--------|-------------|
+| `PROXY_NAME` | `Proxy Server` | Nom affiché sur la page d'accueil |
 | `PROXY_PORT` | `3000` | Port d'écoute du proxy |
 | `HEALTH_CHECK_INTERVAL` | `30000` | Intervalle du health check polling (ms) |
 | `HEALTH_CHECK_TIMEOUT` | `5000` | Timeout pour chaque health check (ms) |
 | `HEALTH_CHECK_GRACE_PERIOD` | `60000` | Période de grâce pour les nouveaux serveurs (ms) |
+
+### Variables pour les applications clientes
+
+| Variable | Défaut | Description |
+|----------|--------|-------------|
 | `PROXY_URL` | `http://localhost:3000` | URL du proxy (pour les apps) |
 | `APP_PATH` | `/example` | Chemin de l'application |
 | `APP_NAME` | `Example App` | Nom de l'application |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dynamic-self-register-proxy",
-  "version": "1.0.12",
+  "version": "1.0.15",
   "description": "Dynamic reverse proxy with self-registration API - applications can register themselves and receive an automatically assigned port",
   "main": "proxy-client.js",
   "bin": {
@@ -53,6 +53,7 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
+    "dotenv": "^17.2.3",
     "express": "^5.2.1",
     "http-proxy-middleware": "^3.0.5"
   }

package/proxy-client.js

@@ -1,144 +1,144 @@
-/**
- * ProxyClient - Helper pour s'enregistrer auprès du Dynamic Proxy
- * 
- * Usage:
- *   const ProxyClient = require('./proxy-client');
- *   const proxy = new ProxyClient('http://localhost:3000');
- *   const { port } = await proxy.register('/myapp', 'My App');
- *   app.listen(port);
- */
-
-class ProxyClient {
-  /**
-   * @param {string} proxyUrl - URL du proxy (ex: 'http://localhost:3000')
-   */
-  constructor(proxyUrl = 'http://localhost:3000') {
-    this.proxyUrl = proxyUrl;
-    this.registeredPath = null;
-    this.assignedPort = null;
-  }
-
-  /**
-   * Enregistre une route auprès du proxy
-   * @param {string} path - Chemin URL (ex: '/myapp')
-   * @param {string} [name] - Nom de l'application
-   * @param {number} [port] - Port spécifique (optionnel, sinon auto-attribué)
-   * @returns {Promise<{success: boolean, path: string, port: number, name: string}>}
-   */
-  async register(path, name, port) {
-    const body = { path, name };
-    if (port) body.port = port;
-
-    const response = await fetch(`${this.proxyUrl}/proxy/register`, {
-      method: 'POST',
-      headers: { 'Content-Type': 'application/json' },
-      body: JSON.stringify(body)
-    });
-
-    const data = await response.json();
-
-    if (!response.ok) {
-      throw new Error(data.error || 'Registration failed');
-    }
-
-    this.registeredPath = data.path;
-    this.assignedPort = data.port;
-
-    return data;
-  }
-
-  /**
-   * Supprime l'enregistrement de cette application
-   * @returns {Promise<{success: boolean, path: string, freedPort: number}>}
-   */
-  async unregister() {
-    if (!this.registeredPath) {
-      return { success: false, error: 'Not registered' };
-    }
-
-    try {
-      const response = await fetch(`${this.proxyUrl}/proxy/unregister`, {
-        method: 'DELETE',
-        headers: { 'Content-Type': 'application/json' },
-        body: JSON.stringify({ path: this.registeredPath })
-      });
-
-      const data = await response.json();
-      
-      if (response.ok) {
-        this.registeredPath = null;
-        this.assignedPort = null;
-      }
-
-      return data;
-    } catch (error) {
-      console.error('Unregister error:', error.message);
-      return { success: false, error: error.message };
-    }
-  }
-
-  /**
-   * Liste toutes les routes enregistrées
-   * @returns {Promise<{count: number, routes: Array, availablePorts: number}>}
-   */
-  async listRoutes() {
-    const response = await fetch(`${this.proxyUrl}/proxy/routes`);
-    return response.json();
-  }
-
-  /**
-   * Vérifie l'état du proxy
-   * @returns {Promise<{status: string, uptime: number, registeredRoutes: number}>}
-   */
-  async health() {
-    const response = await fetch(`${this.proxyUrl}/proxy/health`);
-    return response.json();
-  }
-
-  /**
-   * Configure les handlers pour un arrêt propre
-   * @param {http.Server} server - Instance du serveur HTTP/Express
-   */
-  setupGracefulShutdown(server) {
-    const shutdown = async () => {
-      console.log('Shutting down...');
-      await this.unregister();
-      server.close(() => {
-        console.log('Server closed.');
-        process.exit(0);
-      });
-    };
-
-    process.on('SIGTERM', shutdown);
-    process.on('SIGINT', shutdown);
-  }
-
-  /**
-   * Ajoute la route /proxy/health requise par le proxy pour le health check polling
-   * @param {express.Application} app - Instance de l'application Express
-   * @param {object} [options] - Options de configuration
-   * @param {function} [options.healthCheck] - Fonction personnalisée pour vérifier la santé (doit retourner true/false)
-   */
-  setupHealthRoute(app, options = {}) {
-    app.get('/proxy/health', async (req, res) => {
-      try {
-        // Si une fonction de health check personnalisée est fournie
-        if (options.healthCheck) {
-          const isHealthy = await options.healthCheck();
-          if (isHealthy) {
-            return res.status(200).json({ status: 'healthy' });
-          } else {
-            return res.status(503).json({ status: 'unhealthy' });
-          }
-        }
-        
-        // Par défaut, retourne 200 si le serveur répond
-        res.status(200).json({ status: 'healthy' });
-      } catch (error) {
-        res.status(503).json({ status: 'unhealthy', error: error.message });
-      }
-    });
-  }
-}
-
-module.exports = ProxyClient;
+/**
+ * ProxyClient - Helper pour s'enregistrer auprès du Dynamic Proxy
+ * 
+ * Usage:
+ *   const ProxyClient = require('./proxy-client');
+ *   const proxy = new ProxyClient('http://localhost:3000');
+ *   const { port } = await proxy.register('/myapp', 'My App');
+ *   app.listen(port);
+ */
+
+class ProxyClient {
+  /**
+   * @param {string} proxyUrl - URL du proxy (ex: 'http://localhost:3000')
+   */
+  constructor(proxyUrl = 'http://localhost:3000') {
+    this.proxyUrl = proxyUrl;
+    this.registeredPath = null;
+    this.assignedPort = null;
+  }
+
+  /**
+   * Enregistre une route auprès du proxy
+   * @param {string} path - Chemin URL (ex: '/myapp')
+   * @param {string} [name] - Nom de l'application
+   * @param {number} [port] - Port spécifique (optionnel, sinon auto-attribué)
+   * @returns {Promise<{success: boolean, path: string, port: number, name: string}>}
+   */
+  async register(path, name, port) {
+    const body = { path, name };
+    if (port) body.port = port;
+
+    const response = await fetch(`${this.proxyUrl}/proxy/register`, {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify(body)
+    });
+
+    const data = await response.json();
+
+    if (!response.ok) {
+      throw new Error(data.error || 'Registration failed');
+    }
+
+    this.registeredPath = data.path;
+    this.assignedPort = data.port;
+
+    return data;
+  }
+
+  /**
+   * Supprime l'enregistrement de cette application
+   * @returns {Promise<{success: boolean, path: string, freedPort: number}>}
+   */
+  async unregister() {
+    if (!this.registeredPath) {
+      return { success: false, error: 'Not registered' };
+    }
+
+    try {
+      const response = await fetch(`${this.proxyUrl}/proxy/unregister`, {
+        method: 'DELETE',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify({ path: this.registeredPath })
+      });
+
+      const data = await response.json();
+      
+      if (response.ok) {
+        this.registeredPath = null;
+        this.assignedPort = null;
+      }
+
+      return data;
+    } catch (error) {
+      console.error('Unregister error:', error.message);
+      return { success: false, error: error.message };
+    }
+  }
+
+  /**
+   * Liste toutes les routes enregistrées
+   * @returns {Promise<{count: number, routes: Array, availablePorts: number}>}
+   */
+  async listRoutes() {
+    const response = await fetch(`${this.proxyUrl}/proxy/routes`);
+    return response.json();
+  }
+
+  /**
+   * Vérifie l'état du proxy
+   * @returns {Promise<{status: string, uptime: number, registeredRoutes: number}>}
+   */
+  async health() {
+    const response = await fetch(`${this.proxyUrl}/proxy/health`);
+    return response.json();
+  }
+
+  /**
+   * Configure les handlers pour un arrêt propre
+   * @param {http.Server} server - Instance du serveur HTTP/Express
+   */
+  setupGracefulShutdown(server) {
+    const shutdown = async () => {
+      console.log('Shutting down...');
+      await this.unregister();
+      server.close(() => {
+        console.log('Server closed.');
+        process.exit(0);
+      });
+    };
+
+    process.on('SIGTERM', shutdown);
+    process.on('SIGINT', shutdown);
+  }
+
+  /**
+   * Ajoute la route /proxy/health requise par le proxy pour le health check polling
+   * @param {express.Application} app - Instance de l'application Express
+   * @param {object} [options] - Options de configuration
+   * @param {function} [options.healthCheck] - Fonction personnalisée pour vérifier la santé (doit retourner true/false)
+   */
+  setupHealthRoute(app, options = {}) {
+    app.get('/proxy/health', async (req, res) => {
+      try {
+        // Si une fonction de health check personnalisée est fournie
+        if (options.healthCheck) {
+          const isHealthy = await options.healthCheck();
+          if (isHealthy) {
+            return res.status(200).json({ status: 'healthy' });
+          } else {
+            return res.status(503).json({ status: 'unhealthy' });
+          }
+        }
+        
+        // Par défaut, retourne 200 si le serveur répond
+        res.status(200).json({ status: 'healthy' });
+      } catch (error) {
+        res.status(503).json({ status: 'unhealthy', error: error.message });
+      }
+    });
+  }
+}
+
+module.exports = ProxyClient;