l1apps/docker-compose-assistant repository overview

⁠Docker Compose Assistant (DCA)

Welcome to the Docker Compose Assistant! DCA is a smart, web-based editor designed to help you write, validate, and improve your docker-compose.yml files. Powered by pluggable AI providers like Google Gemini or your own local models, it provides intelligent suggestions, auto-corrections, and formatting.

⁠Features

• Pluggable AI Providers: Configure the editor to use your preferred AI service, with support for Google Gemini and any OpenAI-compatible API (e.g., Ollama for local models).
• Privacy-First Local AI: Run analysis using your own local models, ensuring your code never leaves your machine.
• AI-Powered Analysis: Get instant feedback on your Docker Compose files, including corrections for syntax, indentation, and deprecated keys.
• Smart Formatting: Auto-format your code with proper YAML spacing and structure, viewing a precise diff before applying changes.
• Syntax Snippets: Quickly insert common Docker Compose blocks (Services, Networks, Volumes, etc.) directly from a dropdown menu.
• Structure Navigation: Automatically detects your services, volumes, and networks for quick navigation within large files.
• Contextual Help: Select any keyword in your file to get a clear explanation and code example directly in the side panel.
• Version Aware: Detects or allows manual selection of Docker Compose versions (e.g., 3.8, 2.4) to ensure compliant syntax.
• File Management: Easily load your existing docker-compose.yml files and save your corrected code.
• Multiple Themes: Choose from light, dark, and dracula themes to suit your preference.

⁠Deployment

You can pull the pre-built image from Docker Hub or GitHub Container Registry (GHCR).

⁠Prerequisites

• Docker and Docker Compose installed on your machine.
• An API Key for a cloud AI provider (like Google Gemini) OR a running local AI server (like Ollama⁠).

⁠Option 1: Using Docker Compose

1. Create docker-compose.yml:

services:
  dca-app:
    # Pull from Docker Hub
    image: l1apps/docker-compose-assistant:latest

    # OR Pull from GitHub Container Registry
    # image: ghcr.io/l1apps/docker-compose-assistant:latest

    container_name: docker-compose-assistant
    ports:
      - "8500:80" # Change the host port if needed
    restart: unless-stopped

1. Run the Container:

docker-compose up -d

⁠Option 2: Using Docker CLI

Using Docker Hub:

docker run -d -p 8500:80 --name docker-compose-assistant l1apps/docker-compose-assistant:latest

Using GitHub Container Registry:

docker run -d -p 8500:80 --name docker-compose-assistant ghcr.io/l1apps/docker-compose-assistant:latest

⁠Option 3: Deploying with Portainer

1. Navigate to Stacks: In the Portainer sidebar, click "Stacks".
2. Add a New Stack: Click the "Add stack" button.
3. Configure the Stack:
   • Name: docker-compose-assistant
   • Build method: Web editor
4. Paste the Configuration:

services:
  dca-app:
    image: l1apps/docker-compose-assistant:latest
    container_name: docker-compose-assistant
    ports:
      - "8500:80"
    restart: unless-stopped

1. Deploy: Click "Deploy the stack".
2. Access: Navigate to http://<your-server-ip>:8500.

⁠Configuring the AI Provider

⁠1. First-Time Setup Wizard (Recommended)

• Follow the on-screen instructions to select your AI provider.
• You can skip and configure later from Settings.

⁠2. Manual Configuration

• Click the Settings icon (⚙️) to select provider, enter API keys, and set model details.
• Settings are saved securely in your browser.

⁠Recommended AI Models

• Google Gemini (Cloud):
  • gemini-2.5-pro (Default)
  • gemini-2.5-flash
• Local Models (OpenAI-Compatible API):
  • llama3, codellama, mistral, phi3

⁠Keywords / Tags

self-hosted, docker, docker-compose, AI, assistant, yaml, devops, local AI, smart editor, compose files

⁠Support & Credits

Developed by Level 1 Apps⁠.
For support or inquiries, visit our website.
For more details, see about.md⁠.