Merge pull request #93 from Worklenz/development

Development

Author: chamikaJ

.env

@@ -358,34 +358,88 @@ const s3Client = new S3Client({
 
 ### Environment Configuration
 
-The `.env` file includes the necessary configuration for using MinIO:
+The project uses the following environment file structure:
 
+- **Frontend**:
+  - `worklenz-frontend/.env.development` - Development environment variables
+  - `worklenz-frontend/.env.production` - Production build variables
+  
+- **Backend**:
+  - `worklenz-backend/.env` - Backend environment variables
+
+### Setting Up Environment Files
+
+The Docker environment script will create or overwrite all environment files:
+
+```bash
+# For HTTP/WS
+./update-docker-env.sh your-hostname
+
+# For HTTPS/WSS
+./update-docker-env.sh your-hostname true
 ```
-STORAGE_PROVIDER=s3
-AWS_REGION=us-east-1
-AWS_BUCKET=worklenz-bucket
-S3_ACCESS_KEY_ID=minioadmin
-S3_SECRET_ACCESS_KEY=minioadmin
-S3_URL=http://minio:9000
-```
 
-When the backend service starts, it will use these environment variables to connect to MinIO for file storage.
+This script generates properly configured environment files for both development and production environments.
+
+## Docker Deployment
 
-## Development
+### Local Development with Docker
+
+1. Set up the environment files:
+   ```bash
+   # For HTTP/WS
+   ./update-docker-env.sh
+   
+   # For HTTPS/WSS
+   ./update-docker-env.sh localhost true
+   ```
+
+2. Run the application using Docker Compose:
+   ```bash
+   docker-compose up -d
+   ```
 
-For development, you can use the provided Docker setup which includes all necessary dependencies. The code will be running inside containers, but you can still edit files locally and see changes reflected in real-time.
+3. Access the application:
+   - Frontend: http://localhost:5000
+   - Backend API: http://localhost:3000 (or https://localhost:3000 with SSL)
+
+### Remote Server Deployment
+
+When deploying to a remote server:
+
+1. Set up the environment files with your server's hostname:
+   ```bash
+   # For HTTP/WS
+   ./update-docker-env.sh your-server-hostname
+   
+   # For HTTPS/WSS
+   ./update-docker-env.sh your-server-hostname true
+   ```
+   
+   This ensures that the frontend correctly connects to the backend API.
+
+2. Pull and run the latest Docker images:
+   ```bash
+   docker-compose pull
+   docker-compose up -d
+   ```
+
+3. Access the application through your server's hostname:
+   - Frontend: http://your-server-hostname:5000
+   - Backend API: http://your-server-hostname:3000
+
+### Environment Configuration
 
-## Production Deployment
+The Docker setup uses environment variables to configure the services:
 
-For production deployment:
+- Frontend:
+  - `VITE_API_URL`: URL of the backend API (default: http://backend:3000 for container networking)
+  - `VITE_SOCKET_URL`: WebSocket URL for real-time communication (default: ws://backend:3000)
 
-1. Update the `.env` file with production settings
-2. Build custom Docker images or use the provided ones
-3. Deploy using Docker Compose or a container orchestration platform like Kubernetes
+- Backend:
+  - Database connection parameters
+  - Storage configuration
+  - Other backend settings
 
-For MinIO in production, consider:
-- Setting up proper credentials (change default minioadmin/minioadmin)
-- Configuring persistent storage
-- Setting up proper networking and access controls
-- Using multiple MinIO instances for high availability
+For custom configuration, edit the `.env` file or the `update-docker-env.sh` script.
 

.env.example

@@ -1,12 +1,16 @@
 services:
   frontend:
-    image: docker.io/chamikajaycey/worklenz-frontend:latest
+    build:
+      context: ./worklenz-frontend
+      dockerfile: Dockerfile
     container_name: worklenz_frontend
     ports:
       - "5000:5000"
     depends_on:
       backend:
         condition: service_started
+    env_file:
+      - ./worklenz-frontend/.env.production
     networks:
       - worklenz
 
@@ -20,36 +24,8 @@ services:
         condition: service_healthy
       minio:
         condition: service_started
-    environment:
-      - AWS_REGION=${AWS_REGION:-us-east-1}
-      - BACKEND_PUBLIC_DIR
-      - BACKEND_VIEWS_DIR
-      - COMMIT_BUILD_IMMEDIATELY
-      - COOKIE_SECRET
-      - DB_HOST=${DB_HOST:-db}
-      - DB_MAX_CLIENTS
-      - DB_NAME=${DB_NAME:-worklenz_db}
-      - DB_PASSWORD=${DB_PASSWORD:-password}
-      - DB_PORT=${DB_PORT:-5432}
-      - DB_USER=${DB_USER:-postgres}
-      - GOOGLE_CALLBACK_URL
-      - GOOGLE_CLIENT_ID
-      - GOOGLE_CLIENT_SECRET
-      - HOSTNAME
-      - LOGIN_FAILURE_REDIRECT
-      - NODE_ENV=${NODE_ENV:-development}
-      - PORT=${PORT:-3000}
-      - SESSION_NAME
-      - SESSION_SECRET
-      - SLACK_WEBHOOK
-      - SOCKET_IO_CORS
-      - SOURCE_EMAIL
-      - USE_PG_NATIVE
-      - STORAGE_PROVIDER=${STORAGE_PROVIDER:-s3}
-      - AWS_BUCKET=${BUCKET:-worklenz-bucket}
-      - AWS_ACCESS_KEY_ID=${S3_ACCESS_KEY_ID:-minioadmin}
-      - AWS_SECRET_ACCESS_KEY=${S3_SECRET_ACCESS_KEY:-minioadmin}
-      - S3_URL=${S3_URL:-http://minio:9000}
+    env_file:
+      - ./worklenz-backend/.env
     networks:
       - worklenz
 
@@ -113,7 +89,23 @@ services:
       - worklenz
     volumes:
       - worklenz_postgres_data:/var/lib/postgresql/data
-      - ./worklenz-backend/database/:/docker-entrypoint-initdb.d
+      - type: bind
+        source: ./worklenz-backend/database
+        target: /docker-entrypoint-initdb.d
+        consistency: cached
+    command: >
+      bash -c '
+      if command -v apt-get >/dev/null 2>&1; then
+        apt-get update && apt-get install -y dos2unix
+      elif command -v apk >/dev/null 2>&1; then
+        apk add --no-cache dos2unix
+      fi &&
+      find /docker-entrypoint-initdb.d -type f -name "*.sh" -exec sh -c '\''
+        dos2unix "{}" 2>/dev/null || true
+        chmod +x "{}"
+      '\'' \; &&
+      exec docker-entrypoint.sh postgres
+      '
 
 volumes:
   worklenz_postgres_data:

README.md

@@ -0,0 +1,133 @@
+#!/bin/bash
+
+# Script to set environment variables for Docker deployment
+# Usage: ./update-docker-env.sh [hostname] [use_ssl]
+
+# Default hostname if not provided
+DEFAULT_HOSTNAME="localhost"
+HOSTNAME=${1:-$DEFAULT_HOSTNAME}
+
+# Check if SSL should be used
+USE_SSL=${2:-false}
+
+# Set protocol prefixes based on SSL flag
+if [ "$USE_SSL" = "true" ]; then
+  HTTP_PREFIX="https://"
+  WS_PREFIX="wss://"
+else
+  HTTP_PREFIX="http://"
+  WS_PREFIX="ws://"
+fi
+
+# Frontend URLs
+FRONTEND_URL="${HTTP_PREFIX}${HOSTNAME}:5000"
+MINIO_DASHBOARD_URL="${HTTP_PREFIX}${HOSTNAME}:9001"
+
+# Create or overwrite frontend .env.development file
+mkdir -p worklenz-frontend
+cat > worklenz-frontend/.env.development << EOL
+# API Connection
+VITE_API_URL=http://localhost:3000
+VITE_SOCKET_URL=ws://localhost:3000
+
+# Application Environment
+VITE_APP_TITLE=Worklenz
+VITE_APP_ENV=development
+
+# Mixpanel
+VITE_MIXPANEL_TOKEN=
+
+# Recaptcha
+VITE_ENABLE_RECAPTCHA=false
+VITE_RECAPTCHA_SITE_KEY=
+
+# Session ID
+VITE_WORKLENZ_SESSION_ID=worklenz-session-id
+EOL
+
+# Create frontend .env.production file
+cat > worklenz-frontend/.env.production << EOL
+# API Connection
+VITE_API_URL=${HTTP_PREFIX}${HOSTNAME}:3000
+VITE_SOCKET_URL=${WS_PREFIX}${HOSTNAME}:3000
+
+# Application Environment
+VITE_APP_TITLE=Worklenz
+VITE_APP_ENV=production
+
+# Mixpanel
+VITE_MIXPANEL_TOKEN=
+
+# Recaptcha
+VITE_ENABLE_RECAPTCHA=false
+VITE_RECAPTCHA_SITE_KEY=
+
+# Session ID
+VITE_WORKLENZ_SESSION_ID=worklenz-session-id
+EOL
+
+# Create backend environment file
+mkdir -p worklenz-backend
+cat > worklenz-backend/.env << EOL
+# Server
+NODE_ENV=production
+PORT=3000
+SESSION_NAME=worklenz.sid
+SESSION_SECRET=change_me_in_production
+COOKIE_SECRET=change_me_in_production
+
+# CORS
+SOCKET_IO_CORS=${FRONTEND_URL}
+SERVER_CORS=${FRONTEND_URL}
+
+# Database
+DB_HOST=db
+DB_PORT=5432
+DB_USER=postgres
+DB_PASSWORD=password
+DB_NAME=worklenz_db
+DB_MAX_CLIENTS=50
+USE_PG_NATIVE=true
+
+# Storage Configuration
+STORAGE_PROVIDER=s3
+AWS_REGION=us-east-1
+AWS_BUCKET=worklenz-bucket
+AWS_ACCESS_KEY_ID=minioadmin
+AWS_SECRET_ACCESS_KEY=minioadmin
+S3_URL=http://minio:9000
+
+# Backend Directories
+BACKEND_PUBLIC_DIR=./public
+BACKEND_VIEWS_DIR=./views
+
+# Host
+HOSTNAME=${HOSTNAME}
+FRONTEND_URL=${FRONTEND_URL}
+
+# Email
+SOURCE_EMAIL=no-reply@example.com
+
+# Notifications
+SLACK_WEBHOOK=
+
+# Other Settings
+COMMIT_BUILD_IMMEDIATELY=true
+
+# JWT Secret
+JWT_SECRET=change_me_in_production
+EOL
+
+echo "Environment configuration updated for ${HOSTNAME} with" $([ "$USE_SSL" = "true" ] && echo "HTTPS/WSS" || echo "HTTP/WS")
+echo "Created/updated environment files:"
+echo "- worklenz-frontend/.env.development (development)"
+echo "- worklenz-frontend/.env.production (production build)"
+echo "- worklenz-backend/.env"
+echo
+echo "To run with Docker Compose, use: docker-compose up -d"
+echo
+echo "Frontend URL: ${FRONTEND_URL}"
+echo "API URL: ${HTTP_PREFIX}${HOSTNAME}:3000"
+echo "Socket URL: ${WS_PREFIX}${HOSTNAME}:3000"
+echo "MinIO Dashboard URL: ${MINIO_DASHBOARD_URL}"
+echo "CORS is configured to allow requests from: ${FRONTEND_URL}"