@push.rocks/smartproxy 19.0.0 → 19.2.2

package/readme.hints.md

@@ -4,6 +4,12 @@
 - Package: `@push.rocks/smartproxy` – high-performance proxy supporting HTTP(S), TCP, WebSocket, and ACME integration.
 - Written in TypeScript, compiled output in `dist_ts/`, uses ESM with NodeNext resolution.
 
+## Important: ACME Configuration in v19.0.0
+- **Breaking Change**: ACME configuration must be placed within individual route TLS settings, not at the top level
+- Route-level ACME config is the ONLY way to enable SmartAcme initialization
+- SmartCertManager requires email in route config for certificate acquisition
+- Top-level ACME configuration is ignored in v19.0.0
+
 ## Repository Structure
 - `ts/` – TypeScript source files:
   - `index.ts` exports main modules.
@@ -57,8 +63,32 @@
 - CLI entrypoint (`cli.js`) supports command-line usage (ACME, proxy controls).
 - ACME and certificate handling via `Port80Handler` and `helpers.certificates.ts`.
 
+## ACME/Certificate Configuration Example (v19.0.0)
+```typescript
+const proxy = new SmartProxy({
+  routes: [{
+    name: 'example.com',
+    match: { domains: 'example.com', ports: 443 },
+    action: {
+      type: 'forward',
+      target: { host: 'localhost', port: 8080 },
+      tls: {
+        mode: 'terminate',
+        certificate: 'auto',
+        acme: {  // ACME config MUST be here, not at top level
+          email: 'ssl@example.com',
+          useProduction: false,
+          challengePort: 80
+        }
+      }
+    }
+  }]
+});
+```
+
 ## TODOs / Considerations
 - Ensure import extensions in source match build outputs (`.ts` vs `.js`).
 - Update `plugins.ts` when adding new dependencies.
 - Maintain test coverage for new routing or proxy features.
-- Keep `ts/` and `dist_ts/` in sync after refactors.
+- Keep `ts/` and `dist_ts/` in sync after refactors.
+- Consider implementing top-level ACME config support for backward compatibility

package/readme.md

@@ -134,6 +134,14 @@ import {
 
 // Create a new SmartProxy instance with route-based configuration
 const proxy = new SmartProxy({
+  // Global ACME settings for all routes with certificate: 'auto'
+  acme: {
+    email: 'ssl@example.com',      // Required for Let's Encrypt
+    useProduction: false,          // Use staging by default
+    renewThresholdDays: 30,        // Renew 30 days before expiry
+    port: 80                       // Port for HTTP-01 challenges
+  },
+  
   // Define all your routing rules in a single array
   routes: [
     // Basic HTTP route - forward traffic from port 80 to internal service
@@ -141,7 +149,7 @@ const proxy = new SmartProxy({
 
     // HTTPS route with TLS termination and automatic certificates
     createHttpsTerminateRoute('secure.example.com', { host: 'localhost', port: 8080 }, {
-      certificate: 'auto'  // Use Let's Encrypt
+      certificate: 'auto'  // Uses global ACME settings
     }),
 
     // HTTPS passthrough for legacy systems
@@ -350,6 +358,66 @@ interface IRouteAction {
 }
 ```
 
+### ACME/Let's Encrypt Configuration
+
+SmartProxy supports automatic certificate provisioning and renewal with Let's Encrypt. ACME can be configured globally or per-route.
+
+#### Global ACME Configuration
+Set default ACME settings for all routes with `certificate: 'auto'`:
+
+```typescript
+const proxy = new SmartProxy({
+  // Global ACME configuration
+  acme: {
+    email: 'ssl@example.com',         // Required - Let's Encrypt account email
+    useProduction: false,             // Use staging (false) or production (true)
+    renewThresholdDays: 30,           // Renew certificates 30 days before expiry
+    port: 80,                         // Port for HTTP-01 challenges
+    certificateStore: './certs',      // Directory to store certificates
+    autoRenew: true,                  // Enable automatic renewal
+    renewCheckIntervalHours: 24       // Check for renewals every 24 hours
+  },
+  
+  routes: [
+    // This route will use the global ACME settings
+    {
+      name: 'website',
+      match: { ports: 443, domains: 'example.com' },
+      action: {
+        type: 'forward',
+        target: { host: 'localhost', port: 8080 },
+        tls: {
+          mode: 'terminate',
+          certificate: 'auto'  // Uses global ACME configuration
+        }
+      }
+    }
+  ]
+});
+```
+
+#### Route-Specific ACME Configuration
+Override global settings for specific routes:
+
+```typescript
+{
+  name: 'api',
+  match: { ports: 443, domains: 'api.example.com' },
+  action: {
+    type: 'forward',
+    target: { host: 'localhost', port: 3000 },
+    tls: {
+      mode: 'terminate',
+      certificate: 'auto',
+      acme: {
+        email: 'api-ssl@example.com',  // Different email for this route
+        useProduction: true,           // Use production while global uses staging
+        renewBeforeDays: 60            // Route-specific renewal threshold
+      }
+    }
+  }
+}
+
 **Forward Action:**
 When `type: 'forward'`, the traffic is forwarded to the specified target:
 ```typescript