From 40f54529a4452626f076177ed0d5998b172ff3b5 Mon Sep 17 00:00:00 2001 From: Sean Morley Date: Mon, 26 May 2025 16:55:00 -0400 Subject: [PATCH] Refactor environment variable names in .env.example and settings.py for consistency; add install script for streamlined setup --- .env.example | 6 +- backend/server/main/settings.py | 6 +- install_adventurelog.sh | 612 ++++++++++++++++++++++++++++++++ 3 files changed, 618 insertions(+), 6 deletions(-) create mode 100755 install_adventurelog.sh diff --git a/.env.example b/.env.example index 6ce0677..5b6886a 100644 --- a/.env.example +++ b/.env.example @@ -5,9 +5,9 @@ BODY_SIZE_LIMIT=Infinity # 🐘 PostgreSQL Database PGHOST=db -PGDATABASE=database -PGUSER=adventure -PGPASSWORD=changeme123 +POSTGRES_DB=database +POSTGRES_USER=adventure +POSTGRES_PASSWORD=changeme123 # 🔒 Django Backend SECRET_KEY=changeme123 diff --git a/backend/server/main/settings.py b/backend/server/main/settings.py index e7d3ace..505af80 100644 --- a/backend/server/main/settings.py +++ b/backend/server/main/settings.py @@ -105,9 +105,9 @@ ROOT_URLCONF = 'main.urls' DATABASES = { 'default': { 'ENGINE': 'django.contrib.gis.db.backends.postgis', - 'NAME': getenv('PGDATABASE'), - 'USER': getenv('PGUSER'), - 'PASSWORD': getenv('PGPASSWORD'), + 'NAME': getenv('PGDATABASE') or getenv('POSTGRES_DB'), + 'USER': getenv('PGUSER') or getenv('POSTGRES_USER'), + 'PASSWORD': getenv('PGPASSWORD') or getenv('POSTGRES_PASSWORD'), 'HOST': getenv('PGHOST'), 'PORT': getenv('PGPORT', 5432), 'OPTIONS': { diff --git a/install_adventurelog.sh b/install_adventurelog.sh new file mode 100755 index 0000000..b94c383 --- /dev/null +++ b/install_adventurelog.sh @@ -0,0 +1,612 @@ +#!/bin/bash +set -euo pipefail + +# ============================================================================= +# AdventureLog Ultimate Installer (Fixed) +# ============================================================================= + +APP_NAME="AdventureLog" +INSTALL_DIR="./adventurelog" +COMPOSE_FILE_URL="https://raw.githubusercontent.com/seanmorley15/AdventureLog/development/docker-compose.yml" +ENV_FILE_URL="https://raw.githubusercontent.com/seanmorley15/AdventureLog/development/.env.example" + +# Global configuration variables +declare -g FRONTEND_ORIGIN="" +declare -g BACKEND_URL="" +declare -g ADMIN_PASSWORD="" +declare -g DB_PASSWORD="" + +# Color codes for beautiful output +readonly RED='\033[0;31m' +readonly GREEN='\033[0;32m' +readonly YELLOW='\033[1;33m' +readonly BLUE='\033[0;34m' +readonly PURPLE='\033[0;35m' +readonly CYAN='\033[0;36m' +readonly BOLD='\033[1m' +readonly NC='\033[0m' # No Color + +# ============================================================================= +# Utility Functions +# ============================================================================= + +log_info() { + echo -e "${BLUE}ℹī¸ $1${NC}" +} + +log_success() { + echo -e "${GREEN}✅ $1${NC}" +} + +log_warning() { + echo -e "${YELLOW}⚠ī¸ $1${NC}" +} + +log_error() { + echo -e "${RED}❌ $1${NC}" +} + +log_header() { + echo -e "${PURPLE}$1${NC}" +} + +print_banner() { + cat << 'EOF' +╔══════════════════════════════════════════════════════════════════════╗ +║ ║ +║ 🌍 A D V E N T U R E L O G I N S T A L L E R ║ +║ ║ +║ The Ultimate Self-Hosted Adventure Tracking Platform ║ +║ ║ +╚══════════════════════════════════════════════════════════════════════╝ +EOF +} + +print_header() { + clear + echo "" + print_banner + echo "" + log_header "🚀 Starting installation — $(date)" + echo "" +} + +generate_secure_password() { + # Generate a 24-character password with mixed case, numbers, and safe symbols + local length=${1:-24} + + # Test if /dev/urandom exists + if [[ ! -r "/dev/urandom" ]]; then + echo "ERROR: /dev/urandom not readable" >&2 + return 1 + fi + + # Try the main approach + if command -v tr &>/dev/null; then + LC_ALL=C tr -dc 'A-Za-z0-9!#$%&*+-=?@^_' /dev/null | head -c "$length" 2>/dev/null + return 0 + fi + + # Fallback approach using od + if command -v od &>/dev/null; then + dd if=/dev/urandom bs=1 count=100 2>/dev/null | od -An -tx1 | tr -d ' \n' | cut -c1-"$length" + return 0 + fi + + # Last resort - use openssl if available + if command -v openssl &>/dev/null; then + openssl rand -base64 32 | tr -d "=+/" | cut -c1-"$length" + return 0 + fi + + echo "ERROR: No suitable random generation method found" >&2 + return 1 +} + +check_os() { + if [[ "$OSTYPE" == "darwin"* ]]; then + echo "macos" + elif [[ "$OSTYPE" == "linux-gnu"* ]]; then + echo "linux" + else + echo "unknown" + fi +} + +# ============================================================================= +# Validation Functions +# ============================================================================= + +validate_url() { + local url="$1" + if [[ $url =~ ^https?://[a-zA-Z0-9.-]+(:[0-9]+)?(/.*)?$ ]]; then + return 0 + else + return 1 + fi +} + +check_dependencies() { + log_info "Checking system dependencies..." + + local missing_deps=() + + if ! command -v curl &>/dev/null; then + missing_deps+=("curl") + fi + + if ! command -v docker &>/dev/null; then + missing_deps+=("docker") + fi + + if ! command -v docker-compose &>/dev/null && ! docker compose version &>/dev/null; then + missing_deps+=("docker-compose") + fi + + if [ ${#missing_deps[@]} -ne 0 ]; then + log_error "Missing dependencies: ${missing_deps[*]}" + echo "" + echo "Please install the missing dependencies:" + for dep in "${missing_deps[@]}"; do + case $dep in + "curl") + echo " â€ĸ curl: apt-get install curl (Ubuntu/Debian) or brew install curl (macOS)" + ;; + "docker") + echo " â€ĸ Docker: https://docs.docker.com/get-docker/" + ;; + "docker-compose") + echo " â€ĸ Docker Compose: https://docs.docker.com/compose/install/" + ;; + esac + done + exit 1 + fi + + log_success "All dependencies are installed" +} + +check_docker_status() { + log_info "Checking Docker daemon status..." + + if ! docker info &>/dev/null; then + log_error "Docker daemon is not running" + echo "" + echo "Please start Docker and try again:" + echo " â€ĸ On macOS/Windows: Start Docker Desktop" + echo " â€ĸ On Linux: sudo systemctl start docker" + exit 1 + fi + + log_success "Docker daemon is running" +} + +# ============================================================================= +# Installation Functions +# ============================================================================= + +create_directory() { + log_info "Setting up installation directory: $INSTALL_DIR" + + if [ -d "$INSTALL_DIR" ]; then + log_warning "Directory already exists" + echo "" + read -r -p "Do you want to continue and overwrite existing files? [y/N]: " confirm + if [[ ! $confirm =~ ^[Yy]$ ]]; then + echo "Installation cancelled." + exit 0 + fi + else + mkdir -p "$INSTALL_DIR" + log_success "Created directory: $INSTALL_DIR" + fi + + cd "$INSTALL_DIR" || { + log_error "Failed to change to directory: $INSTALL_DIR" + exit 1 + } +} + +download_files() { + log_info "Downloading configuration files..." + + # Download with better error handling + if ! curl -fsSL --connect-timeout 10 --max-time 30 "$COMPOSE_FILE_URL" -o docker-compose.yml; then + log_error "Failed to download docker-compose.yml" + exit 1 + fi + log_success "docker-compose.yml downloaded" + + if ! curl -fsSL --connect-timeout 10 --max-time 30 "$ENV_FILE_URL" -o .env; then + log_error "Failed to download .env template" + exit 1 + fi + log_success ".env template downloaded" +} + +prompt_configuration() { + echo "" + log_header "🛠ī¸ Configuration Setup" + echo "" + echo "Configure the URLs where AdventureLog will be accessible." + echo "Press Enter to use the default values shown in brackets." + echo "" + + # Frontend URL + local default_frontend="http://localhost:8015" + while true; do + read -r -p "🌐 Frontend URL [$default_frontend]: " input_frontend + FRONTEND_ORIGIN=${input_frontend:-$default_frontend} + + if validate_url "$FRONTEND_ORIGIN"; then + break + else + log_error "Invalid URL format. Please enter a valid URL (e.g., http://localhost:8015)" + fi + done + log_success "Frontend URL: $FRONTEND_ORIGIN" + + # Backend URL + local default_backend="http://localhost:8016" + while true; do + read -r -p "🔧 Backend URL [$default_backend]: " input_backend + BACKEND_URL=${input_backend:-$default_backend} + + if validate_url "$BACKEND_URL"; then + break + else + log_error "Invalid URL format. Please enter a valid URL (e.g., http://localhost:8016)" + fi + done + log_success "Backend URL: $BACKEND_URL" + + echo "" +} + +configure_environment_fallback() { + log_info "Using simple configuration approach..." + + # Generate simple passwords using a basic method + DB_PASSWORD="$(date +%s | sha256sum | base64 | head -c 32)" + ADMIN_PASSWORD="$(date +%s | sha256sum | base64 | head -c 24)" + + log_info "Generated passwords using fallback method" + + # Create backup + cp .env .env.backup + + # Use simple string replacement with perl if available + if command -v perl &>/dev/null; then + log_info "Using perl for configuration..." + # Fix: Update BOTH password variables for database consistency + perl -pi -e "s/^POSTGRES_PASSWORD=.*/POSTGRES_PASSWORD=$DB_PASSWORD/" .env + perl -pi -e "s/^POSTGRES_PASSWORD=.*/POSTGRES_PASSWORD=$DB_PASSWORD/" .env + perl -pi -e "s/^DJANGO_ADMIN_PASSWORD=.*/DJANGO_ADMIN_PASSWORD=$ADMIN_PASSWORD/" .env + perl -pi -e "s|^ORIGIN=.*|ORIGIN=$FRONTEND_ORIGIN|" .env + perl -pi -e "s|^PUBLIC_URL=.*|PUBLIC_URL=$BACKEND_URL|" .env + perl -pi -e "s|^CSRF_TRUSTED_ORIGINS=.*|CSRF_TRUSTED_ORIGINS=$FRONTEND_ORIGIN,$BACKEND_URL|" .env + perl -pi -e "s|^FRONTEND_URL=.*|FRONTEND_URL=$FRONTEND_ORIGIN|" .env + + if grep -q "POSTGRES_PASSWORD=$DB_PASSWORD" .env; then + log_success "Configuration completed successfully" + return 0 + fi + fi + + # Manual approach - create .env from scratch with key variables + log_info "Creating minimal .env configuration..." + cat > .env << EOF +# Database Configuration +POSTGRES_DB=adventurelog +POSTGRES_USER=adventurelog +POSTGRES_PASSWORD=$DB_PASSWORD +POSTGRES_PASSWORD=$DB_PASSWORD + +# Django Configuration +DJANGO_ADMIN_USERNAME=admin +DJANGO_ADMIN_PASSWORD=$ADMIN_PASSWORD +SECRET_KEY=$(openssl rand -base64 32 2>/dev/null || echo "change-this-secret-key-$(date +%s)") + +# URL Configuration +ORIGIN=$FRONTEND_ORIGIN +PUBLIC_URL=$BACKEND_URL +FRONTEND_URL=$FRONTEND_ORIGIN +CSRF_TRUSTED_ORIGINS=$FRONTEND_ORIGIN,$BACKEND_URL + +# Additional Settings +DEBUG=False +ALLOWED_HOSTS=* +EOF + + log_success "Created minimal .env configuration" + return 0 +} + +configure_environment() { + log_info "Generating secure configuration..." + + # Debug: Test password generation first + log_info "Testing password generation..." + if ! command -v tr &>/dev/null; then + log_error "tr command not found - required for password generation" + exit 1 + fi + + # Generate secure passwords with error checking + log_info "Generating database password..." + DB_PASSWORD=$(generate_secure_password 32) + if [[ -z "$DB_PASSWORD" ]]; then + log_error "Failed to generate database password" + exit 1 + fi + log_success "Database password generated (${#DB_PASSWORD} characters)" + + log_info "Generating admin password..." + ADMIN_PASSWORD=$(generate_secure_password 24) + if [[ -z "$ADMIN_PASSWORD" ]]; then + log_error "Failed to generate admin password" + exit 1 + fi + log_success "Admin password generated (${#ADMIN_PASSWORD} characters)" + + # Debug: Check if .env file exists and is readable + log_info "Checking .env file..." + if [[ ! -f ".env" ]]; then + log_error ".env file not found" + exit 1 + fi + + if [[ ! -r ".env" ]]; then + log_error ".env file is not readable" + exit 1 + fi + + log_info "File check passed - .env exists and is readable ($(wc -l < .env) lines)" + + # Try fallback method first (simpler and more reliable) + log_info "Attempting configuration..." + if configure_environment_fallback; then + return 0 + fi + + log_warning "Fallback method failed, trying advanced processing..." + + # Fallback to bash processing + # Create backup of original .env + cp .env .env.backup + + # Create a new .env file by processing the original line by line + local temp_file=".env.temp" + local processed_lines=0 + local updated_lines=0 + + while IFS= read -r line || [[ -n "$line" ]]; do + ((processed_lines++)) + case "$line" in + POSTGRES_PASSWORD=*) + echo "POSTGRES_PASSWORD=$DB_PASSWORD" + ((updated_lines++)) + ;; + POSTGRES_PASSWORD=*) + echo "POSTGRES_PASSWORD=$DB_PASSWORD" + ((updated_lines++)) + ;; + DJANGO_ADMIN_PASSWORD=*) + echo "DJANGO_ADMIN_PASSWORD=$ADMIN_PASSWORD" + ((updated_lines++)) + ;; + ORIGIN=*) + echo "ORIGIN=$FRONTEND_ORIGIN" + ((updated_lines++)) + ;; + PUBLIC_URL=*) + echo "PUBLIC_URL=$BACKEND_URL" + ((updated_lines++)) + ;; + CSRF_TRUSTED_ORIGINS=*) + echo "CSRF_TRUSTED_ORIGINS=$FRONTEND_ORIGIN,$BACKEND_URL" + ((updated_lines++)) + ;; + FRONTEND_URL=*) + echo "FRONTEND_URL=$FRONTEND_ORIGIN" + ((updated_lines++)) + ;; + *) + echo "$line" + ;; + esac + done < .env > "$temp_file" + + log_info "Processed $processed_lines lines, updated $updated_lines configuration values" + + # Check if temp file was created successfully + if [[ ! -f "$temp_file" ]]; then + log_error "Failed to create temporary configuration file" + exit 1 + fi + + # Replace the original .env with the configured one + if mv "$temp_file" .env; then + log_success "Environment configured with secure passwords" + else + log_error "Failed to replace .env file" + log_info "Restoring backup and exiting" + mv .env.backup .env + rm -f "$temp_file" + exit 1 + fi + + # Verify critical configuration was applied + if grep -q "POSTGRES_PASSWORD=$DB_PASSWORD" .env && grep -q "POSTGRES_PASSWORD=$DB_PASSWORD" .env; then + log_success "Configuration verification passed - both database password variables set" + else + log_error "Configuration verification failed - database passwords not properly configured" + log_info "Showing database-related lines in .env for debugging:" + grep -E "(POSTGRES_PASSWORD|POSTGRES_PASSWORD)" .env | while read -r line; do + echo " $line" + done + mv .env.backup .env + exit 1 + fi +} + +start_services() { + log_info "Starting AdventureLog services..." + echo "" + + # Use docker compose or docker-compose based on availability + local compose_cmd + if docker compose version &>/dev/null; then + compose_cmd="docker compose" + else + compose_cmd="docker-compose" + fi + + # Pull images first for better progress indication + log_info "Pulling required Docker images..." + $compose_cmd pull + + # Start services + log_info "Starting containers..." + if $compose_cmd up -d --remove-orphans; then + log_success "All services started successfully" + else + log_error "Failed to start services" + echo "" + log_info "Checking service status..." + $compose_cmd ps + exit 1 + fi +} + +wait_for_services() { + log_info "Waiting for services to be ready..." + + local max_attempts=30 + local attempt=1 + + while [ $attempt -le $max_attempts ]; do + if curl -s -o /dev/null -w "%{http_code}" "$FRONTEND_ORIGIN" | grep -q "200\|404\|302"; then + log_success "Frontend is responding" + break + fi + + if [ $attempt -eq $max_attempts ]; then + log_warning "Frontend may still be starting up (this is normal for first run)" + break + fi + + printf "." + sleep 2 + ((attempt++)) + done + echo "" +} + +# ============================================================================= +# Output Functions +# ============================================================================= + +print_success_message() { + local ip_address + ip_address=$(hostname -I 2>/dev/null | cut -d' ' -f1 || echo "localhost") + + clear + echo "" + cat << 'EOF' +╔══════════════════════════════════════════════════════════════════════╗ +║ ║ +║ 🎉 A D V E N T U R E L O G I N S T A L L E D ! ║ +║ ║ +╚══════════════════════════════════════════════════════════════════════╝ +EOF + echo "" + + log_success "Installation completed successfully!" + echo "" + + echo -e "${BOLD}📍 Access Points:${NC}" + echo -e " 🌐 Frontend: ${CYAN}$FRONTEND_ORIGIN${NC}" + echo -e " 🔧 Backend: ${CYAN}$BACKEND_URL${NC}" + + if [[ "$FRONTEND_ORIGIN" == *"localhost"* ]]; then + echo -e " 🏠 Local IP: ${CYAN}http://$ip_address:8015${NC}" + fi + + echo "" + echo -e "${BOLD}🔐 Admin Credentials:${NC}" + echo -e " Username: ${GREEN}admin${NC}" + echo -e " Password: ${GREEN}$ADMIN_PASSWORD${NC}" + + echo "" + echo -e "${BOLD}📁 Important Locations:${NC}" + echo -e " Config: ${YELLOW}$(pwd)/.env${NC}" + echo -e " Data: ${YELLOW}adventurelog_media Docker volume${NC}" + echo -e " Logs: ${YELLOW}docker compose logs -f${NC}" + + echo "" + echo -e "${BOLD}🛠ī¸ Management Commands:${NC}" + echo -e " Stop: ${CYAN}docker compose down${NC}" + echo -e " Start: ${CYAN}docker compose up -d${NC}" + echo -e " Update: ${CYAN}docker compose pull && docker compose up -d${NC}" + echo -e " Logs: ${CYAN}docker compose logs -f${NC}" + + echo "" + log_info "Save your admin password in a secure location!" + echo "" +} + +print_failure_message() { + echo "" + log_error "Installation failed!" + echo "" + echo "Troubleshooting steps:" + echo "1. Check Docker is running: docker info" + echo "2. Check available ports: netstat -an | grep :801[56]" + echo "3. View logs: docker compose logs" + echo "4. Check .env configuration: cat .env" + echo "" + echo "For support, visit: https://github.com/seanmorley15/AdventureLog" +} + +cleanup_on_failure() { + log_info "Cleaning up after failure..." + + if [ -f ".env.backup" ]; then + mv .env.backup .env + log_info "Restored original .env file" + fi + + if command -v docker &>/dev/null; then + docker compose down --remove-orphans 2>/dev/null || true + fi +} + +# ============================================================================= +# Main Installation Flow +# ============================================================================= + +main() { + # Set up error handling + trap 'cleanup_on_failure; print_failure_message; exit 1' ERR + + # Installation steps + print_header + check_dependencies + check_docker_status + create_directory + download_files + prompt_configuration + configure_environment + start_services + wait_for_services + print_success_message + + # Clean up backup file on success + rm -f .env.backup +} + +# Script entry point +if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then + main "$@" +fi \ No newline at end of file