Skip to content
This repository was archived by the owner on Dec 30, 2025. It is now read-only.

Latest commit

 

History

History
240 lines (195 loc) · 4.57 KB

DOCKER.md

File metadata and controls

240 lines (195 loc) · 4.57 KB

Docker Setup

This guide covers the Docker containerization setup for IRC.atl.chat.

Overview

IRC.atl.chat uses Docker Compose for orchestration with the following services:

Services:
├── unrealircd        - Main IRC server
├── atheme           - IRC services (NickServ, etc.)
├── unrealircd-webpanel - Web administration interface
└── ssl-monitor      - SSL certificate automation

Container Configuration

UnrealIRCd Container

unrealircd:
  build:
    context: ./src/backend/unrealircd
    dockerfile: Containerfile
  container_name: unrealircd
  volumes:
    - ./src/backend/unrealircd/conf:/home/unrealircd/unrealircd/conf
    - ./logs/unrealircd:/home/unrealircd/unrealircd/logs
    - ./data/unrealircd:/home/unrealircd/unrealircd/data
  ports:
    - '6697:6697'    # IRC over TLS
    - '6900:6900'    # Server links
    - '6901:6901'    # Atheme services
    - '8600:8600'    # JSON-RPC API
    - '8000:8000'    # WebSocket IRC
  networks:
    - irc-network
  restart: unless-stopped

Atheme Container

atheme:
  build:
    context: ./src/backend/atheme
    dockerfile: Containerfile
  container_name: atheme
  depends_on:
    unrealircd:
      condition: service_healthy
  volumes:
    - ./src/backend/atheme/conf:/usr/local/atheme/etc:ro
    - ./data/atheme:/usr/local/atheme/data
    - ./logs/atheme:/usr/local/atheme/logs
  network_mode: service:unrealircd  # Shares network with IRCd
  restart: unless-stopped

WebPanel Container

unrealircd-webpanel:
  build:
    context: .
    dockerfile: src/frontend/webpanel/Containerfile
  container_name: unrealircd-webpanel
  depends_on:
    unrealircd:
      condition: service_healthy
  volumes:
    - unrealircd-webpanel-data:/var/www/html/unrealircd-webpanel/data
  ports:
    - '8080:8080'
  networks:
    - irc-network
  restart: unless-stopped

Volume Management

Persistent Volumes

volumes:
  unrealircd-webpanel-data:
    name: unrealircd-webpanel-data
    driver: local

Bind Mounts

volumes:
  - ./src/backend/unrealircd/conf:/home/unrealircd/unrealircd/conf
  - ./logs/unrealircd:/home/unrealircd/unrealircd/logs
  - ./data/unrealircd:/home/unrealircd/unrealircd/data

Networking

Network Architecture

networks:
  irc-network:
    name: irc-network
    driver: bridge

Port Mapping

  • 6697: IRC over TLS (external)
  • 6900: Server-to-server TLS (external)
  • 6901: Atheme services connection (localhost)
  • 8600: JSON-RPC API (internal)
  • 8000: WebSocket IRC (external)
  • 8080: WebPanel (external)

Security

Non-Root Containers

All containers run as non-root users with proper UID/GID mapping:

environment:
  - PUID=${PUID:-1000}
  - PGID=${PGID:-1000}

File Permissions

# Set proper permissions
chmod 600 .env cloudflare-credentials.ini
chmod 755 data/ logs/

Health Checks

Container Health Monitoring

healthcheck:
  test: ['CMD', 'nc', '-z', 'localhost', '6697']
  interval: 30s
  timeout: 10s
  retries: 3
  start_period: 30s

Health Check Commands

# Check container health
docker ps --filter "health=healthy"

# Check service status
make status

# View container logs
docker compose logs unrealircd

Management Commands

Service Management

# Start all services
make up

# Stop all services
make down

# Restart services
make restart

# Check service status
make status

Container Management

# Build containers
make build

# Rebuild from scratch
make rebuild

# View logs
make logs
make logs-ircd
make logs-atheme
make logs-webpanel

Debugging

# Access container shell
docker compose exec unrealircd sh
docker compose exec atheme sh

# Check container health
docker inspect unrealircd | grep -A 10 "Health"

# Monitor resource usage
docker stats

Troubleshooting

Common Issues

Permission Errors

# Fix file ownership
sudo chown -R $(id -u):$(id -g) data/ logs/

# Check PUID/PGID
echo "PUID: $(id -u), PGID: $(id -g)"

Container Won't Start

# Check logs
docker compose logs unrealircd

# Validate configuration
docker compose config

# Check dependencies
docker compose ps

Network Issues

# Check network connectivity
docker network ls
docker network inspect irc-network

# Test service communication
docker compose exec unrealircd nc -z localhost 6901

Related Documentation