feat: Update deployment instructions to support optional MongoDB configurations (#27)

Author: dev-bre

DEPLOYMENT.md

@@ -51,15 +51,40 @@ nano .env
 
 Update the following variables:
 - `DOMAIN`: Your domain name (e.g., `trakrlog.com` or `api.trakrlog.com`)
-- `MONGODB_URL`: MongoDB connection string (e.g., `mongodb://admin:your_password@mongo:27017`)
+- `MONGODB_URL`: MongoDB connection string
+  - For local container: `mongodb://admin:your_password@mongo:27017`
+  - For MongoDB Atlas: `mongodb+srv://user:pass@cluster.mongodb.net/`
+  - For other external MongoDB: Use your provider's connection string
 - `MONGODB_DATABASE`: Database name (default: `trakrlog`)
-- `MONGODB_PASSWORD`: MongoDB password (must match the password in MONGODB_URL)
+- `MONGODB_PASSWORD`: MongoDB root password (only needed for local container)
 - `SESSION_SECRET`: Generate with `openssl rand -hex 32`
 - `GOOGLE_CLIENT_ID`: Your Google OAuth client ID
 - `GOOGLE_CLIENT_SECRET`: Your Google OAuth client secret
 - `GOOGLE_CALLBACK_URL`: `https://yourdomain.com/auth/google/callback`
 
-### 4. Configure Google OAuth
+### 4. Choose MongoDB Deployment Option
+
+**Option A: Use MongoDB Atlas (Recommended for Production)**
+
+1. Create a free account at [MongoDB Atlas](https://www.mongodb.com/cloud/atlas)
+2. Create a new cluster
+3. Get your connection string (looks like `mongodb+srv://...`)
+4. Set `MONGODB_URL` to your Atlas connection string in `.env`
+5. Deploy without local MongoDB:
+   ```bash
+   docker compose -f docker-compose.prod.yml up -d
+   ```
+
+**Option B: Use Local MongoDB Container**
+
+1. Set `MONGODB_URL=mongodb://admin:yourpassword@mongo:27017` in `.env`
+2. Set `MONGODB_PASSWORD=yourpassword` in `.env`
+3. Deploy with local MongoDB:
+   ```bash
+   docker compose -f docker-compose.prod.yml --profile local-db up -d
+   ```
+
+### 5. Configure Google OAuth
 
 1. Go to [Google Cloud Console](https://console.cloud.google.com/)
 2. Create a new project or select an existing one
@@ -69,27 +94,44 @@ Update the following variables:
    - `https://yourdomain.com/auth/google/callback` (production)
    - `http://localhost:4000/auth/google/callback` (local development)
 
-### 5. Build and deploy
+### 6. Build and deploy
 
 ```bash
-# Build and start all services
+# Build and start all services (with external MongoDB like Atlas)
 docker compose -f docker-compose.prod.yml up -d --build
 
+# OR: Build and start with local MongoDB container
+docker compose -f docker-compose.prod.yml --profile local-db up -d --build
+
 # View logs
 docker compose -f docker-compose.prod.yml logs -f
 
 # Check service status
 docker compose -f docker-compose.prod.yml ps
 ```
 
-### 6. Verify deployment
+### 7. Verify deployment
 
 - Visit `https://yourdomain.com` - should show your frontend
-- Visit `https://yourdomain.com/api/health` - should return health status
-- Try logging in with Google OAuth
-
 ## Architecture
 
+**With External MongoDB (e.g., Atlas):**
+```
+┌─────────────────┐
+│   Internet      │
+└────────┬────────┘
+         │
+    ┌────▼────┐
+    │  Caddy  │ :80, :443 (Reverse Proxy + SSL)
+    └────┬────┘
+         │
+    ┌────▼────┐                    ┌──────────────┐
+    │   App   │ :4000 ────────────►│ MongoDB Atlas│
+    └─────────┘                    │  (External)  │
+                                   └──────────────┘
+```
+
+**With Local MongoDB Container:**
 ```
 ┌─────────────────┐
 │   Internet      │
@@ -110,7 +152,11 @@ docker compose -f docker-compose.prod.yml ps
 
 ## Services
 
-### MongoDB
+### MongoDB (Optional - use --profile local-db)
+- Internal port: 27017 (when using local container)
+- Data persisted in Docker volume: `mongo_data`
+- Credentials configured via environment variables
+- **Alternative**: Use MongoDB Atlas or any external MongoDB service
 - Internal port: 27017
 - Data persisted in Docker volume: `mongo_data`
 - Credentials configured via environment variables

docker-compose.local.yml

@@ -1,8 +1,10 @@
 services:
-  # MongoDB Database
+  # MongoDB Database (optional - enable with --profile local-db)
   mongo:
     image: mongo:7
     restart: unless-stopped
+    profiles:
+      - local-db  # Only starts if 'local-db' profile is enabled
     ports:
       - "27018:27017"  # Use 27018 externally to avoid conflict with local MongoDB
     environment:
@@ -35,9 +37,11 @@ services:
       GOOGLE_CLIENT_SECRET: ${GOOGLE_CLIENT_SECRET}
       GOOGLE_CALLBACK_URL: ${GOOGLE_CALLBACK_URL:-http://localhost:4000/auth/google/callback}
       APP_ENV: development
-    depends_on:
-      mongo:
-        condition: service_healthy
+    # Note: depends_on removed by default - set MONGODB_URL to external DB or use --profile local-db
+    # If using local mongo profile, uncomment the depends_on section below
+    # depends_on:
+    #   mongo:
+    #     condition: service_healthy
     networks:
       - trakrlog-network
     healthcheck:

docker-compose.prod.yml

@@ -1,8 +1,10 @@
 services:
-  # MongoDB Database
+  # MongoDB Database (optional - only used if not connecting to external MongoDB like Atlas)
   mongo:
     image: mongo:7
     restart: unless-stopped
+    profiles:
+      - local-db  # Only starts if 'local-db' profile is enabled
     environment:
       # Extract password from MONGODB_URL (format: mongodb://user:pass@host:port)
       MONGO_INITDB_ROOT_USERNAME: admin
@@ -24,16 +26,15 @@ services:
     restart: unless-stopped
     environment:
       PORT: 4000
+      # Use external MongoDB by default (e.g., Atlas)
+      # For local MongoDB container, use: MONGODB_URL=mongodb://admin:yourpassword@mongo:27017
       MONGODB_URL: ${MONGODB_URL}
       MONGODB_DATABASE: ${MONGODB_DATABASE}
       SESSION_SECRET: ${SESSION_SECRET}
       GOOGLE_CLIENT_ID: ${GOOGLE_CLIENT_ID}
       GOOGLE_CLIENT_SECRET: ${GOOGLE_CLIENT_SECRET}
       GOOGLE_CALLBACK_URL: ${GOOGLE_CALLBACK_URL}
       APP_ENV: production
-    depends_on:
-      mongo:
-        condition: service_healthy
     networks:
       - trakrlog-network
     healthcheck: