suthep 1.0.0

package/docs/english/02-installation.md

@@ -0,0 +1,200 @@
+# Installation Guide
+
+This guide will walk you through installing Suthep on your system.
+
+## System Requirements
+
+Before installing Suthep, ensure your system meets these requirements:
+
+- **Node.js** version 16 or higher
+- **npm**, **yarn**, or **pnpm** package manager
+- **sudo/administrator privileges** (required for Nginx and Certbot setup)
+- **Linux** or **macOS** operating system
+
+## Installing Suthep
+
+Suthep can be installed globally using any Node.js package manager.
+
+### Using npm
+
+```bash
+npm install -g suthep
+```
+
+### Using yarn
+
+```bash
+yarn global add suthep
+```
+
+### Using pnpm
+
+```bash
+pnpm add -g suthep
+```
+
+## Verify Installation
+
+After installation, verify that Suthep is installed correctly:
+
+```bash
+suthep --version
+```
+
+You should see the version number (e.g., `0.1.0-beta.1`).
+
+You can also check the help menu:
+
+```bash
+suthep --help
+```
+
+## Installing Prerequisites
+
+Suthep requires Nginx and Certbot to function. You can install these automatically using the `setup` command:
+
+```bash
+suthep setup
+```
+
+This command will:
+- Install Nginx (if not already installed)
+- Install Certbot (if not already installed)
+- Configure system dependencies
+
+### Manual Installation (Optional)
+
+If you prefer to install prerequisites manually:
+
+#### Nginx Installation
+
+**Ubuntu/Debian:**
+```bash
+sudo apt-get update
+sudo apt-get install -y nginx
+```
+
+**CentOS/RHEL:**
+```bash
+sudo yum install -y nginx
+```
+
+**macOS:**
+```bash
+brew install nginx
+```
+
+#### Certbot Installation
+
+**Ubuntu/Debian:**
+```bash
+sudo apt-get update
+sudo apt-get install -y certbot python3-certbot-nginx
+```
+
+**CentOS/RHEL:**
+```bash
+sudo yum install -y certbot python3-certbot-nginx
+```
+
+**macOS:**
+```bash
+brew install certbot
+```
+
+## Docker (Optional)
+
+If you plan to deploy Docker containers, install Docker:
+
+**Ubuntu/Debian:**
+```bash
+sudo apt-get update
+sudo apt-get install -y docker.io
+sudo systemctl start docker
+sudo systemctl enable docker
+```
+
+**macOS:**
+```bash
+brew install docker
+```
+
+Or download Docker Desktop from [docker.com](https://www.docker.com/products/docker-desktop).
+
+## Post-Installation
+
+After installation, you're ready to:
+
+1. **Initialize your first configuration:**
+   ```bash
+   suthep init
+   ```
+
+2. **Or continue to the Quick Start guide:**
+   See [Quick Start Guide](./03-quick-start.md)
+
+## Troubleshooting Installation
+
+### Command Not Found
+
+If you get a "command not found" error:
+
+1. **Check Node.js installation:**
+   ```bash
+   node --version
+   npm --version
+   ```
+
+2. **Verify global bin path:**
+   ```bash
+   npm config get prefix
+   ```
+
+3. **Add npm global bin to PATH** (if needed):
+   ```bash
+   export PATH="$PATH:$(npm config get prefix)/bin"
+   ```
+
+### Permission Errors
+
+If you encounter permission errors:
+
+1. **Use sudo for global installation:**
+   ```bash
+   sudo npm install -g suthep
+   ```
+
+2. **Or configure npm to use a different directory:**
+   ```bash
+   mkdir ~/.npm-global
+   npm config set prefix '~/.npm-global'
+   export PATH=~/.npm-global/bin:$PATH
+   ```
+
+### Nginx/Certbot Installation Issues
+
+If `suthep setup` fails:
+
+1. **Check your package manager:**
+   - Ubuntu/Debian: Ensure `apt-get` is available
+   - CentOS/RHEL: Ensure `yum` is available
+   - macOS: Ensure Homebrew is installed
+
+2. **Run setup with verbose output:**
+   ```bash
+   suthep setup --verbose
+   ```
+
+3. **Install prerequisites manually** (see Manual Installation above)
+
+## Next Steps
+
+Now that Suthep is installed:
+
+- [Quick Start Guide](./03-quick-start.md) - Deploy your first service
+- [Configuration Guide](./04-configuration.md) - Learn about configuration options
+
+---
+
+**Previous:** [Introduction](./01-introduction.md) | **Next:** [Quick Start →](./03-quick-start.md)
+

package/docs/english/03-quick-start.md

@@ -0,0 +1,258 @@
+# Quick Start Guide
+
+This guide will help you deploy your first service with Suthep in just a few minutes.
+
+## Step 1: Initialize Configuration
+
+Create a new configuration file interactively:
+
+```bash
+suthep init
+```
+
+This command will prompt you for:
+- Project name and version
+- Service details (name, port, domains)
+- Docker configuration (if needed)
+- Health check settings
+- SSL certificate email
+
+Alternatively, you can copy the example configuration:
+
+```bash
+cp suthep.example.yml suthep.yml
+```
+
+Then edit `suthep.yml` with your settings.
+
+## Step 2: Setup Prerequisites
+
+Install and configure Nginx and Certbot:
+
+```bash
+suthep setup
+```
+
+This will:
+- Install Nginx (if not already installed)
+- Install Certbot (if not already installed)
+- Configure system dependencies
+
+**Note:** This command requires sudo privileges.
+
+## Step 3: Deploy Your Service
+
+Deploy your project:
+
+```bash
+suthep deploy
+```
+
+This command will:
+1. Configure Nginx reverse proxy for all services
+2. Obtain SSL certificates via Certbot (if enabled)
+3. Deploy services with zero-downtime strategy
+
+## Example: Deploying a Simple API
+
+Let's walk through deploying a Node.js API service:
+
+### 1. Create Configuration
+
+Create `suthep.yml`:
+
+```yaml
+project:
+  name: my-api
+  version: 1.0.0
+
+services:
+  - name: api
+    port: 3000
+    domains:
+      - api.example.com
+    healthCheck:
+      path: /health
+      interval: 30
+    environment:
+      NODE_ENV: production
+
+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
+```
+
+### 2. Setup Prerequisites
+
+```bash
+suthep setup
+```
+
+### 3. Deploy
+
+```bash
+suthep deploy
+```
+
+### 4. Verify Deployment
+
+After deployment, Suthep will display service URLs:
+
+```
+📋 Service URLs:
+   api: https://api.example.com
+```
+
+Visit the URL in your browser to verify the service is running.
+
+## Example: Deploying a Docker Container
+
+To deploy a Docker container:
+
+```yaml
+services:
+  - name: webapp
+    port: 8080
+    docker:
+      image: nginx:latest
+      container: webapp-container
+      port: 80
+    domains:
+      - example.com
+      - www.example.com
+```
+
+Then run:
+
+```bash
+suthep deploy
+```
+
+## Common Commands
+
+### Check Service Status
+
+```bash
+# View Nginx configuration
+sudo nginx -t
+
+# Check running containers
+docker ps
+
+# View service logs
+docker logs <container-name>
+```
+
+### Update Configuration
+
+1. Edit `suthep.yml`
+2. Redeploy (bring down and deploy again):
+   ```bash
+   suthep down <service-name> && suthep deploy <service-name>
+   # Or for all services:
+   suthep down --all && suthep deploy
+   ```
+
+### Stop Services
+
+```bash
+# Stop a specific service
+suthep down <service-name>
+
+# Stop all services
+suthep down --all
+```
+
+### Start Services
+
+```bash
+# Start a specific service
+suthep up <service-name>
+
+# Start all services
+suthep up --all
+```
+
+## What Happens During Deployment?
+
+When you run `suthep deploy`, Suthep:
+
+1. **Loads Configuration** - Reads your `suthep.yml` file
+2. **Starts Docker Containers** - If Docker is configured, starts containers
+3. **Configures Nginx** - Generates and writes Nginx configuration files
+4. **Enables Sites** - Creates symlinks to enable Nginx sites
+5. **Obtains SSL Certificates** - Requests certificates from Let's Encrypt
+6. **Updates Nginx for HTTPS** - Adds SSL configuration to Nginx
+7. **Reloads Nginx** - Applies all changes
+8. **Performs Health Checks** - Verifies services are running correctly
+
+## Troubleshooting Quick Start
+
+### Domain Not Resolving
+
+Ensure your domain points to your server:
+
+```bash
+# Check DNS
+nslookup api.example.com
+
+# Verify server IP matches
+curl -I http://api.example.com
+```
+
+### Port Already in Use
+
+If you get a "port already in use" error:
+
+1. **Find what's using the port:**
+   ```bash
+   sudo lsof -i :3000
+   ```
+
+2. **Stop the conflicting service** or **change the port** in `suthep.yml`
+
+### SSL Certificate Issues
+
+If SSL certificate creation fails:
+
+1. **Check domain DNS** - Ensure domain points to your server
+2. **Use staging mode** for testing:
+   ```yaml
+   certbot:
+     staging: true
+   ```
+
+3. **Check firewall** - Ensure ports 80 and 443 are open
+
+### Nginx Configuration Errors
+
+If Nginx fails to reload:
+
+```bash
+# Test Nginx configuration
+sudo nginx -t
+
+# Check Nginx error logs
+sudo tail -f /var/log/nginx/error.log
+```
+
+## Next Steps
+
+Now that you've deployed your first service:
+
+- [Configuration Guide](./04-configuration.md) - Learn about all configuration options
+- [Commands Reference](./05-commands.md) - Explore all available commands
+- [Examples](./06-examples.md) - See more deployment examples
+
+---
+
+**Previous:** [Installation](./02-installation.md) | **Next:** [Configuration Guide →](./04-configuration.md)
+