Delete README.md

README.md

@@ -1,305 +0,0 @@
-# Docker Setup for NZ Legislation Loophole Analysis Streamlit App
-
-This guide explains how to run the NZ Legislation Loophole Analysis Streamlit App using Docker.
-
-## 📋 Prerequisites
-
-- Docker installed on your system
-- Docker Compose (recommended for easier management)
-- At least 4GB of available RAM (8GB recommended for optimal performance)
-
-## 🚀 Quick Start
-
-### Method 1: Using Docker Compose (Recommended)
-
-```bash
-# Clone or navigate to the project directory
-cd /path/to/nz-legislation-analyzer
-
-# Build and run the application
-docker-compose up --build
-
-# Or run in detached mode
-docker-compose up -d --build
-```
-
-The application will be available at: **http://localhost:8501**
-
-### Method 2: Using Docker Directly
-
-```bash
-# Build the Docker image
-docker build -t nz-legislation-analyzer .
-
-# Run the container
-docker run -p 8501:8501 \
-  -v $(pwd)/streamlit_app/cache:/app/streamlit_app/cache \
-  -v $(pwd)/streamlit_app/config:/app/streamlit_app/config \
-  -v $(pwd)/streamlit_app/datasets:/app/streamlit_app/datasets \
-  -v $(pwd)/nz-legislation.txt:/app/nz-legislation.txt:ro \
-  nz-legislation-analyzer
-```
-
-## 📁 Directory Structure
-
-When using Docker, the following directories are created and can be persisted:
-
-```
-📁 streamlit_app/
-├── 🧠 cache/          # Persistent cache for processed chunks
-├── ⚙️ config/         # Application configuration files
-├── 📊 datasets/       # Generated datasets and results
-├── 📝 logs/           # Application logs
-└── 📤 uploads/        # Uploaded files (if any)
-```
-
-## 🛠️ Configuration
-
-### Environment Variables
-
-| Variable | Default | Description |
-|----------|---------|-------------|
-| `STREAMLIT_SERVER_HEADLESS` | `true` | Run in headless mode |
-| `STREAMLIT_SERVER_PORT` | `8501` | Streamlit server port |
-| `STREAMLIT_SERVER_ADDRESS` | `0.0.0.0` | Server bind address |
-
-### Volume Mounts
-
-The Docker setup includes the following volume mounts for data persistence:
-
-- `./streamlit_app/cache:/app/streamlit_app/cache` - Cache persistence
-- `./streamlit_app/config:/app/streamlit_app/config` - Configuration files
-- `./streamlit_app/datasets:/app/streamlit_app/datasets` - Generated datasets
-- `./streamlit_app/logs:/app/streamlit_app/logs` - Application logs
-- `./nz-legislation.txt:/app/nz-legislation.txt:ro` - Input data (read-only)
-
-## 🔧 Docker Commands
-
-### Building the Image
-
-```bash
-# Build with no cache
-docker build --no-cache -t nz-legislation-analyzer .
-
-# Build with specific Dockerfile
-docker build -f Dockerfile -t nz-legislation-analyzer .
-```
-
-### Running the Container
-
-```bash
-# Interactive mode
-docker run -it --rm -p 8501:8501 nz-legislation-analyzer
-
-# Background mode
-docker run -d -p 8501:8501 nz-legislation-analyzer
-
-# With custom environment variables
-docker run -p 8501:8501 \
-  -e STREAMLIT_SERVER_PORT=8502 \
-  nz-legislation-analyzer
-```
-
-### Docker Compose Commands
-
-```bash
-# Start services
-docker-compose up
-
-# Start in background
-docker-compose up -d
-
-# Stop services
-docker-compose down
-
-# Rebuild and start
-docker-compose up --build
-
-# View logs
-docker-compose logs -f
-
-# Scale services (if needed)
-docker-compose up -d --scale nz-legislation-analyzer=2
-```
-
-## 📊 Monitoring and Logs
-
-### Viewing Logs
-
-```bash
-# Docker Compose logs
-docker-compose logs -f nz-legislation-analyzer
-
-# Docker logs
-docker logs -f <container_id>
-
-# Follow logs in real-time
-docker-compose logs -f --tail=100
-```
-
-### Health Checks
-
-The Docker Compose setup includes health checks that monitor the Streamlit application:
-
-```yaml
-healthcheck:
-  test: ["CMD", "curl", "-f", "http://localhost:8501/healthz"]
-  interval: 30s
-  timeout: 10s
-  retries: 3
-  start_period: 40s
-```
-
-## 🔍 Troubleshooting
-
-### Common Issues
-
-1. **Port Already in Use**
-   ```bash
-   # Change the port mapping
-   docker run -p 8502:8501 nz-legislation-analyzer
-   # Or with docker-compose, modify the ports section
-   ```
-
-2. **Memory Issues**
-   ```bash
-   # Increase Docker memory allocation
-   # Docker Desktop: Settings > Resources > Memory
-   # Or add memory limits to docker-compose.yml
-   ```
-
-3. **Model Loading Errors**
-   - Ensure sufficient RAM (8GB+ recommended)
-   - Check that model files are accessible
-   - Verify model path in configuration
-
-4. **Permission Issues**
-   ```bash
-   # Fix directory permissions
-   sudo chown -R $USER:$USER streamlit_app/
-   ```
-
-5. **Cache Issues**
-   ```bash
-   # Clear persistent cache
-   sudo rm -rf streamlit_app/cache/*
-   docker-compose restart
-   ```
-
-### Debug Mode
-
-Enable debug logging by modifying the environment:
-
-```bash
-# Add to docker-compose.yml environment section
-- PYTHONPATH=/app
-- LOG_LEVEL=DEBUG
-```
-
-## 🔄 Updates and Maintenance
-
-### Updating the Application
-
-```bash
-# Pull latest changes
-git pull
-
-# Rebuild the image
-docker-compose build --no-cache
-
-# Restart services
-docker-compose up -d
-```
-
-### Backup Important Data
-
-```bash
-# Backup cache and configuration
-tar -czf backup.tar.gz streamlit_app/cache/ streamlit_app/config/
-
-# Backup datasets
-tar -czf datasets_backup.tar.gz streamlit_app/datasets/
-```
-
-### Cleaning Up
-
-```bash
-# Remove containers and volumes
-docker-compose down -v
-
-# Remove images
-docker rmi nz-legislation-analyzer
-
-# Clean up unused Docker resources
-docker system prune -a
-```
-
-## 🏗️ Advanced Configuration
-
-### Custom Model Files
-
-To use custom model files:
-
-1. **Mount model directory:**
-   ```yaml
-   volumes:
-     - ./models:/app/models:ro
-   ```
-
-2. **Update configuration** in the Streamlit app to point to `/app/models/your-model.gguf`
-
-### GPU Support (Optional)
-
-For GPU acceleration with CUDA:
-
-```dockerfile
-# Use CUDA-enabled base image
-FROM nvidia/cuda:11.8-devel-ubuntu22.04
-
-# Install Python and dependencies
-# ... (additional setup for CUDA)
-```
-
-Note: GPU support requires additional configuration and CUDA-compatible hardware.
-
-## 🔐 Security Considerations
-
-- The application runs in headless mode by default
-- All data is stored locally in mounted volumes
-- No external network access is required for basic functionality
-- Consider implementing authentication for production deployments
-
-## 📈 Performance Optimization
-
-### Memory Management
-
-- Default cache size: 1024MB (configurable in app settings)
-- Adjust based on available system memory
-- Monitor memory usage through the app's Performance dashboard
-
-### Disk I/O
-
-- Use SSD storage for better performance
-- Ensure adequate disk space for cache and datasets
-- Consider using tmpfs for temporary processing
-
-### Network
-
-- The application binds to all interfaces (`0.0.0.0`)
-- Access via `localhost` or container IP
-- No external dependencies required
-
-## 🆘 Support
-
-For Docker-specific issues:
-
-1. Check Docker logs: `docker-compose logs`
-2. Verify Docker installation and version
-3. Ensure adequate system resources
-4. Review the main application logs in `streamlit_app/logs/`
-
-For application-specific issues, refer to the main documentation in `README_Streamlit_App.md`.
-
----
-
-**🎉 Happy analyzing with your containerized NZ Legislation Loophole Analysis Streamlit App!**