suthep 1.0.0

package/example/suthep-env-example.yml

@@ -0,0 +1,113 @@
+# Suthep Configuration Example with Environment Variables
+# Copy this file to suthep.yml and create a .env file with your values
+#
+# Environment variables are loaded from .env or .env.local files in the same directory
+# Variables can be referenced using ${VAR_NAME} or ${VAR_NAME:-default_value}
+#
+# Example .env file:
+#   PROJECT_NAME=my-awesome-app
+#   PROJECT_VERSION=1.0.0
+#   API_PORT=3000
+#   API_DOMAIN=api.example.com
+#   DOCKER_IMAGE=myapp/api:latest
+#   CONTAINER_NAME=api-container
+#   NODE_ENV=production
+#   DATABASE_URL=postgresql://user:pass@localhost:5432/dbname
+#   CERTBOT_EMAIL=admin@example.com
+#   CERTBOT_STAGING=false
+
+project:
+  name: ${PROJECT_NAME:-my-app}
+  version: ${PROJECT_VERSION:-1.0.0}
+
+services:
+  # Example 1: API service with environment variables
+  - name: api
+    port: ${API_PORT:-3000}  # Uses API_PORT from .env, defaults to 3000
+    domains:
+      - ${API_DOMAIN:-api.example.com}
+      - ${API_DOMAIN_WWW:-www.api.example.com}
+    healthCheck:
+      path: ${HEALTH_CHECK_PATH:-/health}
+      interval: ${HEALTH_CHECK_INTERVAL:-30}
+    environment:
+      NODE_ENV: ${NODE_ENV:-production}
+      PORT: ${API_PORT:-3000}
+      DATABASE_URL: ${DATABASE_URL}
+      # You can also reference other env vars in the environment section
+      REDIS_URL: ${REDIS_URL:-redis://localhost:6379}
+      LOG_LEVEL: ${LOG_LEVEL:-info}
+
+  # Example 2: Docker service with environment variables
+  - name: webapp
+    port: ${WEBAPP_PORT:-8080}
+    docker:
+      image: ${WEBAPP_IMAGE:-nginx:latest}  # Docker image from env var
+      container: ${WEBAPP_CONTAINER:-webapp-container}
+      port: ${WEBAPP_CONTAINER_PORT:-80}  # Internal container port
+    domains:
+      - ${WEBAPP_DOMAIN:-example.com}
+      - ${WEBAPP_DOMAIN_WWW:-www.example.com}
+    healthCheck:
+      path: ${WEBAPP_HEALTH_PATH:-/}
+      interval: ${WEBAPP_HEALTH_INTERVAL:-30}
+
+  # Example 3: Service with all values from environment variables
+  - name: backend
+    port: ${BACKEND_PORT}  # Required - no default, will error if not set
+    docker:
+      image: ${BACKEND_IMAGE}  # Required
+      container: ${BACKEND_CONTAINER}  # Required
+      port: ${BACKEND_CONTAINER_PORT:-8000}
+    domains:
+      - ${BACKEND_DOMAIN}
+    environment:
+      ENV: ${NODE_ENV:-production}
+      API_KEY: ${BACKEND_API_KEY}  # Required - will error if not set
+      DEBUG: ${DEBUG:-false}
+
+  # Example 4: Path-based routing with environment variables
+  - name: api-v2
+    port: ${API_V2_PORT:-3001}
+    path: ${API_V2_PATH:-/api}
+    domains:
+      - ${APP_DOMAIN:-myapp.com}
+    docker:
+      image: ${API_V2_IMAGE:-myapp/api:latest}
+      container: ${API_V2_CONTAINER:-api-v2-container}
+      port: ${API_V2_CONTAINER_PORT:-3001}
+    healthCheck:
+      path: ${API_V2_HEALTH_PATH:-/health}
+      interval: ${API_V2_HEALTH_INTERVAL:-30}
+    environment:
+      VERSION: ${API_V2_VERSION:-2.0.0}
+      FEATURES: ${API_V2_FEATURES:-all}
+
+  - name: frontend
+    port: ${FRONTEND_PORT:-3000}
+    path: ${FRONTEND_PATH:-/}
+    domains:
+      - ${APP_DOMAIN:-myapp.com}
+    docker:
+      image: ${FRONTEND_IMAGE:-myapp/frontend:latest}
+      container: ${FRONTEND_CONTAINER:-frontend-container}
+      port: ${FRONTEND_CONTAINER_PORT:-3000}
+    healthCheck:
+      path: ${FRONTEND_HEALTH_PATH:-/}
+      interval: ${FRONTEND_HEALTH_INTERVAL:-30}
+
+# Nginx Configuration
+nginx:
+  configPath: ${NGINX_CONFIG_PATH:-/etc/nginx/sites-available}
+  reloadCommand: ${NGINX_RELOAD_CMD:-sudo nginx -t && sudo systemctl reload nginx}
+
+# Certbot Configuration (SSL/TLS certificates)
+certbot:
+  email: ${CERTBOT_EMAIL}  # Required - no default
+  staging: ${CERTBOT_STAGING:-false}  # Set to true for testing to avoid rate limits
+
+# Deployment Configuration
+deployment:
+  strategy: ${DEPLOYMENT_STRATEGY:-rolling}  # Options: rolling, blue-green
+  healthCheckTimeout: ${HEALTH_CHECK_TIMEOUT:-30000}  # milliseconds
+

package/example/suthep-no-docker.yml

@@ -0,0 +1,51 @@
+# Example: Configuration without Docker
+# All services run directly on the host machine
+# Useful for services managed by PM2, systemd, supervisor, etc.
+
+project:
+  name: my-app
+  version: 1.0.0
+
+services:
+  # Node.js API service (e.g., running with PM2)
+  - name: api
+    port: 3000
+    domains:
+      - api.example.com
+    healthCheck:
+      path: /health
+      interval: 30
+    environment:
+      NODE_ENV: production
+      PORT: 3000
+
+  # Python web service (e.g., running with Gunicorn)
+  - name: web
+    port: 8000
+    domains:
+      - example.com
+      - www.example.com
+    healthCheck:
+      path: /health
+      interval: 30
+
+  # Go microservice
+  - name: auth
+    port: 4000
+    domains:
+      - auth.example.com
+    healthCheck:
+      path: /status
+      interval: 60
+
+nginx:
+  configPath: /etc/nginx/sites-available
+  reloadCommand: sudo nginx -t && sudo systemctl reload nginx
+
+certbot:
+  email: admin@example.com
+  staging: false
+
+deployment:
+  strategy: rolling
+  healthCheckTimeout: 30000

package/example/suthep-path-routing.yml

@@ -0,0 +1,62 @@
+# Example: Path-based Routing Configuration
+# Multiple services on the same domain using different paths
+# This is useful for monorepo deployments or microservices
+
+project:
+  name: path-routing-app
+  version: 1.0.0
+
+services:
+  # API service on /api path
+  - name: api
+    port: 3001
+    path: /api
+    domains:
+      - example.com
+    docker:
+      image: myapp/api:latest
+      container: api-container
+      port: 3001
+    healthCheck:
+      path: /health
+      interval: 30
+
+  # UI service on root path
+  - name: ui
+    port: 3000
+    path: /
+    domains:
+      - example.com
+    docker:
+      image: myapp/ui:latest
+      container: ui-container
+      port: 3000
+    healthCheck:
+      path: /
+      interval: 30
+
+  # Admin service on /admin path
+  - name: admin
+    port: 3002
+    path: /admin
+    domains:
+      - muacle.com
+    docker:
+      image: myapp/admin:latest
+      container: admin-container
+      port: 3002
+    healthCheck:
+      path: /health
+      interval: 30
+
+nginx:
+  configPath: /etc/nginx/sites-available
+  reloadCommand: sudo nginx -t && sudo systemctl reload nginx
+
+certbot:
+  email: admin@example.com
+  staging: false
+
+deployment:
+  strategy: rolling
+  healthCheckTimeout: 30000

package/example/suthep.example.yml

@@ -0,0 +1,88 @@
+# Suthep Configuration Example
+# Copy this file to suthep.yml and customize for your project
+
+project:
+  name: my-app
+  version: 1.0.0
+
+services:
+  # Example 1: Service without Docker (runs directly on host)
+  # Perfect for Node.js with PM2, Python with Gunicorn, etc.
+  - name: api
+    port: 3000
+    domains:
+      - api.example.com
+    healthCheck:
+      path: /health
+      interval: 30
+    environment:
+      NODE_ENV: production
+      PORT: 3000
+
+  # Example 2: Service with Docker image
+  # Suthep will pull the image and create the container
+  - name: webapp
+    port: 8080
+    docker:
+      image: nginx:latest
+      container: webapp-container
+      port: 80
+    domains:
+      - example.com
+      - www.example.com
+    healthCheck:
+      path: /
+      interval: 30
+
+  # Example 3: Service connecting to existing Docker container
+  # Useful when containers are managed separately (e.g., docker-compose)
+  - name: database-proxy
+    port: 5432
+    docker:
+      container: postgres-container
+      port: 5432
+    domains:
+      - db.example.com
+
+  # Example 4: Path-based routing
+  # Multiple services on the same domain using different paths
+  - name: api-v2
+    port: 3001
+    path: /api
+    domains:
+      - myapp.com
+    docker:
+      image: myapp/api:latest
+      container: api-v2-container
+      port: 3001
+    healthCheck:
+      path: /health
+      interval: 30
+
+  - name: frontend
+    port: 3000
+    path: /
+    domains:
+      - myapp.com
+    docker:
+      image: myapp/frontend:latest
+      container: frontend-container
+      port: 3000
+    healthCheck:
+      path: /
+      interval: 30
+
+# Nginx Configuration
+nginx:
+  configPath: /etc/nginx/sites-available
+  reloadCommand: sudo nginx -t && sudo systemctl reload nginx
+
+# Certbot Configuration (SSL/TLS certificates)
+certbot:
+  email: admin@example.com
+  staging: false  # Set to true for testing to avoid rate limits
+
+# Deployment Configuration
+deployment:
+  strategy: rolling  # Options: rolling, blue-green
+  healthCheckTimeout: 30000  # milliseconds

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "suthep",
+  "version": "1.0.0",
+  "type": "module",
+  "description": "CLI tool for deploying projects with automatic Nginx reverse proxy and HTTPS setup",
+  "main": "dist/index.js",
+  "bin": {
+    "suthep": "dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc && vite build",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:ui": "vitest --ui",
+    "test:coverage": "vitest run --coverage",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "deploy",
+    "nginx",
+    "certbot",
+    "docker",
+    "cli"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "commander": "^14.0.2",
+    "dotenv": "^17.2.3",
+    "execa": "^9.6.1",
+    "fs-extra": "^11.3.2",
+    "inquirer": "^13.0.2",
+    "js-yaml": "^4.1.1",
+    "vite": "^7.2.7"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/inquirer": "^9.0.9",
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^24.10.1",
+    "@vitest/coverage-v8": "^4.0.16",
+    "@vitest/ui": "^4.0.16",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.16"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  }
+}