feat: Add Docker deployment manager and stack assignment helper scripts

- Introduced `docker-deployment-manager.sh` for managing Docker stack deployments across multiple servers, including initialization, deployment, and status checks.
- Added `stack-assignment-helper.sh` to analyze Docker stacks and suggest server assignments based on predefined patterns.
- Removed outdated `SETUP_COMPLETE.md` file as it is no longer relevant to the current setup process.
- Ref - Documentation review #11
This commit is contained in:
Peter Wood
2025-05-29 18:19:37 -04:00
parent a05f5c6d9d
commit 3ce2b687ac
7 changed files with 469 additions and 116 deletions

172
README.md
View File

@@ -6,8 +6,9 @@ This repository contains various shell scripts for managing media-related tasks
- **[Backup Scripts](#backup-scripts)** - Enterprise-grade backup solutions
- **[Management Scripts](#management-scripts)** - System and service management
- **[AI Integration](#ai-integration)** - Ollama and Fabric setup for AI-assisted development
- **[Tab Completion](#tab-completion)** - Intelligent command-line completion
- **[Documentation](#documentation)** - Complete guides and references
- **[Documentation](#comprehensive-documentation)** - Complete guides and references
- **[Testing](#testing)** - Docker-based validation framework
- **[Dotfiles](#dotfiles)** - System configuration files
@@ -25,9 +26,70 @@ This repository contains various shell scripts for managing media-related tasks
- **`plex.sh`**: Script to manage the Plex Media Server (start, stop, restart, status).
- **`folder-metrics.sh`**: Script to calculate disk usage and file count for a directory and its subdirectories.
## AI Integration
This repository includes a complete AI development environment with Ollama and Fabric integration for AI-assisted development tasks.
### Ollama + Fabric Setup
The system includes:
- **Ollama Docker container** running on port 11434 with phi3:mini model (3.8B parameters)
- **Fabric v1.4.195** with 216+ AI patterns for text processing
- **Google Gemini 2.5 Pro** as primary AI provider
- **Local Ollama models** as secondary AI provider
- **Custom shell aliases** for easy container management
### Basic Fabric Usage
```bash
# List all available patterns
fabric -l
# Use a pattern (uses Gemini 2.5 Pro by default)
echo "Your text here" | fabric -p summarize
# Use with specific model
echo "Your text here" | fabric -p summarize -m gemini-2.0-flash-exp
# Use local Ollama models
echo "Your text here" | fabric -p summarize -m ollama:phi3:mini
# Update patterns
fabric -U
```
### Ollama Management Aliases
```bash
ollama-start # Start Ollama container
ollama-stop # Stop Ollama container
ollama-restart # Restart Ollama container
ollama-logs # View container logs
ollama-status # Check container status
```
### Popular AI Patterns
- `summarize` - Summarize text content
- `explain_code` - Explain code snippets and logic
- `improve_writing` - Enhance writing quality and clarity
- `extract_wisdom` - Extract key insights from content
- `create_quiz` - Generate quiz questions from text
- `analyze_claims` - Analyze and fact-check claims
### Configuration Files
- **Fabric config**: `~/.config/fabric/.env` - AI provider settings and API keys
- **Ollama aliases**: `~/.oh-my-zsh/custom/ollama-aliases.zsh` - Container management commands
- **Shell config**: `~/.zshrc` - Main shell configuration
For complete setup instructions, see the setup documentation.
### Development Projects
- **[Telegram Backup Monitoring Bot](./telegram/github-issues/README.md)**: Comprehensive Telegram bot project for monitoring and managing all backup systems with real-time notifications and control capabilities.
- **[Docker Deployment Management](./docker-deployment/README.md)**: Centralized Docker stack deployment system for managing containers across multiple servers with intelligent assignment and environment integration.
### Testing Scripts
@@ -172,6 +234,64 @@ For detailed configuration information and backup strategies, see:
- **[Enhanced Media Backup](./docs/enhanced-media-backup.md)**: Media backup script configuration
- **[Crontab Management](./crontab/README.md)**: Automated scheduling and system-specific configurations
## Comprehensive Documentation
This repository includes extensive documentation organized by component and functionality:
### 📁 Documentation Structure
```
📁 docs/ - Technical documentation and guides
📁 setup/ - Setup and configuration files
📁 plex/ - Plex Media Server scripts and docs
📁 immich/ - Immich photo management scripts
📁 crontab/ - Crontab management system
📁 dotfiles/ - System configuration files
📁 completions/ - Tab completion scripts
📁 telegram/ - Telegram bot integration
```
### 🛠️ Component Documentation
#### Backup Systems
- **[Enhanced Media Backup](./docs/enhanced-media-backup.md)**: Advanced media backup features and configuration
- **[Basic Media Backup](./docs/backup-media.md)**: Original backup system documentation
- **[Environment Backup System](./docs/env-backup-system.md)**: Environment and configuration backup
- **[Backup Environment Safety Guide](./docs/backup-env-safety-guide.md)**: Safety guidelines for environment backups
#### Media Server Management
- **[Plex Scripts Documentation](./plex/README.md)**: Comprehensive Plex backup, restoration, and management
- **[Plex Backup Guide](./plex/plex-backup.md)**: Detailed Plex backup system documentation
- **[Plex Management Guide](./plex/plex-management.md)**: Server management and operations
#### Photo Management
- **[Immich Scripts Documentation](./immich/README.md)**: Complete Immich backup and management system
- **[Immich Enhancement Summary](./docs/immich-backup-enhancement-summary.md)**: Recent improvements and features
- **[Immich Migration Guide](./docs/immich-backup-migration-summary.md)**: Migration procedures and best practices
#### System Administration
- **[Crontab Management](./crontab/README.md)**: Multi-system crontab coordination and backup
- **[Enhanced Crontab System](./crontab/enhanced-crontab-system.md)**: Advanced scheduling features
- **[Dotfiles Documentation](./dotfiles/README.md)**: System configuration and setup
- **[Tab Completion Guide](./completions/README.md)**: Intelligent command completion system
#### Development & Deployment
- **[Docker Deployment Management](./docker-deployment/README.md)**: Centralized multi-server Docker stack deployment system
- **[Docker Bootstrap Testing](./docs/docker-bootstrap-testing-framework.md)**: Comprehensive testing framework
- **[Production Deployment Guide](./docs/production-deployment-guide.md)**: Complete deployment procedures
- **[Docker Stack Strategy](./docs/docker-stack-deployment-strategy.md)**: Container deployment strategy
### 📊 Project Documentation
- **[Project Completion Summary](./docs/project-completion-summary.md)**: Overall project status and milestones
- **[Documentation Review](./docs/documentation-review-summary.md)**: Comprehensive documentation overview
- **[Technical Implementation Summaries](./docs/)**: Various technical guides and implementation details
## Documentation
### Component-Specific Documentation
@@ -192,6 +312,56 @@ For detailed configuration information and backup strategies, see:
- **[Production Deployment Guide](./docs/production-deployment-guide.md)**: Complete deployment and operations guide
- **[Project Completion Summary](./docs/project-completion-summary.md)**: Overview of completed features and project milestones
### Environment & System Documentation
- **[Environment Backup System](./docs/env-backup-system.md)**: Complete environment backup documentation
- **[Environment Backup Integration Guide](./docs/env-backup-integration-guide.md)**: Integration procedures and best practices
- **[Backup Environment Safety Guide](./docs/backup-env-safety-guide.md)**: Safety guidelines and procedures
- **[Tab Completion Implementation](./docs/tab-completion-implementation-summary.md)**: Command completion system details
- **[Docker Stack Deployment Strategy](./docs/docker-stack-deployment-strategy.md)**: Container deployment and management
### Project Reviews & Summaries
- **[Documentation Review Summary](./docs/documentation-review-summary.md)**: Comprehensive documentation audit and review
- **[Issue Resolution Summaries](./docs/)**: Technical implementation details and problem resolution guides
## Setup and Getting Started
### Quick Setup
The repository includes automated setup via bootstrap script:
```bash
curl -fsSL https://raw.githubusercontent.com/acedanger/shell/main/bootstrap.sh | bash
```
This installs:
- Zsh with Oh My Zsh and custom plugins
- All packages from `setup/packages.list`
- Dotfiles and system configuration
- Tab completion for all scripts
- Development tools (Node.js via nvm, VS Code, etc.)
### AI Development Environment
For AI-assisted development, the system includes:
- **Ollama** running in Docker with local models
- **Fabric** with 216+ AI patterns for text processing
- **Google Gemini integration** as primary AI provider
- **Custom aliases** for easy management
Test the AI setup:
```bash
# Test Gemini integration
echo "Test text" | fabric -p summarize
# Test local Ollama integration
echo "Test text" | fabric -p summarize -m ollama:phi3:mini
```
## Dotfiles
The repository includes dotfiles for system configuration in the `dotfiles` directory. These can be automatically set up using the bootstrap script: