xynginc 1.0.82 → 1.0.83

package/README.md

@@ -4,13 +4,19 @@ This project uses code developed by NEHONIX (www.nehonix.com) under the NEHONIX
 
 XyPriss Nginx Controller - Simplifie la gestion de Nginx et SSL.
 
-[![npm version](https://badge.fury.io/js/%40xypriss%2Fxynginc.svg)](https://www.npmjs.com/package/xynginc)
+[![xfpm version](https://badge.fury.io/js/%40xypriss%2Fxynginc.svg)](https://www.npmjs.com/package/xynginc)
 [![License: NOSL](https://img.shields.io/badge/License-NOSL-blue.svg)](https://dll.nehonix.com/licenses/NOSL)
 
 ## Overview
 
 XyNginC (XyPriss Nginx Controller) automates Nginx reverse proxy configuration, SSL certificate management, and provides optimized, production-ready configs for security, performance, and best practices. It eliminates manual Nginx editing, simplifying XyPriss deployment to just a few lines of TypeScript. Check out the [demo project on GitHub](https://github.com/iDevo-ll/XYNC-Demo).
 
+> [!IMPORTANT]
+> XyNginC is a plugin **exclusively designed for XyPriss projects**. It is not intended for use outside the XyPriss ecosystem, in development environments, or on non-Linux systems. For the best integration experience, **XFPM** (XyPriss Fast Package Manager) is required — see [Installation](#installation).
+
+> [!CAUTION]
+> XyNginC only runs on **Linux production servers** (VPS or Dedicated). Supported architectures: **x64**, **arm64**, and **ia32**. Windows and macOS are not supported.
+
 ## Key Features
 
 - **Automated Reverse Proxy**: Maps domains to local ports seamlessly.
@@ -26,7 +32,28 @@ XyNginC (XyPriss Nginx Controller) automates Nginx reverse proxy configuration,
 For detailed installation instructions, please refer to the [Installation Guide](docs/INSTALLATION.md).
 For building from source (custom architectures), see the [Build Guide](docs/BUILD_FROM_SOURCE.md).
 
-XyNginC is designed for production environments running on Linux. We strongly recommend using Ubuntu on a Virtual Private Server (VPS) for the best security and stability.
+XyNginC is exclusively designed for **XyPriss projects running in production on Linux**. We strongly recommend using Ubuntu on a Virtual Private Server (VPS) for the best security and stability.
+
+### Prerequisites
+
+Before installing XyNginC, you need **XFPM** — the official package manager for the XyPriss ecosystem.
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/Nehonix-Team/XFPM/master/scripts/install.sh | sudo bash
+```
+
+```bash
+xfpm --version
+```
+
+### Install XyNginC
+
+```bash
+xfpm install xynginc
+```
+
+> [!NOTE]
+> The installation requires `sudo` privileges to place the binary in `/usr/local/bin` and configure system permissions.
 
 ## Quick Start
 
@@ -92,7 +119,7 @@ XNCP({
 Manage domains programmatically at runtime:
 
 ```typescript
-app.start(undefined, async () => {
+app.start(async () => {
   // Add a new domain
   await app.xynginc.addDomain(
     "new.example.com",
@@ -181,7 +208,7 @@ await server.xynginc.status(): Promise<string>
 
 ## CLI Usage
 
-The `xynginc` command-line interface allows for direct management without the Node.js application context.
+The `xynginc` command-line interface allows for direct management without the XyPriss application context.
 
 ```bash
 # Check prerequisites
@@ -230,9 +257,9 @@ sudo xynginc status
 
 The system operates through a three-tier architecture:
 
-1.  **XyPriss Application**: The Node.js application running the server.
-2.  **XyNginC Plugin**: A TypeScript wrapper that interfaces with the application and executes the underlying Go binary.
-3.  **XyNginC Go Binary**: A high-performance Go-based CLI tool that performs system-level operations (Nginx configuration, Certbot execution). It dynamically fetches the latest config templates from GitHub (`Nehonix-Team/xynginc`) to guarantee up-to-date and optimized Nginx setups.
+1. **XyPriss Application**: The XyPriss application running the server.
+2. **XyNginC Plugin**: A TypeScript wrapper that interfaces with the application and executes the underlying Go binary.
+3. **XyNginC Go Binary**: A high-performance Go-based CLI tool that performs system-level operations (Nginx configuration, Certbot execution). It dynamically fetches the latest config templates from GitHub (`Nehonix-Team/xynginc`) to guarantee up-to-date and optimized Nginx setups.
 
 ## Security Considerations
 
@@ -243,7 +270,8 @@ XyNginC requires elevated privileges to perform the following actions:
 - Executing `certbot` for SSL certificate generation
 - Reloading the Nginx service
 
-**Security Note**: XyNginC requires elevated privileges to manage Nginx and Firewall rules.
+> [!WARNING]
+> XyNginC requires elevated privileges to manage Nginx and firewall rules. Always review the commands being executed and restrict sudo access to only what is necessary.
 
 - **Sudoers**: We recommend configuring `sudoers` to allow specific commands for the user.
 - **Sudo Password**: If your application runs in the background (e.g. using PM2), you can use the `sudoPassword` option or the `SUDO_PASSWORD` environment variable.
@@ -257,8 +285,8 @@ XyNginC requires elevated privileges to perform the following actions:
 If the binary fails to download automatically:
 
 ```bash
-# Manually trigger postinstall
-npm run postinstall
+# Manually trigger with XFPM
+xfpm run postinstall
 
 # Or specify the path manually in options
 XNCP({
@@ -280,21 +308,25 @@ sudo node server.js
 
 If SSL generation fails:
 
-1.  Verify DNS propagation: `dig api.example.com`
-2.  Ensure firewall allows traffic on ports 80 and 443:
-    ```bash
-    sudo ufw allow 80
-    sudo ufw allow 443
-    ```
+1. Verify DNS propagation: `dig api.example.com`
+2. Ensure firewall allows traffic on ports 80 and 443:
+
+```bash
+sudo ufw allow 80
+sudo ufw allow 443
+```
+
+> [!NOTE]
+> Certbot requires ports 80 and 443 to be publicly accessible for domain validation. Make sure your cloud provider's security groups also allow this traffic, not just UFW.
 
 ## Contributing
 
 Contributions are welcome. Please follow the standard pull request process.
 
-1.  Clone the repository
-2.  Install dependencies
-3.  Build the Go CLI and TypeScript package (`xfpm run build:all`)
-4.  Run tests
+1. Clone the repository
+2. Install dependencies
+3. Build the Go CLI and TypeScript package (`xfpm run build:all`)
+4. Run tests
 
 ## License
 

package/dist/index.d.ts

@@ -1,4 +1,7 @@
+import { Plugin } from "xypriss";
 import { XyNginCConfig, XyNginCDomainConfig, XyNginCPluginOptions } from "./types";
+export type PlC = Parameters<typeof Plugin.create>[0];
+export type PluginServer = Parameters<NonNullable<PlC["onServerStart"]>>[0];
 /**
  * XyNginC Plugin for XyPriss.
  * Automates Nginx and SSL management for your server.

package/dist/index.js

@@ -4,8 +4,8 @@
  * Licensed under NEHONIX Open Source License (NOSL) v1.0
  */
 import { Plugin } from "xypriss";
-import { Logger } from "./logger";
-import { validateConfig } from "./validateConfig";
+import { Logger } from "./mods/logger";
+import { validateConfig } from "./mods/validateConfig";
 import { startXNCPlugin } from "./startPlugin";
 /**
  * XyNginC Plugin for XyPriss.
@@ -16,11 +16,11 @@ import { startXNCPlugin } from "./startPlugin";
  */
 export default function XNCP(options) {
     const { domains, autoReload = true, autoFixFirewall = false, binaryPath, autoDownload = true, version = "latest", installRequirements = true, sudoPassword, } = options;
-    const meta = Plugin.manifest(__sys__);
+    const pkg = Plugin.manifest(__sys__);
     return Plugin.create({
-        name: meta.name,
-        version: meta.version,
-        description: meta.description,
+        name: pkg.name,
+        version: pkg.version,
+        description: pkg.description,
         onRegister: async (_server) => {
             Logger.info("[XyNginC] Registering plugin...");
             validateConfig({ domains, autoReload, autoFixFirewall });

package/dist/{requirements.d.ts → mods/requirements.d.ts}

@@ -1,4 +1,4 @@
-import { XyNginCDomainConfig } from "./types";
+import { XyNginCDomainConfig } from "../types";
 /**
  * Installs system requirements using the binary in interactive mode.
  *

package/dist/{validateConfig.d.ts → mods/validateConfig.d.ts}

@@ -1,4 +1,4 @@
-import { XyNginCConfig } from "./types";
+import { XyNginCConfig } from "../types";
 /**
  * Validates the plugin configuration.
  *

package/dist/startPlugin.d.ts

@@ -1,5 +1,6 @@
+import { PluginServer } from ".";
 import { XyNginCDomainConfig } from "./types";
-export declare function startXNCPlugin(server: any, options: {
+export declare function startXNCPlugin(server: PluginServer, options: {
     binaryPath?: string;
     autoDownload: boolean;
     version: string;

package/dist/startPlugin.js

@@ -1,9 +1,9 @@
-import { ensureBinary } from "./ensureBinary";
-import { Logger } from "./logger";
-import { addDomain, applyConfig, checkRequirements, getStatus, installRequirementsHandler, listDomains, reloadNginx, removeDomain, testNginx, } from "./requirements";
+import { ensureBinary } from "./mods/ensureBinary";
+import { Logger } from "./mods/logger";
+import { addDomain, applyConfig, checkRequirements, getStatus, installRequirementsHandler, listDomains, reloadNginx, removeDomain, testNginx, } from "./mods/requirements";
 const getSudo = (sudoPassword) => {
     // Attempt multiple ways to get the password, including XyPriss internal env if somehow exposed
-    const envPwd = process.env.SUDO_PASSWORD;
+    const envPwd = __sys__.__env__.get("SUDO_PASSWORD");
     // || (global as any).__sys__?.$env?.("SUDO_PASSWORD");
     const pwd = sudoPassword || envPwd;
     if (pwd) {
@@ -23,6 +23,10 @@ const getSudo = (sudoPassword) => {
 export async function startXNCPlugin(server, options) {
     const { binaryPath, autoDownload, version, domains, autoReload, autoFixFirewall, installRequirements, sudoPassword, } = options;
     Logger.info("[XyNginC] Initializing Nginx Controller...");
+    if (!sudoPassword) {
+        Logger.warn("[XyNginC] To ensure optimal performance and prevent potential issues, it is recommended to provide your system sudo password.");
+        Logger.info("[XyNginC] Security notice: The password is used solely for privileged communication with your operating system. It is never stored, logged, or transmitted externally.");
+    }
     try {
         // 1. Ensure binary exists
         const binary = await ensureBinary(binaryPath, autoDownload, version);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xynginc",
-  "version": "1.0.82",
+  "version": "1.0.83",
   "description": "XyPriss Nginx Controller - Automatic Nginx & SSL management for XyPriss servers",
   "author": "Seth Eleazar - iDevo",
   "license": "NOSL",

package/xypriss.plugin.xsig

@@ -1,11 +1,11 @@
 --- XYPRISS SIGNATURE (G3) ---
-Manifest: xynginc@1.0.82
+Manifest: xynginc@1.0.83
 Min-Engine: 1.0.81
-Fingerprint: sha256:5b4a4e3f77d74918ee049a1f75d696795494b509fc4747bd336f759595d70ae6
+Fingerprint: sha256:2e05c6c4adffc16ce7cc1e172e212f7a0ef1c08545612ce7170d7c96ac36d8f1
 Identity: ed25519:a58b17a3e46302dd3ae5538bc9b8b991c57f4c5fe2e7d8ac41803de818d947f4
 Privileges: XHS.HOOK.HTTP.REQUEST,XHS.HOOK.LIFECYCLE.SERVER_READY
-Expires: 2027-04-28T08:28:51Z
+Expires: 2027-04-28T09:43:22Z
 Revision: sha256:none
 --- BEGIN CRYPTOGRAPHIC PROOF ---
-base64:+YptK2eQ2i9XI3jxC0oHQ/jjUphmWGu9oPH0Gw2BW4dl3GmwEXNMXj42EDQBjrZREGpy0D7FWtnu4Q+ApR19CA==
+base64:htZVWcVTy/7PLFvF+PQf7S5TZttaVNj2cjs292cawK/QC/bz1xDMtURQCH+nKHh3GnMsspmUWtLFPeZolg8yDA==
 --- END XYPRISS SIGNATURE ---