suthep 0.1.0-beta.1 → 0.2.0-beta.1

package/src/index.ts

@@ -3,8 +3,11 @@ import { readFileSync } from 'fs'
 import { dirname, join } from 'path'
 import { fileURLToPath } from 'url'
 import { deployCommand } from './commands/deploy'
+import { downCommand } from './commands/down'
 import { initCommand } from './commands/init'
+import { redeployCommand } from './commands/redeploy'
 import { setupCommand } from './commands/setup'
+import { upCommand } from './commands/up'
 
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = dirname(__filename)
@@ -39,4 +42,54 @@ program
   .option('--no-nginx', 'Skip Nginx configuration')
   .action(deployCommand)
 
+program
+  .command('down')
+  .description('Bring down services (stop containers and disable Nginx configs)')
+  .option('-f, --file <path>', 'Configuration file path', 'suthep.yml')
+  .option('--all', 'Bring down all services', false)
+  .argument('[service-name]', 'Name of the service to bring down')
+  .action((serviceName, options) => {
+    downCommand({
+      file: options.file || 'suthep.yml',
+      all: options.all || false,
+      serviceName: serviceName,
+    })
+  })
+
+program
+  .command('up')
+  .description('Bring up services (start containers and enable Nginx configs)')
+  .option('-f, --file <path>', 'Configuration file path', 'suthep.yml')
+  .option('--all', 'Bring up all services', false)
+  .option('--no-https', 'Skip HTTPS setup')
+  .option('--no-nginx', 'Skip Nginx configuration')
+  .argument('[service-name]', 'Name of the service to bring up')
+  .action((serviceName, options) => {
+    upCommand({
+      file: options.file || 'suthep.yml',
+      all: options.all || false,
+      serviceName: serviceName,
+      https: options.https !== false,
+      nginx: options.nginx !== false,
+    })
+  })
+
+program
+  .command('redeploy')
+  .description('Redeploy services (bring down and deploy again)')
+  .option('-f, --file <path>', 'Configuration file path', 'suthep.yml')
+  .option('--all', 'Redeploy all services', false)
+  .option('--no-https', 'Skip HTTPS setup')
+  .option('--no-nginx', 'Skip Nginx configuration')
+  .argument('[service-name]', 'Name of the service to redeploy')
+  .action((serviceName, options) => {
+    redeployCommand({
+      file: options.file || 'suthep.yml',
+      all: options.all || false,
+      serviceName: serviceName,
+      https: options.https !== false,
+      nginx: options.nginx !== false,
+    })
+  })
+
 program.parse()

package/suthep.example.yml

@@ -85,6 +85,11 @@ services:
       path: /
       interval: 30
 
+# ========================================
+# Deployment Platform Configuration
+# ========================================
+# Nginx + Certbot Configuration
+
 nginx:
   configPath: /etc/nginx/sites-available
   reloadCommand: sudo nginx -t && sudo systemctl reload nginx

package/suthep.yml

@@ -0,0 +1,39 @@
+project:
+  name: small-production-app
+  version: 1.0.0
+
+services:
+  # Simple API service for small production deployment
+  # - name: muacle-api-dev
+    # port: 3003
+    # path: /api
+    # domains:
+    #   - dev.muacle.com
+    # docker:
+    #   image: muacle-api:dev
+    #   container: api-container-dev
+    #   port: 3001
+#    healthCheck:
+#      path: /health
+#      interval: 30
+    # environment:
+    #   NODE_ENV: production
+
+  # UI service on root path
+  - name: muacle-ui-dev
+    port: 3002
+    path: /
+    domains:
+      - localhost
+    docker:
+      image: frontend-api:latest
+      container: ui-container-dev
+      port: 3000
+#    healthCheck:
+#      path: /
+#      interval: 30
+
+deployment:
+  strategy: rolling
+  healthCheckTimeout: 30000
+

package/docs/TRANSLATIONS.md

@@ -1,211 +0,0 @@
-# Translations Guide
-
-This document describes the translation structure and how to contribute translations for the Suthep documentation.
-
-## Directory Structure
-
-```
-docs/
-├── README.md              # Main documentation index with language selection
-├── TRANSLATIONS.md        # This file - translation guide
-├── en/                    # English documentation (default)
-│   ├── README.md
-│   ├── getting-started.md
-│   ├── configuration.md
-│   ├── commands.md
-│   ├── port-binding.md
-│   ├── docker-ports-config.md
-│   ├── examples.md
-│   ├── troubleshooting.md
-│   ├── architecture.md
-│   ├── developer-guide.md
-│   └── api-reference.md
-└── th/                    # Thai documentation
-    ├── README.md
-    ├── getting-started.md
-    ├── configuration.md
-    └── commands.md
-```
-
-## Translation Status
-
-| Document | English | Thai | Status |
-|----------|---------|------|--------|
-| README | ✅ | ✅ | Complete |
-| Getting Started | ✅ | ✅ | Complete |
-| Configuration | ✅ | ✅ | Complete |
-| Commands | ✅ | ✅ | Complete |
-| Port Binding | ✅ | ⏳ | English only |
-| Docker Ports Config | ✅ | ⏳ | English only |
-| Examples | ✅ | ⏳ | English only |
-| Troubleshooting | ✅ | ⏳ | English only |
-| Architecture | ✅ | ⏳ | English only |
-| Developer Guide | ✅ | ⏳ | English only |
-| API Reference | ✅ | ⏳ | English only |
-
-**Legend:**
-- ✅ Available
-- ⏳ Coming soon / In progress
-- ❌ Not started
-
-## Adding a New Translation
-
-### Step 1: Create Language Folder
-
-Create a new folder for your language using the ISO 639-1 language code:
-
-```bash
-mkdir docs/ja  # For Japanese
-mkdir docs/es  # For Spanish
-mkdir docs/fr  # For French
-```
-
-### Step 2: Create README.md
-
-Create a `README.md` file in the new language folder that:
-- Welcomes users in the target language
-- Lists all available documents
-- Links to English versions for untranslated documents
-- Links back to the main documentation index
-
-Example structure:
-
-```markdown
-# Suthep Documentation
-
-[Welcome message in target language]
-
-## Table of Contents
-
-1. [Getting Started](./getting-started.md)
-2. [Configuration](./configuration.md)
-...
-
-## Other Languages
-
-- [English](../en/README.md)
-- [Your Language](./README.md) (current)
-```
-
-### Step 3: Translate Documents
-
-Translate documents in priority order:
-
-1. **README.md** - Main index
-2. **getting-started.md** - Most important for new users
-3. **configuration.md** - Essential reference
-4. **commands.md** - User-facing documentation
-5. Other documents as needed
-
-### Step 4: Update Links
-
-- Update internal links to use relative paths within the language folder
-- Link to English versions (`../en/filename.md`) for untranslated documents
-- Update the main `docs/README.md` to include your language
-
-### Step 5: Update Translation Status
-
-Update this file (`TRANSLATIONS.md`) to reflect the new translation status.
-
-## Translation Guidelines
-
-### File Naming
-
-- Use the same filenames as English versions
-- Keep file extensions: `.md`
-- No language suffix needed (language is determined by folder)
-
-### Link Structure
-
-- **Within same language**: `./filename.md`
-- **To English version**: `../en/filename.md`
-- **To main index**: `../README.md`
-- **To other languages**: `../lang-code/README.md`
-
-### Code Examples
-
-- Keep code examples in English (they're universal)
-- Translate comments in code examples if appropriate
-- Keep command-line examples in English
-
-### Technical Terms
-
-- Keep technical terms in English when there's no common translation
-- Use English terms for: Docker, Nginx, Certbot, SSL, HTTPS, etc.
-- Provide explanations in the target language
-
-### Formatting
-
-- Maintain the same Markdown structure
-- Keep the same heading hierarchy
-- Preserve code blocks and syntax highlighting
-- Maintain table structures
-
-## Website Integration
-
-This structure is designed to work with documentation websites:
-
-### Static Site Generators
-
-Works well with:
-- **Docusaurus** - Multi-language support built-in
-- **VitePress** - Supports i18n
-- **MkDocs** - With i18n plugin
-- **GitBook** - Multi-language support
-
-### URL Structure
-
-For websites, URLs would be:
-- `/en/getting-started` - English
-- `/th/getting-started` - Thai
-- `/` - Language selection
-
-### Configuration Example (Docusaurus)
-
-```javascript
-// docusaurus.config.js
-module.exports = {
-  i18n: {
-    defaultLocale: 'en',
-    locales: ['en', 'th'],
-    localeConfigs: {
-      en: {
-        label: 'English',
-      },
-      th: {
-        label: 'ไทย',
-      },
-    },
-  },
-};
-```
-
-## Contributing
-
-1. **Fork the repository**
-2. **Create a language folder** (if new language)
-3. **Translate documents** following the guidelines
-4. **Update this file** with translation status
-5. **Submit a pull request**
-
-## Quality Checklist
-
-Before submitting a translation:
-
-- [ ] All internal links work correctly
-- [ ] Code examples are preserved
-- [ ] Technical terms are handled appropriately
-- [ ] Formatting matches English version
-- [ ] README.md includes language selection
-- [ ] Translation status is updated
-- [ ] Main README.md is updated
-
-## Questions?
-
-If you have questions about translations:
-- Open an issue on GitHub
-- Check existing translations for examples
-- Review the English documentation for context
-
-Thank you for contributing to Suthep documentation! 🎉
-

package/docs/en/README.md

@@ -1,76 +0,0 @@
-# Suthep Documentation
-
-Welcome to the Suthep documentation! This guide will help you understand and use Suthep, a powerful CLI tool for deploying projects with automatic Nginx reverse proxy setup, HTTPS with Certbot, and zero-downtime deployments.
-
-## Table of Contents
-
-### User Documentation
-
-1. [Getting Started](./getting-started.md) - Installation and quick start guide
-2. [Configuration Reference](./configuration.md) - Complete configuration file reference
-3. [Commands Reference](./commands.md) - Detailed command documentation
-4. [Port Binding Guide](./port-binding.md) - How Docker port binding works
-5. [Docker Ports Configuration](./docker-ports-config.md) - How to configure ports in suthep.yml
-6. [Examples](./examples.md) - Real-world deployment examples
-7. [Troubleshooting](./troubleshooting.md) - Common issues and solutions
-
-### Developer Documentation
-
-8. [Developer Guide](./developer-guide.md) - **Complete guide for developers and contributors**
-9. [Architecture](./architecture.md) - How Suthep works under the hood
-10. [API Reference](./api-reference.md) - Internal utilities and functions
-
-## What is Suthep?
-
-Suthep is a deployment automation tool that simplifies the process of deploying web services with:
-
-- ✅ **Automatic Nginx reverse proxy setup** - No manual Nginx configuration needed
-- ✅ **Automatic HTTPS with Certbot** - Free SSL certificates from Let's Encrypt
-- ✅ **Zero-downtime deployment** - Rolling and blue-green deployment strategies
-- ✅ **Docker container support** - Deploy containerized applications easily
-- ✅ **Multiple domain/subdomain support** - One service, multiple domains
-- ✅ **Health check integration** - Ensure services are healthy before going live
-- ✅ **YAML-based configuration** - Simple, declarative configuration
-
-## Quick Start
-
-```bash
-# Install dependencies
-npm install
-npm link
-
-# Initialize configuration
-suthep init
-
-# Setup prerequisites
-suthep setup
-
-# Deploy your services
-suthep deploy
-```
-
-## Requirements
-
-- Node.js 16+
-- Nginx (installed via `suthep setup`)
-- Certbot (installed via `suthep setup`)
-- Docker (optional, for Docker-based services)
-- sudo access (for Nginx and Certbot operations)
-
-## Cost Optimization
-
-Suthep helps save costs on VMs by:
-- Efficiently managing multiple services on a single server
-- Automatic reverse proxy setup reduces manual configuration time
-- Zero-downtime deployments reduce service interruptions
-- Health checks ensure service reliability
-
-## Other Languages / ภาษาอื่นๆ
-
-- [English](./README.md) - English documentation (current)
-- [ไทย](../th/README.md) - Thai documentation / เอกสารภาษาไทย
-- [Back to Main Documentation](../README.md) - Return to language selection
-
-## License
-
-[MIT](../../LICENSE)