@pdkkid/n8n-nodes-nginx-proxy-manager 1.0.0

package/README.md

@@ -0,0 +1,225 @@
+# Nginx Proxy Manager - N8N Integration
+
+This package provides N8N nodes for interacting with the Nginx Proxy Manager API, allowing you to automate proxy host management, user administration, and system monitoring directly from N8N workflows.
+
+## Features
+
+- **Proxy Host Management**: Create, read, update, and delete proxy hosts
+- **User Management**: Manage users, permissions, and authentication
+- **Settings Management**: Get and update system settings
+- **Health Monitoring**: Check API health status
+- **Reporting**: Get statistics about hosted services
+- **Token Management**: Automatic token handling with refresh support
+
+## Installation
+
+1. Copy this directory to your N8N custom nodes folder:
+   ```bash
+   cp -r n8n-nodes-nginx-proxy-manager ~/.n8n/nodes/
+   ```
+
+2. Rebuild N8N:
+   ```bash
+   npm rebuild
+   ```
+
+3. Restart N8N
+
+## Setup
+
+### 1. Add Credentials
+
+1. In N8N, go to **Credentials**
+2. Click **New** and select **Nginx Proxy Manager API**
+3. Fill in the following:
+   - **API URL**: Your Nginx Proxy Manager API base URL
+   - **Email**: Your NPM login email
+   - **Password**: Your NPM login password
+   - **Access Token** (optional): If you already have a valid token, paste it here to skip credential-based auth
+
+### 2. Use in Workflows
+
+Add the "Nginx Proxy Manager" node to any workflow and select from the available operations.
+
+## Available Operations
+
+### Health
+- **Get Status**: Check if the API is healthy
+
+### Proxy Hosts
+- **Get All**: Retrieve all proxy hosts (supports expansion of related data)
+- **Get**: Retrieve a specific proxy host by ID
+- **Create**: Create a new proxy host
+- **Update**: Update an existing proxy host
+- **Delete**: Delete a proxy host
+
+**Proxy Host Fields:**
+- Domain Names (required)
+- Forward Host (required) - IP or hostname
+- Forward Port (required)
+- Forward Scheme - HTTP or HTTPS
+- SSL Forced
+- Caching Enabled
+- Block Exploits
+- Allow Websocket Upgrade
+- HTTP/2 Support
+- HSTS Enabled
+- HSTS Subdomains
+- Advanced Nginx Config
+
+### Users
+- **Get All**: Retrieve all users (with optional permissions expansion)
+- **Get**: Get a specific user
+- **Create**: Create a new user
+- **Update**: Update user details
+- **Delete**: Delete a user
+- **Update Auth**: Change user password
+- **Update Permissions**: Set user permissions for different resources
+
+**Permission Levels:**
+- `hidden` - User cannot see the resource
+- `view` - User can view but not modify
+- `manage` - User has full control
+
+**Visibility Levels:**
+- `all` - User can see all items
+- `user` - User can only see their own items
+
+### Settings
+- **Get All**: Retrieve all system settings
+- **Get**: Get a specific setting
+- **Update**: Update a setting value
+
+**Common Settings:**
+- `default-site` - What to show for unknown hosts
+
+### Reports
+- **Get Hosts Report**: Get statistics about proxy hosts, redirections, streams, and dead hosts
+
+### Tokens
+- **Get New Token**: Request a new access token from credentials
+- **Refresh Token**: Refresh an existing token
+
+## Examples
+
+### Create a Proxy Host
+
+```json
+{
+  "resource": "proxyHost",
+  "operation": "create",
+  "domainNames": "example.com,www.example.com",
+  "forwardHost": "192.168.1.100",
+  "forwardPort": 8080,
+  "forwardScheme": "http",
+  "enabled": true,
+  "sslForced": false,
+  "blockExploits": true
+}
+```
+
+### Get All Proxy Hosts with Details
+
+```json
+{
+  "resource": "proxyHost",
+  "operation": "getAll",
+  "expand": "owner"
+}
+```
+
+### Create a New User
+
+```json
+{
+  "resource": "user",
+  "operation": "create",
+  "email": "newuser@example.com",
+  "name": "New User",
+  "nickname": "New",
+  "roles": ["user"]
+}
+```
+
+### Update User Permissions
+
+```json
+{
+  "resource": "user",
+  "operation": "updatePermissions",
+  "userId": 2,
+  "visibility": "all",
+  "proxyHostsPermission": "manage"
+}
+```
+
+### Check System Health
+
+```json
+{
+  "resource": "health",
+  "operation": "getStatus"
+}
+```
+
+### Get Statistics
+
+```json
+{
+  "resource": "report",
+  "operation": "getHostsReport"
+}
+```
+
+## API Expansion Options
+
+Some operations support expanding related data:
+
+- `access_list` - Include access list information
+- `owner` - Include owner/user information
+- `certificate` - Include SSL certificate information
+- `permissions` - Include user permission details
+
+## Error Handling
+
+The nodes will return detailed error messages from the API. Common errors include:
+
+- **401 Unauthorized**: Invalid credentials or expired token
+- **404 Not Found**: Resource doesn't exist
+- **400 Bad Request**: Invalid parameters
+- **409 Conflict**: Resource conflict (e.g., duplicate domain)
+
+## Rate Limiting
+
+The Nginx Proxy Manager API doesn't have explicit rate limits, but it's recommended to add delays between requests if making bulk operations.
+
+## Troubleshooting
+
+### "No credentials provided"
+Make sure you've added the Nginx Proxy Manager API credentials and selected them in the node.
+
+### "401 Unauthorized"
+Verify your email and password are correct. The token may have expired - try refreshing or re-authenticating.
+
+### "Domain already in use"
+The domain name is already configured for another proxy host. Remove it from the existing host first.
+
+### "Nginx configuration error"
+Check your advanced configuration syntax. Invalid Nginx directives will prevent the host from being enabled.
+
+## Support
+
+For issues with the integration, check:
+- The [Nginx Proxy Manager documentation](https://nginxproxymanager.com/)
+- The [API Schema](https://github.com/NginxProxyManager/nginx-proxy-manager)
+
+## License
+
+MIT
+
+## Changelog
+
+### v1.0.0
+- Initial release
+- Full support for proxy hosts, users, settings, and tokens
+- Health monitoring and reporting endpoints

package/dist/credentials.d.ts

@@ -0,0 +1,36 @@
+import { ICredentialType } from 'n8n-workflow';
+export declare class NginxProxyManagerApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    properties: ({
+        displayName: string;
+        name: string;
+        type: "string";
+        default: string;
+        required: boolean;
+        description: string;
+        typeOptions?: undefined;
+    } | {
+        displayName: string;
+        name: string;
+        type: "string";
+        typeOptions: {
+            password: boolean;
+        };
+        default: string;
+        required: boolean;
+        description: string;
+    } | {
+        displayName: string;
+        name: string;
+        type: "string";
+        typeOptions: {
+            password: boolean;
+        };
+        default: string;
+        description: string;
+        required?: undefined;
+    })[];
+}
+//# sourceMappingURL=credentials.d.ts.map

package/dist/credentials.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"credentials.d.ts","sourceRoot":"","sources":["../credentials.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,eAAe,EACf,MAAM,cAAc,CAAC;AAEtB,qBAAa,oBAAqB,YAAW,eAAe;IAC3D,IAAI,SAA0B;IAC9B,WAAW,SAA6B;IACxC,gBAAgB,SAA8D;IAC9E,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAsCR;CACF"}

package/dist/credentials.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NginxProxyManagerApi = void 0;
+class NginxProxyManagerApi {
+    constructor() {
+        this.name = 'nginxProxyManagerApi';
+        this.displayName = 'Nginx Proxy Manager API';
+        this.documentationUrl = 'https://github.com/NginxProxyManager/nginx-proxy-manager';
+        this.properties = [
+            {
+                displayName: 'API URL',
+                name: 'apiUrl',
+                type: 'string',
+                default: 'http://proxy.example.com/api',
+                required: true,
+                description: 'The base URL of your Nginx Proxy Manager API (e.g., http://proxy.pdkkid.dev/api)',
+            },
+            {
+                displayName: 'Email',
+                name: 'email',
+                type: 'string',
+                default: '',
+                required: true,
+                description: 'Email address for authentication',
+            },
+            {
+                displayName: 'Password',
+                name: 'password',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                default: '',
+                required: true,
+                description: 'Password for authentication',
+            },
+            {
+                displayName: 'Access Token',
+                name: 'accessToken',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                default: '',
+                description: 'If you already have an access token, you can use it directly (optional)',
+            },
+        ];
+    }
+}
+exports.NginxProxyManagerApi = NginxProxyManagerApi;
+//# sourceMappingURL=credentials.js.map

package/dist/credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"credentials.js","sourceRoot":"","sources":["../credentials.ts"],"names":[],"mappings":";;;AAIA,MAAa,oBAAoB;IAAjC;QACC,SAAI,GAAG,sBAAsB,CAAC;QAC9B,gBAAW,GAAG,yBAAyB,CAAC;QACxC,qBAAgB,GAAG,0DAA0D,CAAC;QAC9E,eAAU,GAAG;YACZ;gBACC,WAAW,EAAE,SAAS;gBACtB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,QAAiB;gBACvB,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,kFAAkF;aAC/F;YACD;gBACC,WAAW,EAAE,OAAO;gBACpB,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,QAAiB;gBACvB,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,kCAAkC;aAC/C;YACD;gBACC,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAiB;gBACvB,WAAW,EAAE;oBACZ,QAAQ,EAAE,IAAI;iBACd;gBACD,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,6BAA6B;aAC1C;YACD;gBACC,WAAW,EAAE,cAAc;gBAC3B,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE,QAAiB;gBACvB,WAAW,EAAE;oBACZ,QAAQ,EAAE,IAAI;iBACd;gBACD,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,yEAAyE;aACtF;SACD,CAAC;IACH,CAAC;CAAA;AA3CD,oDA2CC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import { NginxProxyManager } from './nginxProxyManager';
+import { NginxProxyManagerApi } from './credentials';
+export { NginxProxyManager, NginxProxyManagerApi };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAErD,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,CAAC"}

package/dist/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NginxProxyManagerApi = exports.NginxProxyManager = void 0;
+const nginxProxyManager_1 = require("./nginxProxyManager");
+Object.defineProperty(exports, "NginxProxyManager", { enumerable: true, get: function () { return nginxProxyManager_1.NginxProxyManager; } });
+const credentials_1 = require("./credentials");
+Object.defineProperty(exports, "NginxProxyManagerApi", { enumerable: true, get: function () { return credentials_1.NginxProxyManagerApi; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,2DAAwD;AAG/C,kGAHA,qCAAiB,OAGA;AAF1B,+CAAqD;AAEzB,qGAFnB,kCAAoB,OAEmB"}

package/dist/nginxProxyManager.d.ts

@@ -0,0 +1,14 @@
+import { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class NginxProxyManager implements INodeType {
+    description: INodeTypeDescription;
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+    private handleProxyHost;
+    private buildProxyHostPayload;
+    private handleToken;
+    private handleUser;
+    private buildUserPayload;
+    private handleSetting;
+    private handleReport;
+    private getToken;
+}
+//# sourceMappingURL=nginxProxyManager.d.ts.map

package/dist/nginxProxyManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nginxProxyManager.d.ts","sourceRoot":"","sources":["../nginxProxyManager.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,iBAAiB,EACjB,kBAAkB,EAClB,SAAS,EACT,oBAAoB,EAEpB,MAAM,cAAc,CAAC;AAEtB,qBAAa,iBAAkB,YAAW,SAAS;IAClD,WAAW,EAAE,oBAAoB,CA8qB/B;IAEI,OAAO,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;YAoCzD,eAAe;IAsC7B,OAAO,CAAC,qBAAqB;YAkCf,WAAW;YA2BX,UAAU;IA2DxB,OAAO,CAAC,gBAAgB;YAgBV,aAAa;YAgCb,YAAY;YAiBZ,QAAQ;CAkBtB"}