docker-web-template

This repo contains template files for configuration of new web servers exposing services with Docker Compose and Traefik reverse proxy.

🚀 Quick Start (Automated Setup)

The easiest way to get started is using the automated initialization script:

# Clone this repository
git clone <repository-url>
cd docker-web-template

# Run the initialization script
chmod +x init-docker.sh
./init-docker.sh

The script will:

• ✅ Detect your OS (Ubuntu/Debian)
• ✅ Install Docker if needed
• ✅ Configure the Docker environment
• ✅ Create the t2_proxy network
• ✅ Set up Traefik with proper permissions
• ✅ Let you select from optional Traefik plugins
• ✅ Let you select from 11+ pre-configured services
• ✅ Generate your docker-compose.yml

📦 Available Service Templates

Choose from these pre-configured services during setup:

• Portainer - Docker management UI
• Grafana - Monitoring & visualization
• Nextcloud - Personal cloud storage
• WikiJS - Modern wiki platform
• Heimdall - Application dashboard
• Uptime Kuma - Uptime monitoring
• Vaultwarden - Password manager
• Jellyfin - Media server
• PhotoPrism - AI-powered photo management
• Prometheus - Monitoring system
• Code Server - VS Code in browser

See templates/README.md for detailed information about each service.

🔌 Traefik Plugin Support

The installation script supports optional Traefik plugins for enhanced security and functionality:

• geoblock - Geographic blocking based on IP location
• totp - Two-factor authentication using TOTP
• apikey - API key authentication middleware
• passkey - WebAuthn/Passkey authentication
• threat - Threat detection and IP blocking

Adding New Plugins

To add a new plugin to the available list, edit plugins.conf:

# Format: PLUGIN_NAME|GITHUB_REPO|MODULE_NAME|DESCRIPTION
myPlugin|https://github.com/owner/repo|github.com/owner/repo|Plugin description

The script will automatically:

• Clone the plugin repository to ~/dockers/traefik/plugins/
• Add the volume mount to docker-compose.yml
• Configure traefik.yml with the plugin settings

Managing Existing Configuration

If you run the script when a configuration already exists, you'll be prompted to:

1. Add new plugins
2. Add new services
3. Add both plugins and services
4. Exit without changes

Prerequisites

• A Linux-based server (Ubuntu/Debian)
• Root or sudo access (sudo will be auto-detected)
• Domain name pointed to your server's IP address

Table of Contents

1. Quick Start (Automated)
2. Available Service Templates
3. Traefik Plugin Support
4. Manual Installation
   • Install Docker
   • Configure Docker Compose
   • Configure Services
   • Enable Services
5. Managing Services

Manual Installation

1. Install Docker

Ubuntu/Debian

# Update package index
sudo apt-get update

# Install required packages
sudo apt-get install -y \
    apt-transport-https \
    ca-certificates \
    curl \
    gnupg \
    lsb-release

# Add Docker's official GPG key
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg

# Set up the stable repository
echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \
  $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

# Install Docker Engine
sudo apt-get update
sudo apt-get install -y docker-ce docker-ce-cli containerd.io

# Verify installation
sudo docker --version

Post-installation steps

# Add your user to the docker group (optional, to run docker without sudo)
sudo usermod -aG docker $USER

# Enable Docker to start on boot
sudo systemctl enable docker
sudo systemctl start docker

# Verify Docker is running
sudo systemctl status docker

2. Configure Docker Compose

Docker Compose is included with Docker Desktop for Windows and Mac. For Linux, install it separately:

# Download Docker Compose
sudo curl -L "https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

# Apply executable permissions
sudo chmod +x /usr/local/bin/docker-compose

# Verify installation
docker-compose --version

3. Configure Services

Clone this repository

git clone <repository-url>
cd docker-web-template

Configure Traefik

1. Create an acme.json file for Let's Encrypt certificates:

touch traefik/acme.json
chmod 600 traefik/acme.json

2. Edit traefik/traefik.yml to configure your domain and email:

   • Update the email address for Let's Encrypt notifications
   • Configure your certificate resolver settings

3. Edit traefik/dynamic.yml if you need custom routing rules or middlewares

Configure Environment Variables

Create a .env file in the root directory with your specific configuration:

# Domain configuration
DOMAIN=example.com

# Email for Let's Encrypt
ACME_EMAIL=admin@example.com

# Traefik Dashboard
TRAEFIK_DASHBOARD_AUTH=admin:$$apr1$$... # Use htpasswd to generate

Generate password hash for Traefik dashboard:

# Install apache2-utils if not already installed
sudo apt-get install apache2-utils

# Generate password (replace 'secure_password' with your password)
htpasswd -nb admin secure_password

Add Additional Services

To add new services:

1. Create a new directory under services/ (e.g., services/myapp/)
2. Add your service configuration to docker-compose.yml
3. Configure Traefik labels for routing and SSL

4. Enable Services

Start all services

# Start services in detached mode
docker-compose up -d

# View logs
docker-compose logs -f

# Check running containers
docker-compose ps

Verify Traefik is running

Access the Traefik dashboard at: https://traefik.yourdomain.com

5. Managing Services

Common commands

# Stop all services
docker-compose down

# Restart a specific service
docker-compose restart <service-name>

# View logs for a specific service
docker-compose logs -f <service-name>

# Pull latest images
docker-compose pull

# Rebuild and restart services
docker-compose up -d --build

# Remove all containers and volumes
docker-compose down -v

Update services

# Pull the latest changes
git pull

# Pull new images
docker-compose pull

# Restart services with new configuration
docker-compose up -d

Troubleshooting

Check container logs

docker-compose logs <service-name>

Inspect container

docker inspect <container-name>

Network issues

# List networks
docker network ls

# Inspect network
docker network inspect docker-web-template_default

Certificate issues

If Let's Encrypt certificates are not being issued:

1. Verify your domain DNS is correctly configured
2. Check Traefik logs: docker-compose logs traefik
3. Ensure port 80 and 443 are open and accessible
4. Delete traefik/acme.json and restart Traefik to retry

Security Considerations

• Keep Docker and Docker Compose updated
• Use strong passwords for all services
• Regularly update container images
• Use secrets management for sensitive data
• Configure firewall rules appropriately
• Monitor logs for suspicious activity
• Keep acme.json permissions at 600

Directory Structure

.
├── README.md
├── init-docker.sh           # Automated setup script
├── plugins.conf            # Plugin configuration (easily editable)
├── docker-compose.yml       # Base compose file
├── .env.example            # Environment variables template
├── .gitignore
├── traefik/                # Traefik reverse proxy config
│   ├── traefik.yml
│   ├── dynamic.yml
│   └── acme.json
├── templates/              # Service templates (11+ services)
│   ├── README.md
│   ├── portainer.yml
│   ├── grafana.yml
│   ├── nextcloud.yml
│   ├── wikijs.yml
│   └── ... (and more)
└── services/
    └── whoami/            # Example service

Features

🎨 Beautiful CLI Interface

• Color-coded output for easy reading
• Step-by-step progress indicators
• Clear success/warning/error messages

🔒 Security First

• Automatic HTTPS with Let's Encrypt
• Traefik reverse proxy for all services
• Proper file permissions (acme.json)
• No-new-privileges security option

🔧 Smart Detection

• Auto-detects OS (Ubuntu/Debian)
• Checks for sudo requirements
• Validates Docker installation
• Network configuration assistance

📦 Service Templates

• 11+ pre-configured services
• Easy to add custom templates
• Traefik labels included
• Environment variable management

🔌 Plugin Management

• Optional Traefik plugin installation
• Easy plugin configuration via plugins.conf
• Automatic plugin cloning and setup
• Add plugins to existing installations

License

This template is provided as-is for use in setting up Docker-based web servers.