@it-club/provisor 0.2.2 → 0.3.0

package/README.md

@@ -12,6 +12,21 @@ npm install -g @it-club/provisor
 npx @it-club/provisor
 ```
 
+## Interactive Dashboard
+
+Run without arguments to launch the interactive dashboard:
+
+```bash
+provisor
+```
+
+The dashboard provides:
+- **Server Management**: Add, remove, and manage multiple servers
+- **App Management**: View, deploy, and configure applications
+- **Server Diagnostics**: Check Caddy status, firewall, ports, and logs
+- **Caddy Management**: View/edit config, view logs, restart service
+- **SSH Key Management**: Add and list authorized keys
+
 ## Commands
 
 ### `provisor init` - Initialize Server
@@ -63,18 +78,18 @@ provisor app -h <server-ip> -n myapp
    - **Clone from public repo**: Clones HTTPS repository
    - **Clone from private repo**: Generates deploy key, clones SSH repository
 4. Sets up auto-deploy (choose from 3 options):
-   - **Git polling**: Checks for new commits every N seconds (simpler, works everywhere)
-   - **Webhook**: Instant deployment on push (requires repo webhook setup)
+   - **Git polling**: Checks for new commits every N seconds
+   - **Webhook**: Instant deployment on push
    - **Manual only**: Use `provisor deploy` command
-5. Configures Caddy with your choice of TLS (on-demand, specific domain, or none)
+5. Configures Caddy with your choice of TLS
 
-**Deployment Methods:**
+**TLS Options:**
 
-| Method | Best For | Auto-Deploy |
-|--------|----------|-------------|
-| Push-to-deploy | Private repos, full control | Built-in (git hook) |
-| Clone public | Open source projects | Polling or webhook |
-| Clone private | Private GitHub/GitLab repos | Polling or webhook |
+| Option | Description |
+|--------|-------------|
+| On-demand TLS | Auto-generates certificates for any domain pointed at the server |
+| Specific domain(s) | Traditional cert for specified domains |
+| No TLS | HTTP only |
 
 ---
 
@@ -84,71 +99,16 @@ Manually trigger a deployment for an application.
 
 ```bash
 provisor deploy -h <server-ip> -n myapp
-
-# Options
--h, --host <host>   Server hostname or IP (required)
--n, --name <name>   Application name (required)
--u, --user <user>   Username to connect as (default: "deploy")
--k, --key <path>    Path to SSH private key
--p, --port <port>   SSH port (default: "22")
 ```
 
 ---
 
 ### `provisor config` - Manage Configuration
 
-View and manage application configuration, deploy keys, and auto-deploy settings.
+View and manage application configuration.
 
 ```bash
-# Show current configuration
 provisor config -h <server-ip> -n myapp --show
-
-# Options
--h, --host <host>              Server hostname or IP (required)
--n, --name <name>              Application name (required)
--u, --user <user>              Username to connect as (default: "deploy")
--k, --key <path>               Path to SSH private key
--p, --port <port>              SSH port (default: "22")
---show                         Show current configuration
---repo <url>                   Change repository URL
---branch <branch>              Change deploy branch
---new-key                      Generate new deploy key
---delete-key                   Delete deploy key
---webhook-secret <secret>      Update webhook secret
---disable-webhook              Disable webhook
---polling-interval <seconds>   Set git polling interval
---enable-polling               Enable git polling
---disable-polling              Disable git polling
-```
-
-**Examples:**
-
-```bash
-# View configuration and deploy key
-provisor config -h 203.0.113.10 -n myapp --show
-
-# Change polling interval to 30 seconds
-provisor config -h 203.0.113.10 -n myapp --polling-interval 30
-
-# Switch branches
-provisor config -h 203.0.113.10 -n myapp --branch develop
-
-# Disable auto-deploy
-provisor config -h 203.0.113.10 -n myapp --disable-polling
-```
-
----
-
-### `provisor ssh-key` - Manage SSH Keys
-
-Add or list SSH keys on the server.
-
-```bash
-# List keys
-provisor ssh-key -h <server-ip> --list
-
-# Add a key
-provisor ssh-key -h <server-ip> --add "ssh-ed25519 AAAA... user@machine"
 ```
 
 ---
@@ -163,129 +123,68 @@ provisor status -h <server-ip>
 
 ---
 
-## Auto-Deploy Options
-
-### Git Polling (Recommended for simplicity)
-
-Checks your repository for new commits at a configurable interval.
-
-**Pros:**
-- Works behind NAT/firewalls
-- No webhook configuration needed
-- Works in Docker containers
-- Simple and reliable
+### `provisor ssh-key` - Manage SSH Keys
 
-**Cons:**
-- Slight delay (interval-based)
-- Uses minimal bandwidth for git fetch
+Add or list SSH keys on the server.
 
 ```bash
-# View polling status
-provisor config -h server -n app --show
-# Output: Git Polling: Running (every 10s, daemon mode)
-
-# Change interval
-provisor config -h server -n app --polling-interval 60
-
-# View polling logs
-ssh deploy@server "tail -f /var/log/poll-app.log"           # Daemon mode
-ssh deploy@server "journalctl -u poll-app -f"               # Systemd mode
+provisor ssh-key -h <server-ip> --list
+provisor ssh-key -h <server-ip> --add "ssh-ed25519 AAAA..."
 ```
 
-### Webhook (Recommended for instant deploys)
-
-Repository triggers deployment instantly on push.
-
-**Pros:**
-- Instant deployments
-- No polling overhead
-
-**Cons:**
-- Requires firewall port open
-- Requires webhook setup on GitHub/GitLab
-- Doesn't work behind NAT without port forwarding
-
-After setup, configure webhook in your repository:
-- **URL**: `http://your-server:PORT/webhook`
-- **Secret**: Shown after provisioning
-- **Events**: Push events only
-
 ---
 
-## Typical Workflows
-
-### Quick Start: Push-to-Deploy
-
-```bash
-# 1. Initialize server
-provisor init -h 203.0.113.10
-
-# 2. Provision app
-provisor app -h 203.0.113.10 -n myapp
-# Select: Push-to-deploy
-# Select: On-demand TLS
-
-# 3. Add remote to local project
-git remote add production ssh://deploy@203.0.113.10/var/repo/myapp.git
-
-# 4. Deploy
-git push production main
+## System Architecture
+
+```mermaid
+graph TD
+    subgraph "Your Machine"
+        CLI[Provisor CLI]
+        Conf[Local Config<br/>~/.provisor/servers.json]
+    end
+
+    subgraph "Remote Server"
+        Caddy[Caddy Web Server]
+        PM2[PM2 Process Manager]
+        
+        subgraph "App 1"
+            Repo1[Git Repo]
+            Process1[Node Process]
+        end
+    end
+
+    CLI -->|SSH| Caddy
+    CLI -->|SSH| PM2
+    Caddy -->|Reverse Proxy| Process1
+    PM2 -->|Manages| Process1
 ```
 
-### Clone from GitHub with Auto-Deploy
-
-```bash
-# 1. Initialize server  
-provisor init -h 203.0.113.10
-
-# 2. Provision app with repo
-provisor app -h 203.0.113.10 -n myapp -r https://github.com/user/repo.git
-# Select: Git polling (recommended)
-# Select: On-demand TLS
-
-# Done! Polling will auto-deploy on new commits
-```
+---
 
-### Private Repository with Deploy Key
+## On-Demand TLS (Caddy v2.10+)
 
-```bash
-# 1. Initialize server
-provisor init -h 203.0.113.10
+The on-demand TLS option allows automatic certificate provisioning for any domain pointed at your server. Caddy v2.10+ requires a permission endpoint for abuse prevention.
 
-# 2. Provision app
-provisor app -h 203.0.113.10 -n myapp
-# Select: Clone from private repository
-# Enter: git@github.com:user/private-repo.git
+**How it works:**
+- An internal endpoint (`:5555`) acts as a permission check
+- Caddy requests a certificate only after this endpoint approves
+- By default, all domains are approved
 
-# 3. Copy the displayed deploy key to GitHub:
-#    Repo → Settings → Deploy keys → Add deploy key
-
-# 4. Confirm key added, deployment continues
-# Select: Git polling
-# Select: On-demand TLS
-```
+This allows serving multiple domains/subdomains from a single server without pre-configuration.
 
 ---
 
-## Environment Detection
-
-The CLI automatically adapts to different environments:
-
-| Environment | Auto-Deploy Method |
-|-------------|-------------------|
-| Systemd servers (Ubuntu, Debian) | Systemd timer |
-| Docker containers | Background daemon loop |
-| Non-systemd systems | Background daemon loop |
-
----
+## Auto-Deploy Options
 
-## SSH Key Detection
+### Git Polling (Recommended)
+- Checks repository at configurable intervals
+- Works behind NAT/firewalls
+- No webhook setup required
 
-The CLI automatically looks for SSH keys in this order:
-1. `--key` flag if provided
-2. `~/.ssh/id_ed25519`
-3. `~/.ssh/id_rsa`
-4. `~/.ssh/id_ecdsa`
+### Webhook
+- Instant deployment on push
+- Requires firewall port open
+- Requires webhook configuration in your repository
 
 ---
 
@@ -295,12 +194,9 @@ The CLI automatically looks for SSH keys in this order:
 |------|---------|
 | `/var/www/<app>/` | Application directory |
 | `/var/repo/<app>.git/` | Bare git repo (push-to-deploy) |
-| `/usr/local/bin/update-<app>` | Update/deploy script |
-| `/usr/local/bin/poll-<app>.sh` | Single poll script |
-| `/usr/local/bin/poll-<app>-daemon.sh` | Polling daemon (non-systemd) |
-| `/var/log/poll-<app>.log` | Polling logs (daemon mode) |
+| `/usr/local/bin/update-<app>` | Deploy script |
 | `/var/www/<app>/.provisor.json` | App configuration |
-| `/home/<user>/.ssh/deploy_<app>` | Deploy key (private) |
+| `/etc/caddy/Caddyfile` | Caddy configuration |
 
 ---