feat: sudo requirement non root user & improve installation error handling (#589)

Author: zhravan

README.md

@@ -69,7 +69,7 @@ You can customize your installation by providing the following optional paramete
 Example with optional parameters:
 
 ```bash
-nixopus install \
+sudo nixopus install \
   --api-domain nixopusapi.example.tld \
   --view-domain nixopus.example.tld \
   --verbose \
@@ -79,11 +79,14 @@ nixopus install \
 Example for custom ip setup:
 
 ```bash
-nixopus install \
+sudo nixopus install \
   --host-ip 10.0.0.154 \
   --verbose
 ```
 
+> [!NOTE]  
+> Running `nixopus install` requires root privileges (sudo) to install system dependencies like Docker. If you encounter permission errors, make sure to run the command with `sudo`.
+
 You can also install the CLI and run `nixopus install` with options in a single command, refer [installation documentation](https://docs.nixopus.com/install/#installation-options) for more details on options
 
 ## About the Name

cli/app/commands/install/deps.py

@@ -64,7 +64,12 @@ def install_dep(dep, package_manager, logger, dry_run=False):
             if dry_run:
                 logger.info(f"[DRY RUN] Would run: {install_command}")
                 return True
-            subprocess.check_call(install_command, shell=True)
+            result = subprocess.run(install_command, shell=True, capture_output=True, text=True)
+            if result.returncode != 0:
+                error_output = result.stderr.strip() or result.stdout.strip()
+                if error_output:
+                    logger.error(f"Installation command output: {error_output}")
+                raise subprocess.CalledProcessError(result.returncode, install_command, result.stdout, result.stderr)
             return True
         if package_manager == "apt":
             cmd = ["sudo", "apt-get", "install", "-y", package]
@@ -86,6 +91,15 @@ def install_dep(dep, package_manager, logger, dry_run=False):
             return True
         subprocess.check_call(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
         return True
+    except subprocess.CalledProcessError as e:
+        error_msg = str(e)
+        if "docker" in package.lower() and (e.returncode == 100 or "permission" in error_msg.lower()):
+            logger.error(failed_to_install.format(dep=package, error=f"Exit code {e.returncode}"))
+            logger.error("Docker installation requires root privileges.")
+            logger.error("Please run: sudo nixopus install")
+        else:
+            logger.error(failed_to_install.format(dep=package, error=e))
+        return False
     except Exception as e:
         logger.error(failed_to_install.format(dep=package, error=e))
         return False

cli/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "nixopus"
-version = "0.1.27"
+version = "0.1.28"
 description = "A CLI for Nixopus"
 authors = ["Nixopus <[email protected]>"]
 readme = "README.md"

docs/cli/installation.md

@@ -190,11 +190,11 @@ Once the CLI is installed, you can use it to install Nixopus on your VPS:
 ::: code-group
 
 ```bash [Basic Installation]
-nixopus install
+sudo nixopus install
 ```
 
 ```bash [With Custom Domains]
-nixopus install \
+sudo nixopus install \
   --api-domain api.example.com \
   --view-domain app.example.com \
   --verbose
@@ -205,11 +205,15 @@ nixopus preflight
 ```
 
 ```bash [Install Dependencies Only]
-nixopus install deps
+sudo nixopus install deps
 ```
 
 :::
 
+::: warning Root Privileges Required
+The `nixopus install` command requires root privileges to install system dependencies like Docker. Always use `sudo` unless you're already running as root. If you encounter permission errors or "exit status 100", ensure you're using sudo.
+:::
+
 ::: tip Preflight Check
 Always run `nixopus preflight` before installation to verify your system meets all requirements. This can save time by catching issues early.
 :::

docs/install/index.md

@@ -61,9 +61,13 @@ curl -sSL https://install.nixopus.com | bash -s -- --skip-nixopus-install
 Once the CLI is installed, you can install Nixopus on your VPS:
 
 ```bash
-nixopus install
+sudo nixopus install
 ```
 
+::: warning Sudo Required
+Running `nixopus install` requires root privileges to install system dependencies (like Docker). Always use `sudo` when running the install command. If you encounter "exit status 100" or permission errors, ensure you're using sudo.
+:::
+
 ::: info CLI Verification
 Before proceeding, verify the CLI is working:
 ```bash
@@ -251,27 +255,37 @@ If you've already installed the CLI separately, you can run `nixopus install` di
 ::: code-group
 
 ```bash [With Domains]
-nixopus install \
+sudo nixopus install \
   --api-domain api.example.com \
   --view-domain example.com \
   --verbose
 ```
 
 ```bash [With IP]
-nixopus install \
+sudo nixopus install \
   --host-ip 192.168.1.100 \
   --verbose
 ```
 
 ```bash [Custom Ports]
-nixopus install \
+sudo nixopus install \
   --api-port 9000 \
   --view-port 9001 \
   --timeout 600
 ```
 
 :::
 
+::: tip Why Sudo?
+The `nixopus install` command needs root privileges to:
+
+- Install Docker and other system dependencies
+- Configure system-level services
+- Set up network configurations
+
+If you're already running as root user, you can omit `sudo`.
+:::
+
 ## Accessing Nixopus
 
 After successful installation, access your Nixopus instance: