Add Bitwarden, setup script, remove redundant files, update disk requirements, and add LinuxServer preference

- Add Vaultwarden (Bitwarden) password manager to utilities.yml - Self-hosted password manager with web UI - SMTP configuration for email notifications - Admin token for management - Access at bitwarden.${DOMAIN} - Protected by Authelia SSO - Create automated first-run setup script (scripts/setup-homelab.sh) - Installs Docker Engine and Compose V2 - Configures user groups (sudo, docker) - Enables SSH for remote management - Detects NVIDIA GPU and provides manual driver installation instructions - Creates directory structure and Docker networks - Comprehensive instructions for post-setup deployment - Remove redundant compose files (now in core.yml) - Deleted authelia.yml, duckdns.yml, gluetun.yml, traefik.yml - All services consolidated into unified core.yml stack - Eliminates confusion and duplication - Update disk space requirements across documentation - Changed from "100GB+ system, 1TB+ media" to: - "120GB+ system drive (NVMe or SSD highly recommended)" - "2TB+ for media & additional disks for services like Nextcloud" - Updated in README.md and getting-started.md - Add preference for LinuxServer.io images - Updated copilot-instructions.md - LinuxServer images support PUID/PGID for proper file permissions - Preference noted in consistency guidelines - Update core stack documentation - Emphasize unified core.yml deployment - Add both deployment methods (cd to directory vs full path) - Update getting-started.md with correct deployment steps - Note removal of separate stack files - Add Bitwarden environment variables to .env.example - BITWARDEN_ADMIN_TOKEN, SIGNUPS_ALLOWED, INVITATIONS_ALLOWED - SMTP configuration for email notifications - Generation instructions included - Update services-reference.md - Add Vaultwarden to utilities section (now 7 services) - Update service count and access URLs All documentation now consistent with unified core stack approach and includes all requested features. Co-authored-by: kelinfoxy <67766943+kelinfoxy@users.noreply.github.com>
2026-01-12 03:47:53 +00:00
parent c7ca73fe78
commit 32974a5820
12 changed files with 380 additions and 233 deletions
--- a/scripts/README.md
+++ b/scripts/README.md
@@ -0,0 +1,74 @@
+# AI-Homelab Setup Scripts
+
+## setup-homelab.sh
+
+Automated first-run setup script for preparing a fresh Debian installation for AI-Homelab deployment.
+
+### What It Does
+
+1. **System Update** - Updates all system packages
+2. **Install Dependencies** - Installs required packages (curl, git, etc.)
+3. **Install Docker** - Adds Docker repository and installs Docker Engine with Compose V2
+4. **Configure User Groups** - Adds user to sudo and docker groups
+5. **Configure SSH** - Enables and starts SSH server for remote access
+6. **Detect NVIDIA GPU** - Checks for NVIDIA graphics card and provides manual driver installation instructions
+7. **Create Directories** - Sets up `/opt/stacks`, `/opt/dockge`, `/mnt/media`, `/mnt/downloads`
+8. **Create Docker Networks** - Creates homelab-network, traefik-network, and media-network
+
+### Usage
+
+```bash
+# Download the repository
+git clone https://github.com/kelinfoxy/AI-Homelab.git
+cd AI-Homelab
+
+# Make the script executable (if needed)
+chmod +x scripts/setup-homelab.sh
+
+# Run with sudo
+sudo ./scripts/setup-homelab.sh
+```
+
+### After Running
+
+1. Log out and log back in for group changes to take effect
+2. Edit `.env` file with your configuration
+3. Deploy the core infrastructure stack
+4. Deploy the infrastructure stack (includes Dockge)
+5. Access Dockge to manage remaining stacks
+
+### NVIDIA GPU Support
+
+If an NVIDIA GPU is detected, the script will provide instructions for manual driver installation:
+
+1. Identify your GPU model from the output
+2. Visit https://www.nvidia.com/Download/index.aspx
+3. Download the official driver for your GPU
+4. Run the installer: `sudo bash NVIDIA-Linux-x86_64-XXX.XX.run`
+5. Install container toolkit:
+   ```bash
+   sudo apt-get install -y nvidia-container-toolkit
+   sudo nvidia-ctk runtime configure --runtime=docker
+   sudo systemctl restart docker
+   ```
+
+This manual approach avoids driver conflicts that often occur with automated installation methods.
+
+### Requirements
+
+- Fresh Debian installation (Debian 11 or 12)
+- Root access (via sudo)
+- Internet connection
+
+### Tested On
+
+- Debian 11 (Bullseye)
+- Debian 12 (Bookworm)
+
+### Notes
+
+- The script is idempotent - safe to run multiple times
+- Creates directories with proper ownership
+- Configures Docker networks automatically
+- SSH is enabled for remote management
+- NVIDIA driver installation requires manual intervention for reliability
--- a/scripts/setup-homelab.sh
+++ b/scripts/setup-homelab.sh
@@ -0,0 +1,227 @@
+#!/bin/bash
+# AI-Homelab First-Run Setup Script
+# This script prepares a fresh Debian installation for homelab deployment
+# Run as: sudo ./setup-homelab.sh
+
+set -e  # Exit on error
+
+# Colors for output
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+BLUE='\033[0;34m'
+NC='\033[0m' # No Color
+
+# Log functions
+log_info() {
+    echo -e "${BLUE}[INFO]${NC} $1"
+}
+
+log_success() {
+    echo -e "${GREEN}[SUCCESS]${NC} $1"
+}
+
+log_warning() {
+    echo -e "${YELLOW}[WARNING]${NC} $1"
+}
+
+log_error() {
+    echo -e "${RED}[ERROR]${NC} $1"
+}
+
+# Check if running as root
+if [ "$EUID" -ne 0 ]; then 
+    log_error "Please run as root (use: sudo ./setup-homelab.sh)"
+    exit 1
+fi
+
+# Get the actual user who invoked sudo
+ACTUAL_USER="${SUDO_USER:-$USER}"
+if [ "$ACTUAL_USER" = "root" ]; then
+    log_error "Please run this script with sudo, not as root user"
+    exit 1
+fi
+
+log_info "Setting up AI-Homelab for user: $ACTUAL_USER"
+echo ""
+
+# Step 1: System Update
+log_info "Step 1/8: Updating system packages..."
+apt-get update && apt-get upgrade -y
+log_success "System updated successfully"
+echo ""
+
+# Step 2: Install Required Packages
+log_info "Step 2/8: Installing required packages..."
+apt-get install -y \
+    apt-transport-https \
+    ca-certificates \
+    curl \
+    gnupg \
+    lsb-release \
+    software-properties-common \
+    git \
+    openssh-server \
+    sudo \
+    pciutils \
+    net-tools
+
+log_success "Required packages installed"
+echo ""
+
+# Step 3: Install Docker
+log_info "Step 3/8: Installing Docker..."
+if command -v docker &> /dev/null; then
+    log_warning "Docker is already installed ($(docker --version))"
+else
+    # Add Docker's official GPG key
+    install -m 0755 -d /etc/apt/keyrings
+    curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc
+    chmod a+r /etc/apt/keyrings/docker.asc
+
+    # Add the repository to Apt sources
+    echo \
+      "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \
+      $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
+      tee /etc/apt/sources.list.d/docker.list > /dev/null
+
+    # Update and install Docker
+    apt-get update
+    apt-get install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
+
+    log_success "Docker installed successfully ($(docker --version))"
+fi
+echo ""
+
+# Step 4: Configure User Groups
+log_info "Step 4/8: Configuring user groups..."
+
+# Add user to sudo group if not already
+if groups "$ACTUAL_USER" | grep -q '\bsudo\b'; then
+    log_warning "User $ACTUAL_USER is already in sudo group"
+else
+    usermod -aG sudo "$ACTUAL_USER"
+    log_success "User $ACTUAL_USER added to sudo group"
+fi
+
+# Add user to docker group
+if groups "$ACTUAL_USER" | grep -q '\bdocker\b'; then
+    log_warning "User $ACTUAL_USER is already in docker group"
+else
+    usermod -aG docker "$ACTUAL_USER"
+    log_success "User $ACTUAL_USER added to docker group"
+fi
+echo ""
+
+# Step 5: Configure SSH
+log_info "Step 5/8: Configuring SSH server..."
+systemctl enable ssh
+systemctl start ssh
+
+# Check if SSH is running
+if systemctl is-active --quiet ssh; then
+    SSH_PORT=$(grep "^Port" /etc/ssh/sshd_config | awk '{print $2}')
+    SSH_PORT=${SSH_PORT:-22}
+    log_success "SSH server is running on port $SSH_PORT"
+else
+    log_warning "SSH server failed to start, check configuration"
+fi
+echo ""
+
+# Step 6: Detect and Install NVIDIA Drivers (if applicable)
+log_info "Step 6/8: Checking for NVIDIA GPU..."
+
+# Detect NVIDIA GPU
+if lspci | grep -i nvidia > /dev/null; then
+    log_info "NVIDIA GPU detected:"
+    lspci | grep -i nvidia
+    echo ""
+    
+    log_warning "NVIDIA GPU found, but driver installation requires manual intervention."
+    log_info "For best results, please follow these steps manually:"
+    echo ""
+    echo "  1. Identify your GPU model from the output above"
+    echo "  2. Visit: https://www.nvidia.com/Download/index.aspx"
+    echo "  3. Download the official driver for your GPU"
+    echo "  4. Run the downloaded installer (example): sudo bash NVIDIA-Linux-x86_64-XXX.XX.run"
+    echo ""
+    log_info "After installing NVIDIA drivers, run:"
+    echo "  sudo apt-get install -y nvidia-container-toolkit"
+    echo "  sudo nvidia-ctk runtime configure --runtime=docker"
+    echo "  sudo systemctl restart docker"
+    echo ""
+    log_warning "Skipping automatic NVIDIA driver installation to avoid conflicts"
+    echo ""
+else
+    log_info "No NVIDIA GPU detected, skipping driver installation"
+    echo ""
+fi
+
+# Step 7: Create Directory Structure
+log_info "Step 7/8: Creating directory structure..."
+mkdir -p /opt/stacks
+mkdir -p /opt/dockge/data
+mkdir -p /mnt/media
+mkdir -p /mnt/downloads
+
+# Set ownership
+chown -R "$ACTUAL_USER:$ACTUAL_USER" /opt/stacks
+chown -R "$ACTUAL_USER:$ACTUAL_USER" /opt/dockge
+chown -R "$ACTUAL_USER:$ACTUAL_USER" /mnt/media
+chown -R "$ACTUAL_USER:$ACTUAL_USER" /mnt/downloads
+
+log_success "Directory structure created"
+echo ""
+
+# Step 8: Create Docker Networks
+log_info "Step 8/8: Creating Docker networks..."
+su - "$ACTUAL_USER" -c "docker network create homelab-network 2>/dev/null || true"
+su - "$ACTUAL_USER" -c "docker network create traefik-network 2>/dev/null || true"
+su - "$ACTUAL_USER" -c "docker network create media-network 2>/dev/null || true"
+log_success "Docker networks created"
+echo ""
+
+# Final Summary
+echo ""
+echo "=========================================="
+log_success "AI-Homelab setup completed successfully!"
+echo "=========================================="
+echo ""
+log_info "Next steps:"
+echo ""
+echo "  1. Log out and log back in for group changes to take effect"
+echo "     (or run: newgrp docker)"
+echo ""
+echo "  2. Navigate to your AI-Homelab repository:"
+echo "     cd ~/AI-Homelab"
+echo ""
+echo "  3. Edit the .env file with your configuration:"
+echo "     cp .env.example .env"
+echo "     nano .env"
+echo ""
+echo "  4. Deploy the core infrastructure stack:"
+echo "     mkdir -p /opt/stacks/core"
+echo "     cp docker-compose/core.yml /opt/stacks/core/docker-compose.yml"
+echo "     cp -r config-templates/traefik /opt/stacks/core/"
+echo "     cp -r config-templates/authelia /opt/stacks/core/"
+echo "     cd /opt/stacks/core && docker compose up -d"
+echo ""
+echo "  5. Deploy the infrastructure stack (includes Dockge):"
+echo "     mkdir -p /opt/stacks/infrastructure"
+echo "     cp docker-compose/infrastructure.yml /opt/stacks/infrastructure/docker-compose.yml"
+echo "     cd /opt/stacks/infrastructure && docker compose up -d"
+echo ""
+echo "  6. Access Dockge at: https://dockge.yourdomain.duckdns.org"
+echo "     (Use your configured domain and Authelia credentials)"
+echo ""
+echo "=========================================="
+
+if lspci | grep -i nvidia > /dev/null; then
+    echo ""
+    log_warning "REMINDER: Manual NVIDIA driver installation required"
+    echo "  See instructions above in Step 6"
+    echo "=========================================="
+fi
+
+echo ""
+log_info "Setup complete! Please log out and log back in."