refactor: remove unused deployment infrastructure
- Remove scripts/ directory (21 deployment/helper scripts) - Remove k8s/ and k8s-kustomize/ directories (Kubernetes configs) - Remove docker/ directory (docker-compose and configs) - Remove docs/deployment/ directory and related documentation - Remove CI-specific docker compose and bake files - App is not production-ready yet, focusing on development - Can be re-added when needed for production deployment
This commit is contained in:
William Valentin
@@ -1,423 +0,0 @@
|
||||
# Quick Deployment Guide
|
||||
|
||||
This guide provides simple, practical deployment options for the RxMinder application, ranging from local development to production deployment.
|
||||
|
||||
## 🚀 Instant Local Deployment
|
||||
|
||||
For immediate testing and development, use the local Docker deployment:
|
||||
|
||||
```bash
|
||||
# Deploy locally with Docker (includes database)
|
||||
make deploy-local
|
||||
|
||||
# Access the application
|
||||
open http://localhost:8080
|
||||
|
||||
# Stop when done
|
||||
make stop-local
|
||||
```
|
||||
|
||||
This deployment:
|
||||
|
||||
- ✅ Includes CouchDB database
|
||||
- ✅ Uses development configuration (safe defaults)
|
||||
- ✅ Accessible at <http://localhost:8080>
|
||||
- ✅ No additional configuration required
|
||||
- ✅ Perfect for testing and development
|
||||
|
||||
## 📋 Deployment Options Overview
|
||||
|
||||
| Method | Use Case | Requirements | URL | Command |
|
||||
| ----------------------- | ------------------------------ | -------------------- | ----------------------- | ----------------------------- |
|
||||
| **Development Server** | Active development | Node.js/Bun | <http://localhost:5173> | `make dev` |
|
||||
| **Local Docker** | Testing/Demo | Docker | <http://localhost:8080> | `make deploy-local` |
|
||||
| **Production (Auto)** | Production with auto-secrets | Kubernetes cluster | Configured domain | `make deploy-prod-quick` |
|
||||
| **Production (Manual)** | Production with custom secrets | Kubernetes + secrets | Configured domain | `make deploy-prod-configured` |
|
||||
|
||||
## 🔧 Development Deployment
|
||||
|
||||
### Option 1: Development Server (Fastest)
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
make install
|
||||
|
||||
# Start development server
|
||||
make dev
|
||||
```
|
||||
|
||||
- Hot reloading enabled
|
||||
- Access at <http://localhost:5173>
|
||||
- Uses mock database (in-memory)
|
||||
- Best for active development
|
||||
|
||||
### Option 2: Built Application Preview
|
||||
|
||||
```bash
|
||||
# Build and preview
|
||||
make build
|
||||
make preview
|
||||
```
|
||||
|
||||
- Simulates production build
|
||||
- Access at <http://localhost:4173>
|
||||
- Uses mock database
|
||||
- Good for testing build process
|
||||
|
||||
## 🐳 Docker Deployment
|
||||
|
||||
### Local Docker Deployment (Recommended for Testing)
|
||||
|
||||
```bash
|
||||
# Deploy with Docker Compose
|
||||
make deploy-local
|
||||
```
|
||||
|
||||
**What this includes:**
|
||||
|
||||
- Frontend application (Nginx)
|
||||
- CouchDB database with persistent data
|
||||
- Health checks and monitoring
|
||||
- Automatic restart policies
|
||||
|
||||
**Access:**
|
||||
|
||||
- Application: <http://localhost:8080>
|
||||
- CouchDB Admin: <http://localhost:5984/_utils>
|
||||
|
||||
**Management:**
|
||||
|
||||
```bash
|
||||
# View logs
|
||||
docker-compose -f docker/docker-compose.yaml logs -f
|
||||
|
||||
# Stop deployment
|
||||
make stop-local
|
||||
|
||||
# Restart deployment
|
||||
make deploy-local
|
||||
|
||||
# Clean up completely
|
||||
make docker-clean
|
||||
```
|
||||
|
||||
### Docker Compose Manual Commands
|
||||
|
||||
```bash
|
||||
# Start services
|
||||
docker-compose -f docker/docker-compose.yaml up -d
|
||||
|
||||
# Stop services
|
||||
docker-compose -f docker/docker-compose.yaml down
|
||||
|
||||
# View logs
|
||||
docker-compose -f docker/docker-compose.yaml logs -f frontend
|
||||
docker-compose -f docker/docker-compose.yaml logs -f couchdb
|
||||
|
||||
# Rebuild and restart
|
||||
docker-compose -f docker/docker-compose.yaml up -d --build
|
||||
```
|
||||
|
||||
## ☸️ Kubernetes Deployment
|
||||
|
||||
### Prerequisites
|
||||
|
||||
1. **Kubernetes cluster** with kubectl configured
|
||||
2. **Cluster admin access** to create namespaces
|
||||
3. **Ingress controller** (optional, for external access)
|
||||
|
||||
### Create Required Namespaces
|
||||
|
||||
```bash
|
||||
# Create development namespace
|
||||
kubectl create namespace rxminder-dev
|
||||
|
||||
# Create production namespace
|
||||
kubectl create namespace rxminder-prod
|
||||
```
|
||||
|
||||
### Development Deployment
|
||||
|
||||
```bash
|
||||
# Deploy to development environment
|
||||
make deploy-dev
|
||||
|
||||
# Check status
|
||||
make status-dev
|
||||
|
||||
# View logs
|
||||
kubectl logs -n rxminder-dev -l app=rxminder
|
||||
|
||||
# Remove deployment
|
||||
make undeploy-dev
|
||||
```
|
||||
|
||||
### Production Deployment
|
||||
|
||||
#### Option A: Auto-Generated Secrets (Quick)
|
||||
|
||||
```bash
|
||||
# Deploy with automatically generated secrets
|
||||
make deploy-prod-quick
|
||||
```
|
||||
|
||||
#### Option B: Custom Configuration (Recommended)
|
||||
|
||||
```bash
|
||||
# Set your production secrets
|
||||
export JWT_SECRET="your-secure-jwt-secret-here"
|
||||
export SESSION_SECRET="your-secure-session-secret-here"
|
||||
export VITE_COUCHDB_URL="https://your-couchdb-instance.com"
|
||||
|
||||
# Deploy with your configuration
|
||||
make deploy-prod-configured
|
||||
```
|
||||
|
||||
#### Option C: Using Configuration Files
|
||||
|
||||
```bash
|
||||
# Generate production configuration
|
||||
make generate-config-prod
|
||||
|
||||
# Edit the generated files
|
||||
nano .env.production
|
||||
|
||||
# Deploy
|
||||
make build-prod
|
||||
make deploy-prod
|
||||
```
|
||||
|
||||
### Kubernetes Management
|
||||
|
||||
```bash
|
||||
# Check deployment status
|
||||
make status-prod
|
||||
make status-dev
|
||||
|
||||
# View differences before applying
|
||||
make diff-prod
|
||||
make diff-dev
|
||||
|
||||
# Validate configurations
|
||||
make validate-k8s
|
||||
|
||||
# Remove deployments
|
||||
make undeploy-prod
|
||||
make undeploy-dev
|
||||
make undeploy-all
|
||||
```
|
||||
|
||||
## 🔒 Production Configuration
|
||||
|
||||
### Required Environment Variables
|
||||
|
||||
For production deployment, you must set:
|
||||
|
||||
```bash
|
||||
# Authentication (Required)
|
||||
JWT_SECRET="your-secure-32-character-secret"
|
||||
SESSION_SECRET="your-secure-32-character-secret"
|
||||
|
||||
# Database (Required for persistence)
|
||||
VITE_COUCHDB_URL="https://your-couchdb.com"
|
||||
COUCHDB_USER="your-username"
|
||||
COUCHDB_PASSWORD="your-password"
|
||||
```
|
||||
|
||||
### Optional Configuration
|
||||
|
||||
```bash
|
||||
# Email notifications
|
||||
MAILGUN_API_KEY="your-mailgun-key"
|
||||
MAILGUN_DOMAIN="your-domain.com"
|
||||
|
||||
# OAuth authentication
|
||||
GOOGLE_CLIENT_ID="your-google-client-id"
|
||||
GITHUB_CLIENT_ID="your-github-client-id"
|
||||
```
|
||||
|
||||
### Generate Secure Secrets
|
||||
|
||||
```bash
|
||||
# Generate secure secrets
|
||||
JWT_SECRET=$(openssl rand -base64 32)
|
||||
SESSION_SECRET=$(openssl rand -base64 32)
|
||||
|
||||
echo "JWT_SECRET=$JWT_SECRET"
|
||||
echo "SESSION_SECRET=$SESSION_SECRET"
|
||||
```
|
||||
|
||||
## 🔍 Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
#### Docker Issues
|
||||
|
||||
```bash
|
||||
# If deployment fails
|
||||
make docker-clean
|
||||
make deploy-local
|
||||
|
||||
# If ports are in use
|
||||
docker-compose -f docker/docker-compose.yaml down
|
||||
# Wait a moment, then retry
|
||||
make deploy-local
|
||||
```
|
||||
|
||||
#### Build Issues
|
||||
|
||||
```bash
|
||||
# For production build failures
|
||||
# Check that secrets are set
|
||||
echo $JWT_SECRET
|
||||
echo $SESSION_SECRET
|
||||
|
||||
# Try development build instead
|
||||
make build
|
||||
```
|
||||
|
||||
#### Kubernetes Issues
|
||||
|
||||
```bash
|
||||
# If namespace doesn't exist
|
||||
kubectl create namespace rxminder-dev
|
||||
kubectl create namespace rxminder-prod
|
||||
|
||||
# If deployment fails
|
||||
kubectl get pods -n rxminder-dev
|
||||
kubectl logs -n rxminder-dev <pod-name>
|
||||
```
|
||||
|
||||
### Health Checks
|
||||
|
||||
#### Local Docker Deployment
|
||||
|
||||
```bash
|
||||
# Check if services are running
|
||||
docker-compose -f docker/docker-compose.yaml ps
|
||||
|
||||
# Test frontend
|
||||
curl http://localhost:8080
|
||||
|
||||
# Test CouchDB
|
||||
curl http://localhost:5984/_up
|
||||
```
|
||||
|
||||
#### Kubernetes Deployment
|
||||
|
||||
```bash
|
||||
# Check pod status
|
||||
kubectl get pods -n rxminder-prod
|
||||
|
||||
# Check service status
|
||||
kubectl get services -n rxminder-prod
|
||||
|
||||
# View logs
|
||||
kubectl logs -n rxminder-prod -l app=rxminder
|
||||
```
|
||||
|
||||
## 📊 Monitoring
|
||||
|
||||
### Docker Deployment
|
||||
|
||||
```bash
|
||||
# View real-time logs
|
||||
docker-compose -f docker/docker-compose.yaml logs -f
|
||||
|
||||
# Monitor resource usage
|
||||
docker stats
|
||||
```
|
||||
|
||||
### Kubernetes Deployment
|
||||
|
||||
```bash
|
||||
# Monitor pods
|
||||
kubectl top pods -n rxminder-prod
|
||||
|
||||
# View events
|
||||
kubectl get events -n rxminder-prod --sort-by='.lastTimestamp'
|
||||
|
||||
# Port forward for local access
|
||||
kubectl port-forward -n rxminder-prod service/rxminder 8080:80
|
||||
```
|
||||
|
||||
## 🔄 Updates and Maintenance
|
||||
|
||||
### Update Local Deployment
|
||||
|
||||
```bash
|
||||
# Pull latest changes
|
||||
git pull
|
||||
|
||||
# Rebuild and restart
|
||||
make deploy-local
|
||||
```
|
||||
|
||||
### Update Production Deployment
|
||||
|
||||
```bash
|
||||
# Pull latest changes
|
||||
git pull
|
||||
|
||||
# Build and deploy
|
||||
make deploy-prod-quick
|
||||
|
||||
# Or with custom configuration
|
||||
make deploy-prod-configured
|
||||
```
|
||||
|
||||
### Backup Data
|
||||
|
||||
#### Docker CouchDB
|
||||
|
||||
```bash
|
||||
# CouchDB data is stored in docker/couchdb-data/
|
||||
# Backup this directory
|
||||
tar -czf couchdb-backup-$(date +%Y%m%d).tar.gz docker/couchdb-data/
|
||||
```
|
||||
|
||||
#### Kubernetes CouchDB
|
||||
|
||||
```bash
|
||||
# Access CouchDB pod
|
||||
kubectl exec -n rxminder-prod -it <couchdb-pod> -- bash
|
||||
|
||||
# Use CouchDB backup tools
|
||||
# Or backup persistent volume
|
||||
```
|
||||
|
||||
## 🚀 Quick Commands Reference
|
||||
|
||||
```bash
|
||||
# Development
|
||||
make dev # Start development server
|
||||
make build # Build for development
|
||||
make test # Run tests
|
||||
|
||||
# Local deployment
|
||||
make deploy-local # Deploy with Docker
|
||||
make stop-local # Stop Docker deployment
|
||||
|
||||
# Production deployment
|
||||
make deploy-prod-quick # Deploy with auto-generated secrets
|
||||
make deploy-prod-configured # Deploy with custom secrets
|
||||
|
||||
# Management
|
||||
make help # Show all available commands
|
||||
make validate-k8s # Validate Kubernetes configs
|
||||
make docker-clean # Clean up Docker resources
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**Need more detailed information?**
|
||||
|
||||
- [Production Build Guide](deployment/PRODUCTION_BUILD.md) - Detailed production configuration
|
||||
- [Docker Configuration](deployment/DOCKER_IMAGE_CONFIGURATION.md) - Docker setup details
|
||||
- [Database Service](development/DATABASE.md) - Database configuration
|
||||
- [Main README](../README.md) - Complete project overview
|
||||
|
||||
---
|
||||
|
||||
**Last Updated:** January 2024
|
||||
**Status:** Ready for deployment
|
||||
@@ -1,538 +0,0 @@
|
||||
# Deployment Guide
|
||||
|
||||
## 🚀 Complete Deployment Guide for Medication Reminder App
|
||||
|
||||
### **Prerequisites**
|
||||
|
||||
#### **System Requirements**
|
||||
|
||||
- Docker 20.10+ and Docker Compose 2.0+
|
||||
- 2GB RAM minimum, 4GB recommended
|
||||
- 10GB disk space for application and data
|
||||
- Linux/macOS/Windows with WSL2
|
||||
|
||||
#### **Required Accounts**
|
||||
|
||||
- [Mailgun Account](https://mailgun.com) for email services
|
||||
- Domain name for production deployment (optional)
|
||||
- SSL certificate for HTTPS (recommended)
|
||||
|
||||
### **Environment Setup**
|
||||
|
||||
#### **1. Clone Repository**
|
||||
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd meds
|
||||
```
|
||||
|
||||
#### **2. Configure Environment**
|
||||
|
||||
```bash
|
||||
# Copy template
|
||||
cp .env.example .env
|
||||
|
||||
# Edit with your credentials
|
||||
nano .env
|
||||
```
|
||||
|
||||
**Required Variables:**
|
||||
|
||||
```bash
|
||||
# Application Configuration
|
||||
APP_BASE_URL=https://yourdomain.com
|
||||
|
||||
# CouchDB Configuration
|
||||
COUCHDB_USER=admin
|
||||
COUCHDB_PASSWORD=super-secure-password-123!
|
||||
VITE_COUCHDB_URL=http://couchdb:5984
|
||||
VITE_COUCHDB_USER=admin
|
||||
VITE_COUCHDB_PASSWORD=super-secure-password-123!
|
||||
|
||||
# Mailgun Configuration
|
||||
MAILGUN_API_KEY=key-1234567890abcdef1234567890abcdef
|
||||
MAILGUN_DOMAIN=mg.yourdomain.com
|
||||
MAILGUN_FROM_EMAIL=noreply@yourdomain.com
|
||||
|
||||
# Production Settings
|
||||
NODE_ENV=production
|
||||
```
|
||||
|
||||
### **Local Development Deployment**
|
||||
|
||||
#### **Quick Start**
|
||||
|
||||
```bash
|
||||
# Automated setup
|
||||
./setup.sh
|
||||
|
||||
# Manual setup
|
||||
bun install
|
||||
docker compose up -d
|
||||
bun run seed-production.js
|
||||
```
|
||||
|
||||
#### **Development URLs**
|
||||
|
||||
- Frontend: http://localhost:8080
|
||||
- CouchDB: http://localhost:5984
|
||||
- Admin Panel: http://localhost:5984/\_utils
|
||||
|
||||
### **Production Deployment**
|
||||
|
||||
#### **Method 1: Automated Script**
|
||||
|
||||
```bash
|
||||
# Secure deployment with validation
|
||||
./deploy.sh production
|
||||
```
|
||||
|
||||
#### **Method 2: Manual Docker Compose**
|
||||
|
||||
```bash
|
||||
# Build images
|
||||
docker compose build --no-cache
|
||||
|
||||
# Start services
|
||||
docker compose up -d
|
||||
|
||||
# Seed database
|
||||
node seed-production.js
|
||||
|
||||
# Verify deployment
|
||||
bun test-production.js
|
||||
```
|
||||
|
||||
#### **Method 3: Docker Swarm**
|
||||
|
||||
```bash
|
||||
# Initialize swarm
|
||||
docker swarm init
|
||||
|
||||
# Deploy stack
|
||||
docker stack deploy -c docker/docker-compose.yaml meds-stack
|
||||
|
||||
# Scale services
|
||||
docker service scale meds-stack_frontend=3
|
||||
```
|
||||
|
||||
### **Cloud Platform Deployments**
|
||||
|
||||
#### **AWS EC2 Deployment**
|
||||
|
||||
**1. Launch EC2 Instance**
|
||||
|
||||
```bash
|
||||
# Amazon Linux 2 AMI
|
||||
# Instance type: t3.medium or larger
|
||||
# Security group: Allow ports 22, 80, 443, 8080
|
||||
```
|
||||
|
||||
**2. Install Dependencies**
|
||||
|
||||
```bash
|
||||
# Connect to instance
|
||||
ssh -i your-key.pem ec2-user@your-instance-ip
|
||||
|
||||
# Install Docker
|
||||
sudo yum update -y
|
||||
sudo yum install -y docker
|
||||
sudo service docker start
|
||||
sudo usermod -a -G docker ec2-user
|
||||
|
||||
# Install Docker Compose
|
||||
sudo curl -L "https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
|
||||
sudo chmod +x /usr/local/bin/docker-compose
|
||||
```
|
||||
|
||||
**3. Deploy Application**
|
||||
|
||||
```bash
|
||||
# Clone and configure
|
||||
git clone <repository-url>
|
||||
cd meds
|
||||
cp .env.example .env
|
||||
# Edit .env with production values
|
||||
|
||||
# Deploy
|
||||
./deploy.sh production
|
||||
```
|
||||
|
||||
#### **Google Cloud Platform Deployment**
|
||||
|
||||
**1. Cloud Run Deployment**
|
||||
|
||||
```bash
|
||||
# Build and push image
|
||||
gcloud builds submit --tag gcr.io/PROJECT-ID/meds-app
|
||||
|
||||
# Deploy service
|
||||
gcloud run deploy meds-app \
|
||||
--image gcr.io/PROJECT-ID/meds-app \
|
||||
--platform managed \
|
||||
--region us-central1 \
|
||||
--set-env-vars COUCHDB_URL=your-couchdb-url \
|
||||
--set-env-vars MAILGUN_API_KEY=your-key \
|
||||
--allow-unauthenticated
|
||||
```
|
||||
|
||||
**2. Compute Engine Deployment**
|
||||
|
||||
```bash
|
||||
# Create instance
|
||||
gcloud compute instances create meds-server \
|
||||
--image-family debian-11 \
|
||||
--image-project debian-cloud \
|
||||
--machine-type e2-medium \
|
||||
--tags http-server,https-server
|
||||
|
||||
# SSH and install
|
||||
gcloud compute ssh meds-server
|
||||
# Follow standard installation steps
|
||||
```
|
||||
|
||||
#### **Digital Ocean Deployment**
|
||||
|
||||
**1. Droplet Setup**
|
||||
|
||||
```bash
|
||||
# Create droplet with Docker pre-installed
|
||||
# Or install Docker manually on Ubuntu droplet
|
||||
|
||||
# Connect and deploy
|
||||
ssh root@your-droplet-ip
|
||||
git clone <repository-url>
|
||||
cd meds
|
||||
./setup.sh
|
||||
./deploy.sh production
|
||||
```
|
||||
|
||||
**2. App Platform Deployment**
|
||||
|
||||
```bash
|
||||
# Create app.yaml
|
||||
version: 1
|
||||
services:
|
||||
- name: meds-app
|
||||
source_dir: /
|
||||
github:
|
||||
repo: your-username/meds
|
||||
branch: main
|
||||
build_command: bun run build
|
||||
environment_slug: node-js
|
||||
instance_count: 1
|
||||
instance_size_slug: basic-xxs
|
||||
envs:
|
||||
- key: COUCHDB_URL
|
||||
value: ${COUCHDB_URL}
|
||||
- key: MAILGUN_API_KEY
|
||||
value: ${MAILGUN_API_KEY}
|
||||
|
||||
# Deploy
|
||||
doctl apps create --spec app.yaml
|
||||
```
|
||||
|
||||
### **Kubernetes Deployment**
|
||||
|
||||
#### **Method 1: Automated Deployment Script (Recommended)**
|
||||
|
||||
```bash
|
||||
# Configure environment
|
||||
cp .env.example .env
|
||||
# Edit .env with your settings:
|
||||
# INGRESS_HOST=app.meds.192.168.1.100.nip.io # For local cluster
|
||||
# INGRESS_HOST=meds.yourdomain.com # For production
|
||||
|
||||
# Deploy with environment substitution
|
||||
./deploy-k8s.sh
|
||||
|
||||
# Check deployment status
|
||||
./deploy-k8s.sh --status
|
||||
|
||||
# Deploy with custom environment file
|
||||
./deploy-k8s.sh --env .env.production
|
||||
|
||||
# Preview deployment (dry run)
|
||||
./deploy-k8s.sh --dry-run
|
||||
```
|
||||
|
||||
#### **Method 2: Manual Deployment**
|
||||
|
||||
#### **1. Create Namespace and Secrets**
|
||||
|
||||
```bash
|
||||
# Create namespace
|
||||
kubectl create namespace meds-app
|
||||
|
||||
# Create secrets
|
||||
kubectl create secret generic meds-secrets \
|
||||
--from-literal=couchdb-user=admin \
|
||||
--from-literal=couchdb-password=secure-password \
|
||||
--from-literal=mailgun-api-key=your-api-key \
|
||||
--namespace meds-app
|
||||
```
|
||||
|
||||
#### **2. Deploy Services**
|
||||
|
||||
```bash
|
||||
# Apply Kubernetes manifests
|
||||
kubectl apply -f k8s/ --namespace meds-app
|
||||
|
||||
# Check deployment status
|
||||
kubectl get pods -n meds-app
|
||||
kubectl get services -n meds-app
|
||||
```
|
||||
|
||||
#### **3. Configure Ingress (Manual)**
|
||||
|
||||
```yaml
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: Ingress
|
||||
metadata:
|
||||
name: meds-ingress
|
||||
namespace: meds-app
|
||||
annotations:
|
||||
kubernetes.io/ingress.class: nginx
|
||||
cert-manager.io/cluster-issuer: letsencrypt-prod
|
||||
spec:
|
||||
tls:
|
||||
- hosts:
|
||||
- meds.yourdomain.com
|
||||
secretName: meds-tls
|
||||
rules:
|
||||
- host: meds.yourdomain.com # Update this to your domain
|
||||
http:
|
||||
paths:
|
||||
- path: /
|
||||
pathType: Prefix
|
||||
backend:
|
||||
service:
|
||||
name: meds-frontend
|
||||
port:
|
||||
number: 80
|
||||
```
|
||||
|
||||
### **SSL/HTTPS Configuration**
|
||||
|
||||
#### **Let's Encrypt with Nginx**
|
||||
|
||||
```bash
|
||||
# Install certbot
|
||||
sudo apt-get install certbot python3-certbot-nginx
|
||||
|
||||
# Get certificate
|
||||
sudo certbot --nginx -d yourdomain.com
|
||||
|
||||
# Auto-renewal
|
||||
sudo crontab -e
|
||||
# Add: 0 12 * * * /usr/bin/certbot renew --quiet
|
||||
```
|
||||
|
||||
#### **Cloudflare SSL**
|
||||
|
||||
```bash
|
||||
# Update docker/nginx.conf for Cloudflare
|
||||
# Set ssl_certificate and ssl_certificate_key
|
||||
# Configure Cloudflare for Full (Strict) SSL
|
||||
```
|
||||
|
||||
### **Database Backup and Recovery**
|
||||
|
||||
#### **CouchDB Backup**
|
||||
|
||||
```bash
|
||||
# Create backup script
|
||||
#!/bin/bash
|
||||
DATE=$(date +%Y%m%d_%H%M%S)
|
||||
BACKUP_DIR="/backup/couchdb"
|
||||
|
||||
# Backup all databases
|
||||
curl -X GET http://admin:password@localhost:5984/_all_dbs | \
|
||||
jq -r '.[]' | while read db; do
|
||||
curl -X GET "http://admin:password@localhost:5984/$db/_all_docs?include_docs=true" \
|
||||
> "$BACKUP_DIR/${db}_${DATE}.json"
|
||||
done
|
||||
```
|
||||
|
||||
#### **Automated Backups**
|
||||
|
||||
```bash
|
||||
# Add to crontab
|
||||
0 2 * * * /opt/meds/backup-couchdb.sh
|
||||
|
||||
# Upload to cloud storage
|
||||
aws s3 cp /backup/couchdb/ s3://your-backup-bucket/ --recursive
|
||||
```
|
||||
|
||||
### **Monitoring and Logging**
|
||||
|
||||
#### **Health Checks**
|
||||
|
||||
```bash
|
||||
# Application health
|
||||
curl -f http://localhost:8080/health
|
||||
|
||||
# CouchDB health
|
||||
curl -f http://admin:password@localhost:5984/_up
|
||||
|
||||
# Docker container health
|
||||
docker compose ps
|
||||
```
|
||||
|
||||
#### **Log Management**
|
||||
|
||||
```bash
|
||||
# View logs
|
||||
docker compose logs -f frontend
|
||||
docker compose logs -f couchdb
|
||||
|
||||
# Log rotation
|
||||
# Configure in docker/docker-compose.yaml:
|
||||
logging:
|
||||
driver: "json-file"
|
||||
options:
|
||||
max-size: "10m"
|
||||
max-file: "3"
|
||||
```
|
||||
|
||||
#### **Performance Monitoring**
|
||||
|
||||
```bash
|
||||
# Resource usage
|
||||
docker stats
|
||||
|
||||
# Application metrics
|
||||
# Implement custom metrics endpoint
|
||||
# Use Prometheus/Grafana for monitoring
|
||||
```
|
||||
|
||||
### **Scaling and Load Balancing**
|
||||
|
||||
#### **Horizontal Scaling**
|
||||
|
||||
```bash
|
||||
# Scale frontend containers
|
||||
docker compose up -d --scale frontend=3
|
||||
|
||||
# Load balancer configuration
|
||||
# Use nginx, HAProxy, or cloud load balancer
|
||||
```
|
||||
|
||||
#### **Database Scaling**
|
||||
|
||||
```bash
|
||||
# CouchDB clustering
|
||||
# Configure multiple CouchDB nodes
|
||||
# Set up replication between nodes
|
||||
```
|
||||
|
||||
### **Security Hardening**
|
||||
|
||||
#### **Firewall Configuration**
|
||||
|
||||
```bash
|
||||
# UFW (Ubuntu)
|
||||
sudo ufw allow 22/tcp
|
||||
sudo ufw allow 80/tcp
|
||||
sudo ufw allow 443/tcp
|
||||
sudo ufw deny 5984/tcp # CouchDB admin (internal only)
|
||||
sudo ufw enable
|
||||
```
|
||||
|
||||
#### **Container Security**
|
||||
|
||||
```bash
|
||||
# Run security scan
|
||||
docker scout cves meds-frontend:latest
|
||||
|
||||
# Update base images regularly
|
||||
docker compose build --no-cache
|
||||
```
|
||||
|
||||
### **Troubleshooting**
|
||||
|
||||
#### **Common Issues**
|
||||
|
||||
**1. Environment Variables Not Loading**
|
||||
|
||||
```bash
|
||||
# Check file format
|
||||
cat -A .env
|
||||
|
||||
# Verify Docker Compose config
|
||||
docker compose config
|
||||
```
|
||||
|
||||
**2. Database Connection Issues**
|
||||
|
||||
```bash
|
||||
# Test CouchDB connection
|
||||
curl -u admin:password http://localhost:5984/
|
||||
|
||||
# Check container logs
|
||||
docker compose logs couchdb
|
||||
```
|
||||
|
||||
**3. Email Not Sending**
|
||||
|
||||
```bash
|
||||
# Verify Mailgun configuration
|
||||
curl -s --user 'api:YOUR_API_KEY' \
|
||||
https://api.mailgun.net/v3/YOUR_DOMAIN/messages \
|
||||
-F from='test@YOUR_DOMAIN' \
|
||||
-F to='you@example.com' \
|
||||
-F subject='Test' \
|
||||
-F text='Testing'
|
||||
```
|
||||
|
||||
**4. Frontend Build Failures**
|
||||
|
||||
```bash
|
||||
# Clear cache and rebuild
|
||||
docker compose build --no-cache frontend
|
||||
```
|
||||
|
||||
### **Maintenance**
|
||||
|
||||
#### **Regular Tasks**
|
||||
|
||||
- Update dependencies monthly
|
||||
- Rotate credentials quarterly
|
||||
- Backup database daily
|
||||
- Monitor disk space weekly
|
||||
- Review security logs daily
|
||||
|
||||
#### **Update Process**
|
||||
|
||||
```bash
|
||||
# 1. Backup current deployment
|
||||
./backup.sh
|
||||
|
||||
# 2. Pull latest changes
|
||||
git pull origin main
|
||||
|
||||
# 3. Update dependencies
|
||||
bun install
|
||||
|
||||
# 4. Rebuild and deploy
|
||||
docker compose build --no-cache
|
||||
docker compose up -d
|
||||
|
||||
# 5. Verify deployment
|
||||
bun test-production.js
|
||||
```
|
||||
|
||||
### **Support and Documentation**
|
||||
|
||||
#### **Getting Help**
|
||||
|
||||
- GitHub Issues: Create issue for bugs/features
|
||||
- Documentation: Check README.md and docs/
|
||||
- Community: Join our Discord/Slack channel
|
||||
|
||||
#### **Professional Support**
|
||||
|
||||
- Enterprise support available
|
||||
- Custom deployment assistance
|
||||
- Security auditing services
|
||||
- Performance optimization consulting
|
||||
@@ -1,265 +0,0 @@
|
||||
# 🐳 Docker Image Configuration
|
||||
|
||||
## Overview
|
||||
|
||||
RxMinder now supports configurable Docker images via environment variables, enabling flexible deployment across different registries, environments, and versions.
|
||||
|
||||
## 🎯 Docker Image Variable
|
||||
|
||||
### **DOCKER_IMAGE**
|
||||
|
||||
The complete Docker image specification including registry, repository, and tag.
|
||||
|
||||
**Format:** `[registry/]repository:tag`
|
||||
|
||||
## 🌐 Registry Examples
|
||||
|
||||
### Public Registries
|
||||
|
||||
#### Docker Hub
|
||||
|
||||
```bash
|
||||
# Official image on Docker Hub
|
||||
DOCKER_IMAGE=rxminder/rxminder:latest
|
||||
DOCKER_IMAGE=rxminder/rxminder:v1.2.0
|
||||
DOCKER_IMAGE=rxminder/rxminder:stable
|
||||
```
|
||||
|
||||
#### GitHub Container Registry (ghcr.io)
|
||||
|
||||
```bash
|
||||
# GitHub Packages
|
||||
DOCKER_IMAGE=ghcr.io/username/rxminder:latest
|
||||
DOCKER_IMAGE=ghcr.io/organization/rxminder:v1.2.0
|
||||
DOCKER_IMAGE=ghcr.io/username/rxminder:dev-branch
|
||||
```
|
||||
|
||||
#### GitLab Container Registry
|
||||
|
||||
```bash
|
||||
# GitLab Registry
|
||||
DOCKER_IMAGE=registry.gitlab.com/username/rxminder:latest
|
||||
DOCKER_IMAGE=registry.gitlab.com/group/rxminder:production
|
||||
```
|
||||
|
||||
### Private/Self-Hosted Registries
|
||||
|
||||
#### Gitea Registry
|
||||
|
||||
```bash
|
||||
# Current default (Gitea)
|
||||
DOCKER_IMAGE=gitea-http.taildb3494.ts.net/will/meds:latest
|
||||
DOCKER_IMAGE=gitea-http.taildb3494.ts.net/will/meds:v1.2.0
|
||||
```
|
||||
|
||||
#### Harbor Registry
|
||||
|
||||
```bash
|
||||
# Harbor enterprise registry
|
||||
DOCKER_IMAGE=harbor.company.com/rxminder/rxminder:latest
|
||||
DOCKER_IMAGE=harbor.company.com/rxminder/rxminder:production
|
||||
```
|
||||
|
||||
#### Local Registry
|
||||
|
||||
```bash
|
||||
# Local development registry
|
||||
DOCKER_IMAGE=localhost:5000/rxminder:latest
|
||||
DOCKER_IMAGE=registry.local:5000/rxminder:dev
|
||||
```
|
||||
|
||||
### Cloud Provider Registries
|
||||
|
||||
#### AWS Elastic Container Registry (ECR)
|
||||
|
||||
```bash
|
||||
# AWS ECR
|
||||
DOCKER_IMAGE=123456789012.dkr.ecr.us-west-2.amazonaws.com/rxminder:latest
|
||||
DOCKER_IMAGE=123456789012.dkr.ecr.us-west-2.amazonaws.com/rxminder:v1.2.0
|
||||
```
|
||||
|
||||
#### Google Container Registry (GCR)
|
||||
|
||||
```bash
|
||||
# Google Cloud Registry
|
||||
DOCKER_IMAGE=gcr.io/project-id/rxminder:latest
|
||||
DOCKER_IMAGE=us.gcr.io/project-id/rxminder:production
|
||||
```
|
||||
|
||||
#### Azure Container Registry (ACR)
|
||||
|
||||
```bash
|
||||
# Azure Container Registry
|
||||
DOCKER_IMAGE=myregistry.azurecr.io/rxminder:latest
|
||||
DOCKER_IMAGE=myregistry.azurecr.io/rxminder:stable
|
||||
```
|
||||
|
||||
## 🏷️ Tagging Strategies
|
||||
|
||||
### Environment-Based Tagging
|
||||
|
||||
```bash
|
||||
# Development
|
||||
DOCKER_IMAGE=myregistry.com/rxminder:dev
|
||||
DOCKER_IMAGE=myregistry.com/rxminder:develop-20250906
|
||||
|
||||
# Staging
|
||||
DOCKER_IMAGE=myregistry.com/rxminder:staging
|
||||
DOCKER_IMAGE=myregistry.com/rxminder:release-candidate
|
||||
|
||||
# Production
|
||||
DOCKER_IMAGE=myregistry.com/rxminder:stable
|
||||
DOCKER_IMAGE=myregistry.com/rxminder:v1.2.0
|
||||
```
|
||||
|
||||
### Git-Based Tagging
|
||||
|
||||
```bash
|
||||
# Branch-based
|
||||
DOCKER_IMAGE=myregistry.com/rxminder:main
|
||||
DOCKER_IMAGE=myregistry.com/rxminder:feature-auth
|
||||
|
||||
# Commit-based
|
||||
DOCKER_IMAGE=myregistry.com/rxminder:sha-abc1234
|
||||
DOCKER_IMAGE=myregistry.com/rxminder:pr-123
|
||||
```
|
||||
|
||||
### Semantic Versioning
|
||||
|
||||
```bash
|
||||
# Semantic versions
|
||||
DOCKER_IMAGE=myregistry.com/rxminder:v1.0.0
|
||||
DOCKER_IMAGE=myregistry.com/rxminder:v1.2.3-beta
|
||||
DOCKER_IMAGE=myregistry.com/rxminder:v2.0.0-rc1
|
||||
```
|
||||
|
||||
## 🎪 Environment-Specific Configurations
|
||||
|
||||
### Development (.env)
|
||||
|
||||
```bash
|
||||
APP_NAME=rxminder-dev
|
||||
DOCKER_IMAGE=localhost:5000/rxminder:dev
|
||||
STORAGE_CLASS=local-path
|
||||
STORAGE_SIZE=5Gi
|
||||
INGRESS_HOST=rxminder-dev.local
|
||||
```
|
||||
|
||||
### Staging (.env.staging)
|
||||
|
||||
```bash
|
||||
APP_NAME=rxminder-staging
|
||||
DOCKER_IMAGE=myregistry.com/rxminder:staging
|
||||
STORAGE_CLASS=longhorn
|
||||
STORAGE_SIZE=10Gi
|
||||
INGRESS_HOST=staging.rxminder.company.com
|
||||
```
|
||||
|
||||
### Production (.env.production)
|
||||
|
||||
```bash
|
||||
APP_NAME=rxminder
|
||||
DOCKER_IMAGE=myregistry.com/rxminder:v1.2.0 # Fixed version for stability
|
||||
STORAGE_CLASS=fast-ssd
|
||||
STORAGE_SIZE=50Gi
|
||||
INGRESS_HOST=rxminder.company.com
|
||||
```
|
||||
|
||||
## 🚀 CI/CD Integration
|
||||
|
||||
### GitHub Actions Example
|
||||
|
||||
```yaml
|
||||
# .github/workflows/deploy.yml
|
||||
- name: Deploy to Kubernetes
|
||||
env:
|
||||
DOCKER_IMAGE: ghcr.io/${{ github.repository }}:${{ github.sha }}
|
||||
run: |
|
||||
echo "DOCKER_IMAGE=${DOCKER_IMAGE}" >> .env
|
||||
./scripts/k8s-deploy-template.sh deploy
|
||||
```
|
||||
|
||||
### GitLab CI Example
|
||||
|
||||
```yaml
|
||||
# .gitlab-ci.yml
|
||||
deploy:
|
||||
variables:
|
||||
DOCKER_IMAGE: $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
|
||||
script:
|
||||
- echo "DOCKER_IMAGE=${DOCKER_IMAGE}" >> .env
|
||||
- ./scripts/k8s-deploy-template.sh deploy
|
||||
```
|
||||
|
||||
## 🔒 Registry Authentication
|
||||
|
||||
### Docker Registry Secrets
|
||||
|
||||
```bash
|
||||
# Create registry secret for private registries
|
||||
kubectl create secret docker-registry regcred \
|
||||
--docker-server=myregistry.com \
|
||||
--docker-username=username \
|
||||
--docker-password=password \
|
||||
--docker-email=email@company.com
|
||||
|
||||
# Update deployment to use the secret
|
||||
# (Add imagePullSecrets to deployment template if needed)
|
||||
```
|
||||
|
||||
### Cloud Provider Authentication
|
||||
|
||||
```bash
|
||||
# AWS ECR
|
||||
aws ecr get-login-password --region us-west-2 | docker login --username AWS --password-stdin 123456789012.dkr.ecr.us-west-2.amazonaws.com
|
||||
|
||||
# Google GCR
|
||||
gcloud auth configure-docker
|
||||
|
||||
# Azure ACR
|
||||
az acr login --name myregistry
|
||||
```
|
||||
|
||||
## 💡 Best Practices
|
||||
|
||||
### Production Recommendations
|
||||
|
||||
- ✅ **Use specific tags** (not `:latest`) for production
|
||||
- ✅ **Pin to exact versions** for stability
|
||||
- ✅ **Use semantic versioning** for releases
|
||||
- ✅ **Separate registries** for different environments
|
||||
- ✅ **Enable vulnerability scanning** on registries
|
||||
|
||||
### Development Workflow
|
||||
|
||||
- ✅ **Use `:dev` or `:latest`** for development
|
||||
- ✅ **Branch-based tags** for feature development
|
||||
- ✅ **Local registries** for fast iteration
|
||||
- ✅ **Automated builds** on code changes
|
||||
|
||||
### Security Considerations
|
||||
|
||||
- ✅ **Private registries** for proprietary code
|
||||
- ✅ **Registry authentication** properly configured
|
||||
- ✅ **Image scanning** for vulnerabilities
|
||||
- ✅ **Supply chain security** with signed images
|
||||
|
||||
## 🎭 Example Deployments
|
||||
|
||||
### Multi-Environment Setup
|
||||
|
||||
```bash
|
||||
# Development
|
||||
export DOCKER_IMAGE=localhost:5000/rxminder:dev
|
||||
./scripts/k8s-deploy-template.sh deploy
|
||||
|
||||
# Staging
|
||||
export DOCKER_IMAGE=registry.company.com/rxminder:staging
|
||||
./scripts/k8s-deploy-template.sh deploy
|
||||
|
||||
# Production
|
||||
export DOCKER_IMAGE=registry.company.com/rxminder:v1.2.0
|
||||
./scripts/k8s-deploy-template.sh deploy
|
||||
```
|
||||
|
||||
This flexible Docker image configuration makes RxMinder truly **portable** and **CI/CD-ready** across any container registry and deployment environment!
|
||||
@@ -1,242 +0,0 @@
|
||||
# 🦌 Gitea CI/CD Setup Complete!
|
||||
|
||||
Your RxMinder app now has comprehensive Gitea Actions CI/CD support! Here's what's been created:
|
||||
|
||||
## 📁 New Files Structure
|
||||
|
||||
```
|
||||
.gitea/
|
||||
├── workflows/
|
||||
│ └── ci-cd.yml # Main CI/CD workflow
|
||||
├── docker-compose.ci.yml # CI-specific compose override
|
||||
├── gitea-bake.hcl # Gitea-optimized buildx config
|
||||
└── README.md # Detailed Gitea configuration guide
|
||||
|
||||
scripts/
|
||||
├── gitea-deploy.sh # Gitea-specific deployment script
|
||||
└── gitea-helper.sh # Comprehensive Gitea operations helper
|
||||
```
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### 1. **Setup Environment Configuration**
|
||||
|
||||
```bash
|
||||
# Copy the example environment file and customize
|
||||
cp .env.example .env
|
||||
|
||||
# Edit .env with your registry and configuration:
|
||||
CONTAINER_REGISTRY=gitea.yourdomain.com
|
||||
CONTAINER_REPOSITORY=username/rxminder
|
||||
GITEA_REGISTRY=gitea.yourdomain.com
|
||||
GITEA_REPOSITORY=username/rxminder
|
||||
```
|
||||
|
||||
### 2. **Setup Gitea Repository**
|
||||
|
||||
```bash
|
||||
# Configure in Gitea Repository Settings → Actions
|
||||
|
||||
# Required Secrets:
|
||||
GITEA_TOKEN # Personal access token with package write permissions
|
||||
VITE_COUCHDB_PASSWORD # CouchDB password
|
||||
DEPLOYMENT_WEBHOOK_URL # Optional: deployment notifications
|
||||
|
||||
# Repository Variables (optional - will use .env defaults):
|
||||
GITEA_REGISTRY # Override registry from .env
|
||||
VITE_COUCHDB_URL # http://localhost:5984
|
||||
VITE_COUCHDB_USER # admin
|
||||
APP_BASE_URL # http://localhost:8080
|
||||
```
|
||||
|
||||
### 3. **Local Development with Gitea**
|
||||
|
||||
```bash
|
||||
# Setup Gitea buildx builder
|
||||
bun run gitea:setup
|
||||
|
||||
# Build for local development
|
||||
bun run gitea:build-local
|
||||
|
||||
# Run tests
|
||||
bun run gitea:test
|
||||
|
||||
# Check status
|
||||
bun run gitea:status
|
||||
```
|
||||
|
||||
### 4. **Production Deployment**
|
||||
|
||||
```bash
|
||||
# Build and push to registry
|
||||
export GITEA_TOKEN=your_token
|
||||
export GITEA_REGISTRY=your-gitea.com
|
||||
export GITEA_REPOSITORY=username/rxminder
|
||||
|
||||
bun run gitea:build-prod v1.0.0
|
||||
|
||||
# Deploy to production
|
||||
bun run gitea:deploy production v1.0.0
|
||||
```
|
||||
|
||||
## 🔧 Gitea Actions Features
|
||||
|
||||
### **Multi-Platform Builds**
|
||||
|
||||
- ✅ AMD64 (Intel/AMD processors)
|
||||
- ✅ ARM64 (Apple Silicon, AWS Graviton)
|
||||
- ✅ Optimized layer caching
|
||||
- ✅ Registry-based build cache
|
||||
|
||||
### **Security & Quality**
|
||||
|
||||
- ✅ Trivy vulnerability scanning
|
||||
- ✅ Supply chain attestations (SBOM, provenance)
|
||||
- ✅ Dependency auditing
|
||||
- ✅ Lint and type checking
|
||||
|
||||
### **Deployment Options**
|
||||
|
||||
- ✅ Docker Compose deployment
|
||||
- ✅ Kubernetes deployment
|
||||
- ✅ Staging environment support
|
||||
- ✅ Health checks and monitoring
|
||||
|
||||
### **Automation**
|
||||
|
||||
- ✅ Automatic builds on push/PR
|
||||
- ✅ Multi-environment deployments
|
||||
- ✅ Image cleanup and maintenance
|
||||
- ✅ Deployment notifications
|
||||
|
||||
## 📋 Available Commands
|
||||
|
||||
### **Gitea Helper Script**
|
||||
|
||||
```bash
|
||||
./scripts/gitea-helper.sh setup # Setup buildx for Gitea
|
||||
./scripts/gitea-helper.sh build-local # Local development build
|
||||
./scripts/gitea-helper.sh build-multi # Multi-platform build
|
||||
./scripts/gitea-helper.sh build-staging # Staging build
|
||||
./scripts/gitea-helper.sh build-prod # Production build
|
||||
./scripts/gitea-helper.sh test # Run all tests
|
||||
./scripts/gitea-helper.sh deploy # Deploy to environment
|
||||
./scripts/gitea-helper.sh status # Show CI/CD status
|
||||
./scripts/gitea-helper.sh cleanup # Cleanup builders/images
|
||||
```
|
||||
|
||||
### **Package.json Scripts**
|
||||
|
||||
```bash
|
||||
bun run gitea:setup # Setup Gitea buildx
|
||||
bun run gitea:build # Multi-platform build
|
||||
bun run gitea:build-local # Local development
|
||||
bun run gitea:build-staging # Staging build
|
||||
bun run gitea:build-prod # Production build
|
||||
bun run gitea:test # Run tests
|
||||
bun run gitea:deploy # Deploy application
|
||||
bun run gitea:status # Check status
|
||||
bun run gitea:cleanup # Cleanup
|
||||
```
|
||||
|
||||
## 🎯 Workflow Triggers
|
||||
|
||||
### **Automatic Triggers**
|
||||
|
||||
- **Push to main/develop**: Full build, test, and deploy
|
||||
- **Pull Request**: Build, test, and security scan
|
||||
- **Manual dispatch**: On-demand deployment
|
||||
|
||||
### **Environment-Specific**
|
||||
|
||||
- **Development**: Fast single-platform builds
|
||||
- **Staging**: Full testing with staging configs
|
||||
- **Production**: Multi-platform with attestations
|
||||
|
||||
## 🔒 Security Features
|
||||
|
||||
### **Image Security**
|
||||
|
||||
- Vulnerability scanning with Trivy
|
||||
- Base image security updates
|
||||
- Minimal attack surface
|
||||
- Supply chain attestations
|
||||
|
||||
### **Secrets Management**
|
||||
|
||||
- Gitea-native secrets storage
|
||||
- Environment-specific variables
|
||||
- Token rotation support
|
||||
- Secure registry authentication
|
||||
|
||||
## 📊 Monitoring & Notifications
|
||||
|
||||
### **Health Checks**
|
||||
|
||||
- Frontend application health
|
||||
- Database connectivity
|
||||
- Service dependency checks
|
||||
- Container resource monitoring
|
||||
|
||||
### **Notifications**
|
||||
|
||||
- Deployment success/failure alerts
|
||||
- Security scan results
|
||||
- Build status updates
|
||||
- Custom webhook integration
|
||||
|
||||
## 🚀 Next Steps
|
||||
|
||||
1. **Configure Gitea Repository**:
|
||||
- Enable Actions in repository settings
|
||||
- Add required secrets and variables
|
||||
- Configure container registry
|
||||
|
||||
2. **Set up Gitea Runner**:
|
||||
- Install and configure Gitea Actions runner
|
||||
- Ensure Docker and buildx support
|
||||
- Configure appropriate labels
|
||||
|
||||
3. **Test the Pipeline**:
|
||||
|
||||
```bash
|
||||
# Push to trigger the workflow
|
||||
git add .
|
||||
git commit -m "Setup Gitea CI/CD"
|
||||
git push origin main
|
||||
```
|
||||
|
||||
4. **Customize for Your Environment**:
|
||||
- Update registry URLs in `.gitea/gitea-bake.hcl`
|
||||
- Modify deployment targets in `scripts/gitea-deploy.sh`
|
||||
- Configure environment-specific variables
|
||||
|
||||
## 🔄 Migration Notes
|
||||
|
||||
- ✅ **Fully compatible** with existing Docker Buildx setup
|
||||
- ✅ **No breaking changes** to development workflow
|
||||
- ✅ **Parallel support** with GitHub Actions if needed
|
||||
- ✅ **Easy rollback** - simply delete `.gitea/` directory
|
||||
|
||||
Your RxMinder app is now ready for professional-grade CI/CD with Gitea! 🎉
|
||||
|
||||
## 📞 Troubleshooting
|
||||
|
||||
### Common Issues:
|
||||
|
||||
1. **Build failures**: Check Gitea runner has Docker buildx
|
||||
2. **Registry push errors**: Verify GITEA_TOKEN permissions
|
||||
3. **Deployment issues**: Check environment variables and secrets
|
||||
|
||||
### Debug Commands:
|
||||
|
||||
```bash
|
||||
# Check Gitea environment
|
||||
./scripts/gitea-helper.sh status
|
||||
|
||||
# Test local build
|
||||
./scripts/gitea-helper.sh build-local
|
||||
|
||||
# Verify registry login
|
||||
docker login your-gitea.com
|
||||
```
|
||||
@@ -1,407 +0,0 @@
|
||||
# Production Build Guide
|
||||
|
||||
This guide explains how to properly configure and build the RxMinder application for production deployment.
|
||||
|
||||
## Overview
|
||||
|
||||
The RxMinder application has strict security validations that prevent production builds with default or insecure configurations. This ensures that production deployments are properly secured.
|
||||
|
||||
## Build Commands
|
||||
|
||||
### Development Build (Default)
|
||||
|
||||
```bash
|
||||
make build # Builds with development configuration
|
||||
NODE_ENV=development bun run build
|
||||
```
|
||||
|
||||
### Production Build
|
||||
|
||||
```bash
|
||||
make build-prod # Builds with production configuration
|
||||
bun run build # Requires proper production environment setup
|
||||
```
|
||||
|
||||
## Production Configuration Requirements
|
||||
|
||||
### Required Environment Variables
|
||||
|
||||
Before running a production build, you must set the following environment variables:
|
||||
|
||||
#### Authentication Secrets
|
||||
|
||||
```bash
|
||||
# Required: Change these from defaults
|
||||
JWT_SECRET=your-secure-jwt-secret-here
|
||||
SESSION_SECRET=your-secure-session-secret-here
|
||||
```
|
||||
|
||||
#### Database Configuration
|
||||
|
||||
```bash
|
||||
# Required for production deployments
|
||||
VITE_COUCHDB_URL=https://your-couchdb-instance.com
|
||||
COUCHDB_USER=your-couchdb-username
|
||||
COUCHDB_PASSWORD=your-couchdb-password
|
||||
```
|
||||
|
||||
#### Email Configuration (Optional)
|
||||
|
||||
```bash
|
||||
# Mailgun configuration
|
||||
MAILGUN_API_KEY=your-mailgun-api-key
|
||||
MAILGUN_DOMAIN=your-domain.com
|
||||
MAILGUN_FROM_NAME="Your App Name"
|
||||
MAILGUN_FROM_EMAIL=noreply@your-domain.com
|
||||
```
|
||||
|
||||
#### OAuth Configuration (Optional)
|
||||
|
||||
```bash
|
||||
# Google OAuth
|
||||
GOOGLE_CLIENT_ID=your-google-client-id
|
||||
GOOGLE_CLIENT_SECRET=your-google-client-secret
|
||||
|
||||
# GitHub OAuth
|
||||
GITHUB_CLIENT_ID=your-github-client-id
|
||||
GITHUB_CLIENT_SECRET=your-github-client-secret
|
||||
```
|
||||
|
||||
## Configuration Methods
|
||||
|
||||
### Method 1: Environment Variables
|
||||
|
||||
Set environment variables directly:
|
||||
|
||||
```bash
|
||||
export JWT_SECRET="your-secure-jwt-secret"
|
||||
export SESSION_SECRET="your-secure-session-secret"
|
||||
export VITE_COUCHDB_URL="https://your-couchdb.com"
|
||||
make build-prod
|
||||
```
|
||||
|
||||
### Method 2: .env File
|
||||
|
||||
Create a `.env.production` file:
|
||||
|
||||
```bash
|
||||
# Copy and modify the example
|
||||
cp .env.example .env.production
|
||||
|
||||
# Edit with your production values
|
||||
nano .env.production
|
||||
```
|
||||
|
||||
Then build:
|
||||
|
||||
```bash
|
||||
NODE_ENV=production make build-prod
|
||||
```
|
||||
|
||||
### Method 3: Generate Production Config
|
||||
|
||||
Use the unified configuration system:
|
||||
|
||||
```bash
|
||||
# Generate production configuration
|
||||
make generate-config-prod
|
||||
|
||||
# Then build
|
||||
make build-prod
|
||||
```
|
||||
|
||||
## Security Validations
|
||||
|
||||
The build process validates the following:
|
||||
|
||||
### Critical Errors (Will Fail Build)
|
||||
|
||||
- `JWT_SECRET` must not be the default value in production
|
||||
- `SESSION_SECRET` must not be the default value in production
|
||||
|
||||
### Warnings (Will Show But Allow Build)
|
||||
|
||||
- Missing OAuth client IDs (OAuth will be disabled)
|
||||
- Missing email configuration (Email features disabled)
|
||||
- Using default database URL (Will use mock database)
|
||||
|
||||
## Production Build Process
|
||||
|
||||
### 1. Validate Configuration
|
||||
|
||||
```bash
|
||||
# Check current configuration
|
||||
make config-debug
|
||||
|
||||
# Validate configuration
|
||||
make validate-config
|
||||
```
|
||||
|
||||
### 2. Set Production Environment
|
||||
|
||||
```bash
|
||||
export NODE_ENV=production
|
||||
```
|
||||
|
||||
### 3. Configure Secrets
|
||||
|
||||
```bash
|
||||
# Generate secure secrets
|
||||
export JWT_SECRET=$(openssl rand -base64 32)
|
||||
export SESSION_SECRET=$(openssl rand -base64 32)
|
||||
```
|
||||
|
||||
### 4. Build Application
|
||||
|
||||
```bash
|
||||
make build-prod
|
||||
```
|
||||
|
||||
### 5. Verify Build
|
||||
|
||||
```bash
|
||||
# Check dist directory
|
||||
ls -la dist/
|
||||
|
||||
# Test build locally
|
||||
make preview
|
||||
```
|
||||
|
||||
## Docker Production Build
|
||||
|
||||
### Using Docker Compose
|
||||
|
||||
```bash
|
||||
# Build production image
|
||||
docker-compose -f docker/docker-compose.prod.yml build
|
||||
|
||||
# Deploy with production configuration
|
||||
docker-compose -f docker/docker-compose.prod.yml up -d
|
||||
```
|
||||
|
||||
### Using Makefile
|
||||
|
||||
```bash
|
||||
# Build production Docker images
|
||||
make docker-build
|
||||
|
||||
# With production environment
|
||||
NODE_ENV=production make docker-build
|
||||
```
|
||||
|
||||
## Kubernetes Production Deployment
|
||||
|
||||
### 1. Generate Kubernetes Configuration
|
||||
|
||||
```bash
|
||||
# Generate production K8s configs
|
||||
make generate-config-prod
|
||||
```
|
||||
|
||||
### 2. Apply Configuration
|
||||
|
||||
```bash
|
||||
# Deploy to production
|
||||
make deploy-prod
|
||||
|
||||
# Check deployment status
|
||||
make status-prod
|
||||
```
|
||||
|
||||
### 3. Verify Deployment
|
||||
|
||||
```bash
|
||||
# Check differences before applying
|
||||
make diff-prod
|
||||
|
||||
# Validate configurations
|
||||
make validate-k8s
|
||||
```
|
||||
|
||||
## Environment-Specific Builds
|
||||
|
||||
### Development
|
||||
|
||||
```bash
|
||||
NODE_ENV=development make build
|
||||
# Uses development defaults, allows insecure configurations
|
||||
```
|
||||
|
||||
### Staging
|
||||
|
||||
```bash
|
||||
NODE_ENV=staging make build-prod
|
||||
# Uses staging configuration with production validations
|
||||
```
|
||||
|
||||
### Production
|
||||
|
||||
```bash
|
||||
NODE_ENV=production make build-prod
|
||||
# Requires all production security validations
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Error: "JWT_SECRET must be changed in production"
|
||||
|
||||
```bash
|
||||
# Solution: Set a secure JWT secret
|
||||
export JWT_SECRET=$(openssl rand -base64 32)
|
||||
export SESSION_SECRET=$(openssl rand -base64 32)
|
||||
make build-prod
|
||||
```
|
||||
|
||||
### Error: "Configuration validation failed"
|
||||
|
||||
```bash
|
||||
# Check what's missing
|
||||
make validate-config
|
||||
|
||||
# Debug current configuration
|
||||
make config-debug
|
||||
|
||||
# Generate complete configuration
|
||||
make generate-config-prod
|
||||
```
|
||||
|
||||
### Build Succeeds But Features Missing
|
||||
|
||||
Check warnings in build output:
|
||||
|
||||
- Missing OAuth: Set `GOOGLE_CLIENT_ID` and `GITHUB_CLIENT_ID`
|
||||
- Missing email: Set `MAILGUN_API_KEY` and `MAILGUN_DOMAIN`
|
||||
- Mock database: Set `VITE_COUCHDB_URL` to real database
|
||||
|
||||
## Security Best Practices
|
||||
|
||||
### Secret Management
|
||||
|
||||
1. **Never commit secrets** to version control
|
||||
2. **Use environment variables** or secure secret management
|
||||
3. **Rotate secrets regularly** in production
|
||||
4. **Use different secrets** for each environment
|
||||
|
||||
### Database Security
|
||||
|
||||
1. **Use HTTPS** for CouchDB connections
|
||||
2. **Configure authentication** with strong passwords
|
||||
3. **Limit database access** to application only
|
||||
4. **Regular backups** and security updates
|
||||
|
||||
### OAuth Security
|
||||
|
||||
1. **Restrict redirect URIs** to your domains only
|
||||
2. **Use HTTPS** for OAuth redirects
|
||||
3. **Regularly review** OAuth application permissions
|
||||
4. **Monitor OAuth usage** for suspicious activity
|
||||
|
||||
## CI/CD Integration
|
||||
|
||||
### GitHub Actions Example
|
||||
|
||||
```yaml
|
||||
- name: Build Production
|
||||
env:
|
||||
JWT_SECRET: ${{ secrets.JWT_SECRET }}
|
||||
SESSION_SECRET: ${{ secrets.SESSION_SECRET }}
|
||||
VITE_COUCHDB_URL: ${{ secrets.COUCHDB_URL }}
|
||||
run: make build-prod
|
||||
```
|
||||
|
||||
### GitLab CI Example
|
||||
|
||||
```yaml
|
||||
build:production:
|
||||
variables:
|
||||
NODE_ENV: 'production'
|
||||
script:
|
||||
- export JWT_SECRET="$PRODUCTION_JWT_SECRET"
|
||||
- export SESSION_SECRET="$PRODUCTION_SESSION_SECRET"
|
||||
- make build-prod
|
||||
```
|
||||
|
||||
## Performance Optimization
|
||||
|
||||
### Bundle Analysis
|
||||
|
||||
```bash
|
||||
# Build with bundle analysis
|
||||
ANALYZE=true make build-prod
|
||||
|
||||
# Check bundle size
|
||||
ls -lh dist/assets/
|
||||
```
|
||||
|
||||
### Code Splitting
|
||||
|
||||
The build automatically splits code for optimal loading:
|
||||
|
||||
- Main application bundle
|
||||
- Vendor dependencies
|
||||
- Dynamic imports for large features
|
||||
|
||||
### Compression
|
||||
|
||||
Production builds include:
|
||||
|
||||
- Gzip compression
|
||||
- Minification
|
||||
- Tree shaking
|
||||
- Dead code elimination
|
||||
|
||||
## Deployment Verification
|
||||
|
||||
### Health Checks
|
||||
|
||||
After deployment, verify:
|
||||
|
||||
1. Application loads without errors
|
||||
2. Database connection works
|
||||
3. Authentication functions properly
|
||||
4. Email notifications work (if configured)
|
||||
5. OAuth login works (if configured)
|
||||
|
||||
### Performance Checks
|
||||
|
||||
1. Initial load time < 3 seconds
|
||||
2. Bundle size reasonable (check warnings)
|
||||
3. No console errors in browser
|
||||
4. Proper caching headers set
|
||||
|
||||
## Rollback Procedures
|
||||
|
||||
### Quick Rollback
|
||||
|
||||
```bash
|
||||
# Rollback Kubernetes deployment
|
||||
kubectl rollout undo deployment/rxminder -n rxminder-prod
|
||||
|
||||
# Rollback Docker deployment
|
||||
docker-compose -f docker/docker-compose.prod.yml down
|
||||
# Deploy previous image version
|
||||
```
|
||||
|
||||
### Configuration Rollback
|
||||
|
||||
```bash
|
||||
# Revert to previous configuration
|
||||
git checkout HEAD~1 -- .env.production
|
||||
make build-prod
|
||||
make deploy-prod
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Deployment Guide](DEPLOYMENT.md) - General deployment instructions
|
||||
- [Docker Configuration](DOCKER_IMAGE_CONFIGURATION.md) - Docker setup
|
||||
- [Environment Variables](../ENVIRONMENT_VARIABLES.md) - All environment variables
|
||||
- [Security](../development/SECURITY.md) - Security guidelines
|
||||
|
||||
---
|
||||
|
||||
**Last Updated:** January 2024
|
||||
**Version:** 2.0.0
|
||||
**Status:** Production Ready
|
||||
@@ -1,226 +0,0 @@
|
||||
# 📦 Storage Configuration Examples
|
||||
|
||||
## Overview
|
||||
|
||||
RxMinder now supports configurable storage through environment variables, making it easy to adapt to different Kubernetes environments and storage requirements.
|
||||
|
||||
## 🗂️ Storage Configuration Variables
|
||||
|
||||
### **STORAGE_CLASS**
|
||||
|
||||
The Kubernetes StorageClass to use for persistent volumes.
|
||||
|
||||
**Common Options:**
|
||||
|
||||
- `longhorn` - Longhorn distributed storage (Raspberry Pi clusters)
|
||||
- `local-path` - Local path provisioner (k3s default)
|
||||
- `standard` - Cloud provider standard storage
|
||||
- `fast-ssd` - High-performance SSD storage
|
||||
- `gp2` - AWS General Purpose SSD
|
||||
- `pd-standard` - Google Cloud Standard Persistent Disk
|
||||
- `azure-disk` - Azure Standard Disk
|
||||
|
||||
### **STORAGE_SIZE**
|
||||
|
||||
The amount of storage to allocate for the CouchDB database.
|
||||
|
||||
**Sizing Guidelines:**
|
||||
|
||||
- `1Gi` - Minimal testing (not recommended for production)
|
||||
- `5Gi` - Small deployment (default, good for development)
|
||||
- `10Gi` - Medium deployment (suitable for small teams)
|
||||
- `20Gi` - Large deployment (production use)
|
||||
- `50Gi+` - Enterprise deployment (high-volume usage)
|
||||
|
||||
## 🎯 Environment-Specific Examples
|
||||
|
||||
### Development (.env)
|
||||
|
||||
```bash
|
||||
# Development environment
|
||||
APP_NAME=rxminder-dev
|
||||
STORAGE_CLASS=local-path
|
||||
STORAGE_SIZE=5Gi
|
||||
INGRESS_HOST=rxminder-dev.local
|
||||
```
|
||||
|
||||
### Staging (.env.staging)
|
||||
|
||||
```bash
|
||||
# Staging environment
|
||||
APP_NAME=rxminder-staging
|
||||
STORAGE_CLASS=longhorn
|
||||
STORAGE_SIZE=10Gi
|
||||
INGRESS_HOST=staging.rxminder.company.com
|
||||
```
|
||||
|
||||
### Production (.env.production)
|
||||
|
||||
```bash
|
||||
# Production environment
|
||||
APP_NAME=rxminder
|
||||
STORAGE_CLASS=fast-ssd
|
||||
STORAGE_SIZE=50Gi
|
||||
INGRESS_HOST=rxminder.company.com
|
||||
```
|
||||
|
||||
### Cloud Providers
|
||||
|
||||
#### AWS EKS
|
||||
|
||||
```bash
|
||||
APP_NAME=rxminder
|
||||
STORAGE_CLASS=gp2 # General Purpose SSD
|
||||
STORAGE_SIZE=20Gi
|
||||
INGRESS_HOST=rxminder.aws.company.com
|
||||
```
|
||||
|
||||
#### Google GKE
|
||||
|
||||
```bash
|
||||
APP_NAME=rxminder
|
||||
STORAGE_CLASS=pd-standard # Standard Persistent Disk
|
||||
STORAGE_SIZE=20Gi
|
||||
INGRESS_HOST=rxminder.gcp.company.com
|
||||
```
|
||||
|
||||
#### Azure AKS
|
||||
|
||||
```bash
|
||||
APP_NAME=rxminder
|
||||
STORAGE_CLASS=managed-premium # Premium SSD
|
||||
STORAGE_SIZE=20Gi
|
||||
INGRESS_HOST=rxminder.azure.company.com
|
||||
```
|
||||
|
||||
## 🏗️ Generated Kubernetes Resources
|
||||
|
||||
### Before (Hardcoded)
|
||||
|
||||
```yaml
|
||||
# Old approach - hardcoded values
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: couchdb-pvc
|
||||
spec:
|
||||
storageClassName: longhorn
|
||||
resources:
|
||||
requests:
|
||||
storage: 1Gi
|
||||
```
|
||||
|
||||
### After (Template-Based)
|
||||
|
||||
```yaml
|
||||
# Template: k8s/couchdb-pvc.yaml.template
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: ${APP_NAME}-couchdb-pvc
|
||||
labels:
|
||||
app: ${APP_NAME}
|
||||
spec:
|
||||
storageClassName: ${STORAGE_CLASS}
|
||||
resources:
|
||||
requests:
|
||||
storage: ${STORAGE_SIZE}
|
||||
```
|
||||
|
||||
### Deployed Result
|
||||
|
||||
```yaml
|
||||
# After envsubst processing
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: rxminder-couchdb-pvc
|
||||
labels:
|
||||
app: rxminder
|
||||
spec:
|
||||
storageClassName: fast-ssd
|
||||
resources:
|
||||
requests:
|
||||
storage: 20Gi
|
||||
```
|
||||
|
||||
## 🚀 Deployment Examples
|
||||
|
||||
### Quick Development Setup
|
||||
|
||||
```bash
|
||||
# Development with local storage
|
||||
export APP_NAME=rxminder-dev
|
||||
export STORAGE_CLASS=local-path
|
||||
export STORAGE_SIZE=5Gi
|
||||
./scripts/k8s-deploy-template.sh deploy
|
||||
```
|
||||
|
||||
### Production Deployment
|
||||
|
||||
```bash
|
||||
# Copy production environment
|
||||
cp .env.production .env
|
||||
# Edit with your specific values
|
||||
nano .env
|
||||
|
||||
# Deploy to production
|
||||
./scripts/k8s-deploy-template.sh deploy
|
||||
```
|
||||
|
||||
### Custom Configuration
|
||||
|
||||
```bash
|
||||
# Override specific values
|
||||
export STORAGE_CLASS=custom-storage
|
||||
export STORAGE_SIZE=100Gi
|
||||
./scripts/k8s-deploy-template.sh deploy
|
||||
```
|
||||
|
||||
## 🔍 Storage Class Discovery
|
||||
|
||||
### Find Available Storage Classes
|
||||
|
||||
```bash
|
||||
# List available storage classes in your cluster
|
||||
kubectl get storageclass
|
||||
|
||||
# Get details about a specific storage class
|
||||
kubectl describe storageclass longhorn
|
||||
```
|
||||
|
||||
### Common Storage Class Names by Platform
|
||||
|
||||
| Platform | Common Storage Classes |
|
||||
| -------------- | ------------------------------------------ |
|
||||
| **k3s** | `local-path` (default) |
|
||||
| **Longhorn** | `longhorn` |
|
||||
| **AWS EKS** | `gp2`, `gp3`, `io1`, `io2` |
|
||||
| **Google GKE** | `standard`, `ssd`, `pd-standard`, `pd-ssd` |
|
||||
| **Azure AKS** | `default`, `managed-premium` |
|
||||
| **Rancher** | `longhorn`, `local-path` |
|
||||
|
||||
## 💡 Benefits
|
||||
|
||||
### Flexibility
|
||||
|
||||
- ✅ **Environment-specific** storage configuration
|
||||
- ✅ **Cloud-agnostic** deployment
|
||||
- ✅ **Performance tuning** via storage class selection
|
||||
- ✅ **Cost optimization** through appropriate sizing
|
||||
|
||||
### Maintainability
|
||||
|
||||
- ✅ **Single source of truth** via `.env` files
|
||||
- ✅ **Easy scaling** by changing STORAGE_SIZE
|
||||
- ✅ **Environment promotion** using different .env files
|
||||
- ✅ **Disaster recovery** with consistent configurations
|
||||
|
||||
### Developer Experience
|
||||
|
||||
- ✅ **No hardcoded values** in manifests
|
||||
- ✅ **Clear documentation** of requirements
|
||||
- ✅ **Validation** of required variables
|
||||
- ✅ **Automated deployment** with proper storage setup
|
||||
|
||||
This approach makes RxMinder truly **portable** across different Kubernetes environments while maintaining **production-grade** storage management!
|
||||
Reference in New Issue
Block a user